mcpbeat

Build Workspace Docs

moizibnyousaf/build-workspace-docs

Use when regenerating README.md and WORK_AREAS.md in a managed library workspace. Always dry-run first to preview changes.

385 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
0
copies elsewhere
how many repositories repackaged it
1114
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/MoizIbnYousaf/Ai-Agent-Skills --skill build-workspace-docs

The instruction itself

6 sections, as written by the author

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

  • Preview what would change.
npx ai-agent-skills build-docs --dry-run
  • Regenerate the docs.
npx ai-agent-skills build-docs
  • 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.

How to use it

Copy the folder

Take moizibnyousaf/build-workspace-docs from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.

Install what it needs

The instructions reference npx. Without those the skill loads but fails at the first command.