Skip to content

πŸ“ Documentation drift detected β€” edit-wiki-page safe output tool undocumentedΒ #62

@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/edit_wiki_page.rs exists but is not listed in the directory tree .github/copilot-instructions.md
Safe Output Tools edit-wiki-page tool is fully implemented and wired up but has zero documentation src/tools/edit_wiki_page.rs, src/execute.rs, src/mcp.rs

Details

1. Architecture tree missing edit_wiki_page.rs

The src/tools/ listing in the Architecture section shows:

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

But src/tools/edit_wiki_page.rs exists and is exported from src/tools/mod.rs (line 14: mod edit_wiki_page;, line 23: pub use edit_wiki_page::*;).

2. edit-wiki-page tool entirely absent from Safe Output Tools documentation

The tool is fully implemented:

  • src/tools/edit_wiki_page.rs β€” agent params, config struct, executor
  • src/execute.rs β€” handles "edit-wiki-page" in Stage 2 (lines 185–190)
  • src/mcp.rs β€” exposes the tool via MCP server (lines 408–433)

The tool has the following interface (currently undocumented):

Agent parameters:

  • path β€” Wiki page path to update (e.g. /Overview/Architecture). Must not contain ...
  • content β€” Markdown content for the wiki page (at least 10 characters).
  • comment (optional) β€” Commit comment; falls back to front matter config or "Updated by agent".

Configuration options (front matter):

safe-outputs:
  edit-wiki-page:
    wiki-name: "MyProject.wiki"     # Required β€” wiki identifier (name or GUID)
    wiki-project: "OtherProject"    # Optional β€” defaults to current project
    path-prefix: "/agent-output"    # Optional β€” prepended to agent-supplied path
    title-prefix: "[Agent] "        # Optional β€” prepended to the last path segment
    comment: "Updated by agent"     # Optional β€” default commit comment

Suggested Fixes

  • Add edit_wiki_page.rs to the src/tools/ listing in the Architecture section of .github/copilot-instructions.md
  • Add a new #### edit-wiki-page section under Safe Output Tools documenting agent parameters and front matter configuration options
  • Note that wiki-name is required for execution (tool fails without it)

This issue was created by the automated documentation freshness check.

Generated by Documentation Freshness Check Β· β—·

Metadata

Metadata

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