Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Runtime Parameters section |
clearMemory injection documented as triggered by safe-outputs.memory β should be tools.cache-memory |
AGENTS.md lines 402, 569 |
| MCP server configuration |
McpOptions.enabled: Option<bool> field is undocumented |
AGENTS.md, README.md, prompts/create-ado-agentic-workflow.md |
Details
1. Stale safe-outputs.memory references in AGENTS.md
In two places, AGENTS.md says the clearMemory parameter is auto-injected "When safe-outputs.memory is configured":
- Line 402 β in the "Auto-injected
clearMemory Parameter" subsection of the Runtime Parameters section
- Line 569 β in the
\{\{ parameters }} template marker description
However, the actual code in src/compile/common.rs (line 1655β1660) checks front_matter.tools.cache_memory:
let has_memory = front_matter
.tools
.as_ref()
.and_then(|t| t.cache_memory.as_ref())
.is_some_and(|cm| cm.is_enabled());
let parameters = build_parameters(&front_matter.parameters, has_memory);
There is no safe-outputs.memory field β memory is configured under tools.cache-memory. AGENTS.md itself correctly documents this migration at line 1452:
"cache-memory (moved to tools:) β Memory is now configured as a first-class tool under tools: cache-memory: instead of safe-outputs: memory:."
So these two stale references are internal inconsistencies within AGENTS.md itself, in addition to being wrong relative to the code.
Impact: AI agents using AGENTS.md as their reference may incorrectly look for a safe-outputs: memory: key to determine whether clearMemory is injected, rather than checking tools: cache-memory:.
2. Undocumented McpOptions.enabled field
src/compile/types.rs line 760 defines:
pub struct McpOptions {
/// Whether this MCP is enabled (default: true)
#[serde(default)]
pub enabled: Option<bool>,
...
}
This enabled: false toggle allows users to temporarily disable an MCP server entry without deleting it from the front matter. However, it is not mentioned in:
AGENTS.md MCP configuration section
README.md Custom MCP Servers section
prompts/create-ado-agentic-workflow.md Step 8
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β 2.2M Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
clearMemoryinjection documented as triggered bysafe-outputs.memoryβ should betools.cache-memoryAGENTS.mdlines 402, 569McpOptions.enabled: Option<bool>field is undocumentedAGENTS.md,README.md,prompts/create-ado-agentic-workflow.mdDetails
1. Stale
safe-outputs.memoryreferences in AGENTS.mdIn two places,
AGENTS.mdsays theclearMemoryparameter is auto-injected "Whensafe-outputs.memoryis configured":clearMemoryParameter" subsection of the Runtime Parameters section\{\{ parameters }}template marker descriptionHowever, the actual code in
src/compile/common.rs(line 1655β1660) checksfront_matter.tools.cache_memory:There is no
safe-outputs.memoryfield β memory is configured undertools.cache-memory.AGENTS.mditself correctly documents this migration at line 1452:So these two stale references are internal inconsistencies within
AGENTS.mditself, in addition to being wrong relative to the code.Impact: AI agents using
AGENTS.mdas their reference may incorrectly look for asafe-outputs: memory:key to determine whetherclearMemoryis injected, rather than checkingtools: cache-memory:.2. Undocumented
McpOptions.enabledfieldsrc/compile/types.rsline 760 defines:This
enabled: falsetoggle allows users to temporarily disable an MCP server entry without deleting it from the front matter. However, it is not mentioned in:AGENTS.mdMCP configuration sectionREADME.mdCustom MCP Servers sectionprompts/create-ado-agentic-workflow.mdStep 8Suggested Fixes
"When safe-outputs.memory is configured"β"When tools.cache-memory is configured""When safe-outputs.memory is configured"β"When tools.cache-memory is configured"enabled: falseMCP toggle, e.g.:This issue was created by the automated documentation freshness check.