| name | docs-sync |
| description | Audit documentation coverage by comparing implementation against docs/. Use when asked to check doc coverage, sync docs with code, or after significant API surface changes. Produce a report and ask for approval before editing. |
Docs Sync
Overview
Identify doc coverage gaps and inaccuracies by comparing the current implementation (MCP tools, types, API endpoints) against the docs structure, then propose targeted improvements.
Workflow
-
Confirm scope and base branch
- Identify the current branch and default branch (usually
main).
- If not on
main, analyze only the diff vs main to scope doc updates.
-
Build a feature inventory
- Inventory the MCP tools surface: all tools in
src/, their parameters, and descriptions.
- Cross-reference with the scraped UniFi API docs in
docs/api/.
- Check that tool descriptions match the OpenAPI spec at
docs/api/openapi.json.
- Note any endpoints in the spec that don't have corresponding MCP tools.
-
Doc-first pass: review existing pages
- Walk each relevant page under
docs/.
- Identify missing mentions of tools, configuration options, or setup instructions.
-
Code-first pass: map features to docs
- Review
src/ exports and tool definitions.
- Determine the best doc page for each feature.
- Identify features that lack any documentation.
-
Detect gaps and inaccuracies
- Missing: tools/features present in code but absent in docs.
- Incorrect/outdated: descriptions that diverge from the current implementation.
- Structural issues: pages overloaded or mis-grouped.
-
Produce a Docs Sync Report and ask for approval before editing.
Output format
Docs Sync Report
- Doc-first findings
- Page + missing content → evidence + suggested insertion point
- Code-first gaps
- Feature + evidence → suggested doc page/section
- Incorrect or outdated docs
- Doc file + issue + correct info + evidence
- Proposed edits
- Doc file → concise change summary
- Questions for the user