Skip to content

πŸ“ Documentation drift detected β€” create-wiki-page tool undocumentedΒ #67

@github-actions

Description

@github-actions

Documentation Freshness Audit

The weekly documentation audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree src/tools/create_wiki_page.rs exists but is not listed in the architecture file tree .github/copilot-instructions.md
Safe Output Tools create-wiki-page tool is fully implemented but entirely absent from documentation src/tools/create_wiki_page.rs, .github/copilot-instructions.md

Details

1. Missing file in architecture tree

The documented architecture tree lists these files under src/tools/:

β”œβ”€β”€ tools/
β”‚   β”œβ”€β”€ mod.rs
β”‚   β”œβ”€β”€ create_pr.rs
β”‚   β”œβ”€β”€ create_work_item.rs
β”‚   β”œβ”€β”€ update_wiki_page.rs
β”‚   β”œβ”€β”€ memory.rs
β”‚   β”œβ”€β”€ missing_data.rs
β”‚   β”œβ”€β”€ missing_tool.rs
β”‚   β”œβ”€β”€ noop.rs
β”‚   └── result.rs

But src/tools/create_wiki_page.rs also exists on disk and is referenced in src/tools/mod.rs. It is missing from the architecture tree.

2. create-wiki-page tool is completely undocumented

src/tools/create_wiki_page.rs implements a fully functional MCP safe-output tool for creating new Azure DevOps wiki pages. It is registered in src/mcp.rs as the create-wiki-page tool.

The documentation covers update-wiki-page in detail (for editing existing pages), but makes no mention of create-wiki-page.

Key details of the undocumented tool:

Agent parameters:

  • path β€” Wiki page path to create (e.g. /Overview/NewPage). Must not exist already. Must not contain ...
  • content β€” Markdown content for the wiki page (at least 10 characters).
  • comment (optional) β€” Commit comment. Defaults to the value in front matter, or "Created by agent".

Configuration options (front matter safe-outputs.create-wiki-page):

  • wiki-name β€” Wiki identifier (name or GUID). Required.
  • wiki-project β€” ADO project owning the wiki. Defaults to current pipeline project.
  • path-prefix β€” Prepended to the agent-supplied path (restricts write scope).
  • title-prefix β€” Prepended to the last path segment (the page title).
  • comment β€” Default commit comment when agent omits one.

Notable difference from update-wiki-page: The tool enforces that the page does not already exist (atomic create-only via If-Match: ""). Attempting to create a page that already exists results in an explicit failure.

Suggested Fixes

  • Add create_wiki_page.rs to the architecture file tree in .github/copilot-instructions.md
  • Add a #### create-wiki-page section under Safe Outputs in .github/copilot-instructions.md, documenting its agent parameters, configuration options, and the "page must not already exist" constraint

This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check Β· β—·

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions