agentleFS
Sign inStart free
pproencapproenca/unifi-mcp/.agents/skills/docs-sync/SKILL.md

docs-sync

Skill2 starsChanged 7 months agoMITView on GitHub

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.

46 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use tdd, code-review and 2 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    tdd

    Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

    Also in 4 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 5 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 4 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 36 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If not on main, analyze only the diff vs main to scope doc updates.

    line 16
  2. Very specific:

    Check that tool descriptions match the OpenAPI spec at docs/api/openapi.json.

    line 21

“Common” is measured: kept by at least 6 in 10 of the 36 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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

  1. 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.
  2. 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.
  3. Doc-first pass: review existing pages
    • Walk each relevant page under docs/.
    • Identify missing mentions of tools, configuration options, or setup instructions.
  4. 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.
  5. 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.
  6. 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free