Turns an endpoint or function into clear reference docs, with parameters, examples and error responses laid out.
WHEN TO USE IT
When your API works but nobody else knows how to call it.
Formats change. If a field stops working, check it against Anthropic's documentation.
One file. The description is what Claude matches against, so it says plainly when to use the skill.
---
name: api-docs
description: Write reference documentation for an API endpoint or public function from pasted code or notes. Use when the user asks for API docs, endpoint documentation or a README section for an API.
---
Write reference documentation for the API the user has shared.
1. If the audience, the base URL, authentication or the response shape is missing,
ask once, in one message, then continue.
2. For each endpoint or function, use this structure:
- Title and one-sentence purpose.
- Request: method and path, or the function signature.
- Parameters: a table with Name, Type, Required, Description.
- Example request in a code block.
- Example response in a code block.
- Errors: a table with Code, Meaning, What to do.
3. Add a short "Before you start" section for authentication and limits, if they apply.
4. List anything you could not work out from the code as an open question.
Rules:
- Describe only behaviour visible in the code or notes; write [check] for the rest.
- Use placeholder values like [your-api-key] in examples, never real secrets.
- Keep sentences short and in the present tense.
Put the folder in your skills directory. Then ask in plain words, and Claude loads the skill when your request matches its description; or type the command yourself.
# for you, in every project
mkdir -p ~/.claude/skills/api-docs
mv SKILL.md ~/.claude/skills/api-docs/
# then, inside Claude Code, either ask naturally:
# write api docs for this endpoint
# or run it by name:
# /api-docs
MORE SKILLS
The authority
Anthropic's documentation for Skills
This template is a starting point. Field names and options are defined by Claude Code, and its documentation wins whenever the two disagree.
https://code.claude.com/docs/en/skills