How to use the API Doc Generator agent skill (doc-generator)

What the doc-generator skill makes the agent do

Once the skill is loaded, the agent writes API documentation following a fixed template. For each endpoint it produces a description, a parameter table, success and error responses with JSON examples, and cURL, JavaScript and Python examples.

The skill also covers OpenAPI/Swagger specifications, SDK usage examples, integration guides, error code references and authentication guides.

• Endpoint docs: description, parameters, responses, examples
• OpenAPI/Swagger specifications
• SDK usage examples and integration guides
• Error code references and authentication guides

Install the doc-generator skill

Download the ZIP for this skill from this page and unzip it. You can put the skill in your personal skills folder at ~/.claude/skills/, or in a single project's .claude/skills/ folder if you want it only for that project.

If you use the Claude apps instead, upload the skill under Settings → Capabilities → Skills.

• Personal install: unzip into ~/.claude/skills/
• Project install: unzip into the project's .claude/skills/
• Claude apps: Settings → Capabilities → Skills, then upload

Trigger the skill with natural requests

You do not need a special command. The skill's description tells the agent to use it when you create or update API documentation, generate OpenAPI specs, or mention API docs, endpoints or documentation. Ask in plain language and name the code you want documented.

Good requests name the files or endpoints involved, for example the handlers in a particular folder or one route you want an example for.

• "Write API docs for the endpoints in src/api/users.py"
• "Generate an OpenAPI spec for our REST endpoints"
• "Document the error codes returned by the orders service"

Run the bundled script (optional)

The skill includes generate-docs.py. It uses Python's built-in ast module to parse source files and look for functions whose names start with get_ or post_. It collects their docstrings, parameters and return annotations and writes a basic Markdown document.

The script needs Python 3. You do not need it if you only want the agent to write the docs from its own reading of the code.

• Requires Python 3
• Only parses Python files
• Only picks up functions named get_ or post_, so most endpoints in other frameworks will be missed

Safety notes: scripts and network

The skill runs scripts, so read generate-docs.py before running it on code you care about. According to the listing, the skill does not use the network.

The example requests in the template use placeholder values such as YOUR_TOKEN and api.example.com. Replace them with real values yourself and do not paste real credentials into the docs.

• Runs scripts: yes (generate-docs.py)
• Uses network: no
• Check placeholders and remove any real secrets before publishing

Review the output before you publish

The template examples are illustrative. The agent may invent response shapes or routes that are not in your code, so compare every endpoint, field and status code against the source. Treat the output as a first draft you edit by hand.

• Check every route and HTTP method against the code
• Check response fields and error codes
• Edit the OpenAPI draft before using it with tools