Skip to content

docs: document update-work-item safe output tool and add to architecture tree#82

Merged
jamesadevine merged 2 commits into
mainfrom
copilot/fix-documentation-drift-update-work-item
Mar 24, 2026
Merged

docs: document update-work-item safe output tool and add to architecture tree#82
jamesadevine merged 2 commits into
mainfrom
copilot/fix-documentation-drift-update-work-item

Conversation

Copilot AI commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

update_work_item.rs was fully implemented and MCP-exposed but absent from both the architecture tree and Safe Output Tools documentation in AGENTS.md.

Changes

  • Architecture tree: Added update_work_item.rs to the src/tools/ listing between create_work_item.rs and update_wiki_page.rs
  • Safe Output Tools: Added #### update-work-item section documenting:
    • Agent parameters: id (required), plus optional title, body, state, area_path, iteration_path, assignee, tags — each gated by a corresponding config flag
    • All configuration options with defaults (status, title, body, markdown-body, title-prefix, tag-prefix, max, target, area-path, iteration-path, assignee, tags)
    • Security note: every mutable field requires explicit opt-in; max exceeded → excess entries skipped, batch continues
safe-outputs:
  update-work-item:
    status: true              # enable state/status updates (default: false)
    title: true               # enable title updates (default: false)
    body: true                # enable body/description updates (default: false)
    markdown-body: true       # ADO markdown rendering (default: false; Server 2022+ only)
    title-prefix: "[bot] "    # restrict to work items whose title starts with this prefix
    max: 3                    # max updates per run (default: 1)
Original prompt

This section details on the original issue you should resolve

<issue_title>📝 Documentation drift detected — update-work-item safe output tool undocumented</issue_title>
<issue_description>## Documentation Freshness Audit

The weekly documentation audit found the following inconsistencies between the codebase and .github/copilot-instructions.md:

Findings

Area Issue File(s)
Architecture tree src/tools/update_work_item.rs is missing from the directory tree .github/copilot-instructions.md
Safe Output Tools update-work-item tool is fully implemented and MCP-exposed but has no documentation entry src/tools/update_work_item.rs, src/mcp.rs, src/execute.rs

Details

1. Missing file in architecture tree

The documented directory tree under src/tools/ lists:

├── create_pr.rs
├── create_wiki_page.rs
├── create_work_item.rs
├── update_wiki_page.rs
├── memory.rs
├── missing_data.rs
├── missing_tool.rs
├── noop.rs
└── result.rs

But src/tools/update_work_item.rs exists and is exported from src/tools/mod.rs:

mod update_work_item;
pub use update_work_item::*;

2. Undocumented update-work-item safe output tool

update-work-item is a fully functional safe output tool:

  • MCP-exposed in src/mcp.rs (line ~340) as update-work-item
  • Executed in src/execute.rs during Stage 2, including a max count guard that skips excess entries rather than aborting the batch
  • Parameters (UpdateWorkItemParams):
    • id — work item ID to update (required)
    • title — new title (optional, requires config opt-in)
    • body — new description in markdown (optional, requires config opt-in)
    • state — new state e.g. "Active", "Resolved" (optional, requires config opt-in)
    • area_path, iteration_path, assignee, tags — optional, each requires config opt-in
  • Configuration options (safe-outputs.update-work-item in front matter):
    • status — enable state updates (default: false)
    • title — enable title updates (default: false)
    • body — enable body updates (default: false)
    • markdown-body — render body as markdown in ADO (default: false, ADO Server 2022+ only)
    • title-prefix — only update work items whose title starts with this prefix
    • max — maximum number of updates allowed in a single run (default: 1)
    • Additional tag-prefix filtering options

Suggested Fixes

  • Add update_work_item.rs to the architecture directory tree in .github/copilot-instructions.md
  • Add a new #### update-work-item section to the Safe Output Tools documentation, covering:
    • Agent parameters (id, title, body, state, area_path, iteration_path, assignee, tags)
    • Configuration options (status, title, body, markdown-body, title-prefix, max, tag-prefix)
    • Security note: each field requires explicit opt-in via configuration to prevent unintended updates

This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check ·

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

…e-work-item safe output tool

Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Agent-Logs-Url: https://github.com/githubnext/ado-aw/sessions/6afb6063-350a-40f4-99b6-2dfe12abbafd
Copilot AI changed the title [WIP] Fix documentation for update-work-item safe output tool docs: document update-work-item safe output tool and add to architecture tree Mar 24, 2026
Copilot AI requested a review from jamesadevine March 24, 2026 09:34
@jamesadevine jamesadevine marked this pull request as ready for review March 24, 2026 10:36
@jamesadevine jamesadevine merged commit 54de79c into main Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 Documentation drift detected — update-work-item safe output tool undocumented

2 participants