mcpField
W
w-api-docs

w-api-docs

github.com/blockmaticDevelopment1647 installsUpdated 4w ago
Repository

About w-api-docs

w-api-docs is a development skill for updating API documentation through its owning schema or route rather than generated files. It guides maintainers through identifying the generator, regenerating artifacts, and updating adopter docs when behavior changes.

Key features

  1. 01Find the source of truth and generator
  2. 02Edit schemas or routes, not generated files
  3. 03Run generation and check for drift
  4. 04Update adopter docs for behavior changes

Use cases

  1. 01Revise API documentation after a route change
  2. 02Regenerate OpenAPI artifacts from source
  3. 03Check generated output for repository drift

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/blockmatic/basilic-skills --skill w-api-docs

After installing, type/w-api-docsin Claude Code to confirm it loaded.

Details

From the project README

Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.

  1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
  2. Change the owning schema or route, not the generated artifact.
  3. Run the documented generate command. Check drift scripts if the repo has them.
  4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
  5. Docs: /w-docs if behavior or commands changed.

Comments

Markdown supported