Skip to content

docs: document edit-wiki-page safe output tool and add to architecture tree#63

Merged
jamesadevine merged 2 commits intomainfrom
copilot/update-documentation-for-edit-wiki-page
Mar 20, 2026
Merged

docs: document edit-wiki-page safe output tool and add to architecture tree#63
jamesadevine merged 2 commits intomainfrom
copilot/update-documentation-for-edit-wiki-page

Conversation

Copy link
Contributor

Copilot AI commented Mar 20, 2026

edit-wiki-page was fully implemented (src/tools/edit_wiki_page.rs, wired into execute.rs and mcp.rs) but entirely absent from AGENTS.md — neither in the architecture tree nor the Safe Output Tools reference.

Changes

  • Architecture tree: Added edit_wiki_page.rs to the src/tools/ listing in alphabetical order
  • Safe Output Tools: Added #### edit-wiki-page section covering:
    • Agent parameters: path (no ..), content (≥10 chars), optional comment
    • Front matter config: wiki-name (required), wiki-project, path-prefix, title-prefix, comment
    • Explicit callout that wiki-name is required — execution fails without it
safe-outputs:
  edit-wiki-page:
    wiki-name: "MyProject.wiki"     # Required
    wiki-project: "OtherProject"    # Optional — defaults to current pipeline project
    path-prefix: "/agent-output"    # Optional — restricts write scope
    title-prefix: "[Agent] "        # Optional — prepended to page title segment
    comment: "Updated by agent"     # Optional — default commit comment
Original prompt

This section details on the original issue you should resolve

<issue_title>📝 Documentation drift detected — edit-wiki-page safe output tool undocumented</issue_title>
<issue_description>## 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 ·

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


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

…ols documentation

Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for edit-wiki-page safe output tool docs: document edit-wiki-page safe output tool and add to architecture tree Mar 20, 2026
Copilot AI requested a review from jamesadevine March 20, 2026 10:19
@jamesadevine jamesadevine marked this pull request as ready for review March 20, 2026 10:21
@jamesadevine jamesadevine merged commit 20f543f into main Mar 20, 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 — edit-wiki-page safe output tool undocumented

2 participants