Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Workflow authoring prompt |
upload-pipeline-artifact and upload-build-attachment are missing from the "All configurable safe output tools" table |
prompts/create-ado-agentic-workflow.md |
| Architecture tree |
src/hash.rs is not listed in the architecture tree |
AGENTS.md |
Details
1. prompts/create-ado-agentic-workflow.md β Two safe output tools missing from the table (HIGH PRIORITY)
The file's "All configurable safe output tools" table (Step 9, around line 272) lists 22 tools across Work Items, Pull Requests, Builds & Branches, Wiki, and Diagnostics categories. However, two tools that exist in src/safeoutputs/ and are fully documented in docs/safe-outputs.md and README.md are absent:
| Missing tool |
Source file |
write = true |
upload-pipeline-artifact |
src/safeoutputs/upload_pipeline_artifact.rs:117 |
β
|
upload-build-attachment |
src/safeoutputs/upload_build_attachment.rs:122 |
β
|
Both tools are documented correctly in docs/safe-outputs.md (lines ~421β498) and in the README.md safe-outputs table (lines ~393β394). Because prompts/create-ado-agentic-workflow.md is the primary guide AI agents use when creating new workflows, omitting these tools means agents will not know they can propose build artifact uploads, leading to missed capabilities or hand-coded workarounds.
Both tools should be added to the Builds & Branches group of the table (after add-build-tag):
| `upload-build-attachment` | Attach a workspace file to a build (visible via REST/custom extension) | β
|
| `upload-pipeline-artifact` | Publish a workspace file as a pipeline artifact (visible in Artifacts tab) | β
|
2. AGENTS.md β src/hash.rs missing from architecture tree
src/hash.rs exists in the repository:
// src/hash.rs β Cryptographic hash utilities shared across the crate.
// Used by safe-output tools to record and verify file integrity between
// Stage 1 (MCP, in-sandbox) and Stage 3 (executor, outside sandbox).
pub(crate) fn sha256_hex(data: &[u8]) -> String { ... }
It is not listed anywhere in the architecture tree under src/ in AGENTS.md. The tree currently jumps from agent_stats.rs directly to safeoutputs/, skipping hash.rs.
Suggested Fixes
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β 2.1M Β· β·
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
upload-pipeline-artifactandupload-build-attachmentare missing from the "All configurable safe output tools" tableprompts/create-ado-agentic-workflow.mdsrc/hash.rsis not listed in the architecture treeAGENTS.mdDetails
1.
prompts/create-ado-agentic-workflow.mdβ Two safe output tools missing from the table (HIGH PRIORITY)The file's "All configurable safe output tools" table (Step 9, around line 272) lists 22 tools across Work Items, Pull Requests, Builds & Branches, Wiki, and Diagnostics categories. However, two tools that exist in
src/safeoutputs/and are fully documented indocs/safe-outputs.mdandREADME.mdare absent:write = trueupload-pipeline-artifactsrc/safeoutputs/upload_pipeline_artifact.rs:117upload-build-attachmentsrc/safeoutputs/upload_build_attachment.rs:122Both tools are documented correctly in
docs/safe-outputs.md(lines ~421β498) and in theREADME.mdsafe-outputs table (lines ~393β394). Becauseprompts/create-ado-agentic-workflow.mdis the primary guide AI agents use when creating new workflows, omitting these tools means agents will not know they can propose build artifact uploads, leading to missed capabilities or hand-coded workarounds.Both tools should be added to the Builds & Branches group of the table (after
add-build-tag):2.
AGENTS.mdβsrc/hash.rsmissing from architecture treesrc/hash.rsexists in the repository:It is not listed anywhere in the architecture tree under
src/inAGENTS.md. The tree currently jumps fromagent_stats.rsdirectly tosafeoutputs/, skippinghash.rs.Suggested Fixes
upload-build-attachmentandupload-pipeline-artifactto the safe outputs table inprompts/create-ado-agentic-workflow.md(Step 9), in the Builds & Branches group, afteradd-build-tag, notingpermissions.write: βfor bothβββ hash.rs # SHA-256 utilities for safe-output file integrityto thesrc/architecture tree inAGENTS.md(betweenfuzzy_schedule.rsandinit.rs, or betweenagent_stats.rsandsafeoutputs/)This issue was created by the automated documentation freshness check.