Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between the code and documentation.
Findings
| Area |
Issue |
File(s) |
| Architecture tree |
src/data/ directory listed twice β first with only ecosystem_domains.json, then correctly with all files |
AGENTS.md |
| Architecture tree |
src/run.rs (debug-only local dev command) is absent from the architecture tree |
AGENTS.md |
| Template markers |
\{\{ mcpg_step_env }} is used in both base.yml and 1es-base.yml but has no documentation entry |
AGENTS.md |
| Front Matter Fields table |
engine row shows default claude-opus-4.5 and description "AI model to use" β both wrong; engine is the engine identifier (defaults to copilot); the model is a sub-field |
README.md |
Details
1. Duplicate src/data/ in architecture tree (AGENTS.md lines 25 and 76)
The architecture tree contains two separate data/ entries nested under src/:
β βββ data/
β β βββ ecosystem_domains.json β line 25 (incomplete, only one file listed)
...
β βββ data/
β β βββ base.yml β line 76 (correct, lists all files)
β β βββ 1es-base.yml
β β βββ ecosystem_domains.json
β β βββ init-agent.md
β β βββ threat-analysis.md
Only one src/data/ directory exists on disk. The first entry (line 25) is a stale remnant and should be removed.
2. Missing src/run.rs (AGENTS.md)
src/run.rs exists in the codebase (debug-only, gated with #[cfg(debug_assertions)]). It implements the run subcommand for local development. The architecture tree doesn't list it. Since it was already referenced in the CLI commands section of AGENTS.md as a debug-only run command, it should also appear in the architecture tree.
3. Undocumented \{\{ mcpg_step_env }} template marker (AGENTS.md)
Both src/data/base.yml and src/data/1es-base.yml include the \{\{ mcpg_step_env }} marker (at line 285 of base.yml). The corresponding function generate_mcpg_step_env() in src/compile/common.rs (line 1677) generates ADO env: block entries for secret pipeline variable passthrough to MCPG steps (used when extensions like Azure DevOps MCP require token variables). This marker is not documented in the template markers section of AGENTS.md.
Every other template marker in both .yml files has a corresponding ## \{\{ marker_name }} section in AGENTS.md. \{\{ mcpg_step_env }} is the only one missing.
4. Incorrect engine field in README.md Front Matter table (README.md line 228)
The table currently reads:
| engine | string or object | claude-opus-4.5 | AI model to use |
This is wrong in two ways:
- Default value should be
copilot, not claude-opus-4.5. The engine identifier string defaults to copilot; claude-opus-4.5 is the default for the model sub-field within the engine object.
- Description should be "Engine identifier (e.g.,
copilot); use object form to set model" β the field selects which AI runtime to use, not which model.
This is confirmed by src/compile/types.rs where EngineConfig defaults to Simple("copilot") and by src/engine.rs where DEFAULT_COPILOT_MODEL = "claude-opus-4.5" is the model default.
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β 982.7K Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between the code and documentation.
Findings
src/data/directory listed twice β first with onlyecosystem_domains.json, then correctly with all filesAGENTS.mdsrc/run.rs(debug-only local dev command) is absent from the architecture treeAGENTS.md\{\{ mcpg_step_env }}is used in bothbase.ymland1es-base.ymlbut has no documentation entryAGENTS.mdenginerow shows defaultclaude-opus-4.5and description "AI model to use" β both wrong;engineis the engine identifier (defaults tocopilot); the model is a sub-fieldREADME.mdDetails
1. Duplicate
src/data/in architecture tree (AGENTS.mdlines 25 and 76)The architecture tree contains two separate
data/entries nested undersrc/:Only one
src/data/directory exists on disk. The first entry (line 25) is a stale remnant and should be removed.2. Missing
src/run.rs(AGENTS.md)src/run.rsexists in the codebase (debug-only, gated with#[cfg(debug_assertions)]). It implements therunsubcommand for local development. The architecture tree doesn't list it. Since it was already referenced in the CLI commands section of AGENTS.md as a debug-onlyruncommand, it should also appear in the architecture tree.3. Undocumented
\{\{ mcpg_step_env }}template marker (AGENTS.md)Both
src/data/base.ymlandsrc/data/1es-base.ymlinclude the\{\{ mcpg_step_env }}marker (at line 285 ofbase.yml). The corresponding functiongenerate_mcpg_step_env()insrc/compile/common.rs(line 1677) generates ADOenv:block entries for secret pipeline variable passthrough to MCPG steps (used when extensions like Azure DevOps MCP require token variables). This marker is not documented in the template markers section ofAGENTS.md.Every other template marker in both
.ymlfiles has a corresponding## \{\{ marker_name }}section inAGENTS.md.\{\{ mcpg_step_env }}is the only one missing.4. Incorrect
enginefield in README.md Front Matter table (README.mdline 228)The table currently reads:
|
engine| string or object |claude-opus-4.5| AI model to use |This is wrong in two ways:
copilot, notclaude-opus-4.5. The engine identifier string defaults tocopilot;claude-opus-4.5is the default for themodelsub-field within the engine object.copilot); use object form to set model" β the field selects which AI runtime to use, not which model.This is confirmed by
src/compile/types.rswhereEngineConfigdefaults toSimple("copilot")and bysrc/engine.rswhereDEFAULT_COPILOT_MODEL = "claude-opus-4.5"is the model default.Suggested Fixes
data/entry at line 25 of theAGENTS.mdarchitecture tree (keep only the complete entry at line 76)src/run.rsto theAGENTS.mdarchitecture tree with annotation# Local agent runner (debug builds only)## \{\{ mcpg_step_env }}section toAGENTS.mddocumenting that this marker generates the ADOenv:block for secret pipeline variable passthrough (e.g.,SC_READ_TOKEN: $(SC_READ_TOKEN)) when extensions require token forwarding to MCPG stepsenginerow inREADME.md's Front Matter Fields table: change default fromclaude-opus-4.5tocopilotand update description to reflect thatengineis an engine identifier, not a model nameThis issue was created by the automated documentation freshness check.