mcpField
B
build-workspace-docs

build-workspace-docs

github.com/moizibnyousafAgent workflows1.2k166 installsUpdated 5w ago
Repository

About build-workspace-docs

A skill for keeping workspace documentation aligned with the skills catalog after catalog changes. It previews generated changes and rebuilds the docs from an initialized library workspace.

Key features

  1. 01Preview documentation changes
  2. 02Regenerate workspace documentation
  3. 03Check whether docs are in sync
  4. 04Emit structured JSON results

Use cases

  1. 01Update docs after catalog curation
  2. 02Refresh docs after importing skills
  3. 03Verify documentation before committing changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/moizibnyousaf/ai-agent-skills --skill build-workspace-docs

After installing, type/build-workspace-docsin Claude Code to confirm it loaded.

Details

From the project README

Build Workspace Docs

Goal

Keep workspace documentation in sync with the skills catalog after adding, removing, or curating skills.

Guardrails

  • Always use --dry-run before regenerating docs to preview what will change.
  • Only run from inside an initialized library workspace (a directory with .ai-agent-skills/config.json).
  • Never hand-edit the generated sections of README.md or WORK_AREAS.md. The CLI will overwrite them.
  • Use --format json to capture structured results for automation pipelines.

Workflow

  1. Preview what would change.
npx ai-agent-skills build-docs --dry-run
  1. Regenerate the docs.
npx ai-agent-skills build-docs
  1. Verify the output.
npx ai-agent-skills build-docs --dry-run --format json

The JSON output includes currentlyInSync to tell you whether docs were already up to date.

When to Run

  • After add, catalog, vendor, or curate commands that change the skills catalog.
  • After bulk imports from a remote library.
  • Before committing workspace changes to git.

Gotchas

  • Running outside a workspace will fail with a clear error. Use init-library to create one first.
  • The generated docs use HTML comment markers (<!-- GENERATED:...:start/end -->) as boundaries. Do not remove these markers from the template sections.

Comments

Markdown supported