Command & Settings Reference
A lookup page for the VS Code commands, settings, guided prompts, and environment variables Forge provides.
VS Code commands
All commands are available from the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) under the Protrak Forge category. The import/export commands are also available from the Explorer right-click Protrak Forge submenu, which appears only inside a recognized Protrak project.
| Command | What it does |
|---|---|
| Create New Protrak Project | Scaffold a fresh customization project (.csproj + Program.cs + schema folders) anywhere on disk |
| Add Unit Test Project | Add an xUnit + Moq test project beside an existing customization project (sibling folder, ProjectReference to the project under test, registered in your .sln) |
| Generate Type | Create a new Types/ entry interactively (lifecycle picker + multi-select attribute picker) |
| Import Schema from Server | Download and apply schema from a Protrak server |
| Import Schema File into Project | Apply a local .json schema file to the project |
| Export Local Schema to Server | Push local schema files to a Protrak server |
| Export Local Schema to File | Save local schema as a .json file |
| Manage Server Connections | Add, edit, or remove saved server connections (tokens stored in SecretStorage) |
| Set Protrak Project Root… | Pick or browse to any folder and use it as the Protrak project root; bypasses auto-detection |
| Configure Agent Instructions | Write agent-instruction files and MCP wiring for the AI tools you pick (Claude Code / GitHub Copilot / Codex), skipping anything that already exists. Also writes one Skill per customization area (programs, rules, widgets, notification templates, schema) as .claude/skills/forge-* (Claude Code/Codex) and .github/instructions/forge-*.instructions.md (Copilot) — see Skills |
| Create Project Skill… | Scaffold a blank .claude/skills/<name>/SKILL.md for your own team's conventions, alongside the platform's forge-* skills — optionally give it a Copilot applyTo scope too — see Skills |
Settings
| Setting | Default | Description |
|---|---|---|
protrakForge.connections | [] | Saved server connections. Each entry has a name and url. Tokens are stored separately in SecretStorage. |
protrakForge.import.deleteMissingFiles | false | On All or Collection import, also delete local files not present in the incoming schema. Off by default (imports only write/overwrite). No effect on Element-scope imports. |
protrakForge.projectRoot | "" | Absolute path to the customization project. Overrides auto-detection; used by Forge commands and as PROTRAK_PROJECT_ROOT for the MCP server. Leave blank to auto-detect. |
protrakForge.operationTimeoutMinutes | 10 | Maximum time server-bound operations (Import/Export from/to Server) may run before auto-canceling. Increase for very large schemas. |
Guided prompts
Named prompts you can invoke explicitly when you want a step-by-step flow (see Authoring with AI):
| Prompt | Purpose |
|---|---|
write-protrak-program | Generate a Protrak C# program — provide type, program type, and description |
design-protrak-layout | Design a Design Studio layout — provide type and mode (Create / Edit / View / Dashboard / Report / Relation) |
scaffold-protrak-entity | Scaffold a new entity (Type + Lifecycle + Attributes + Relations) |
design-protrak-rule | Author a business Rule from a natural-language description |
write-protrak-widget | Generate a custom-code (React) Widget |
Environment variables
For non-VS-Code agents (Claude Code, Codex), set these in your MCP server config:
| Variable | Purpose | Default |
|---|---|---|
PROTRAK_PROJECT_ROOT | Path to your customization project (overrides workspace auto-detection) | Auto-detect |
PROTRAKFORGE_LOG_LEVEL | Log verbosity: DEBUG, INFO, or WARNING | INFO |
Versions
The VS Code extension (prorigo.protrak-forge) and the npm MCP package (@prorigo/protrak-forge) are versioned together. The extension pins the MCP server to the matching major version, so patch and minor updates are picked up automatically without reinstalling the extension.