What do I need to use API Docs Writer?

API or endpoint details; Auth method; Base URL; API version; Rate limits; Audience; Output format.

Is API Docs Writer free to use?

Yes — run it free in the browser playground (no API key needed for the sponsored trial, or bring any provider key), or install it into Claude Code, Cursor, ChatGPT and more via npx pm-claude-skills. MIT-licensed and open source.

API Docs Writer

Q: How do I know the API Docs Writer output is good?

The skill verifies itself against its own quality checks: Every parameter is documented (type, required/optional, description); Response fields are fully documented with types; All relevant error codes are listed with resolution guidance; Error codes cover at minimum: 400 (bad request), 401/403 (auth), 404 (not found), 429 (rate limited), 500 (server error) — or explicitly note which don't apply to this endpoint.

🟢 Production-Ready🕐 updated 2026-07-14 🔷 SkillSpec L3 pm-engineering

Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a raw spec/Postman collection into documentation. Produces endpoint documentation with descriptions, parameters, request/response examples, and error codes.

▶ Run it free — no key needed 📝 Grade your existing draft View SKILL.md ↗

What to give it

▸API or endpoint details — raw spec, Postman export, or verbal description

▸Auth method — API key / Bearer token / OAuth 2.0 / None

▸Base URL

▸API version — e.g. v1, v2.3, or "unversioned" — affects deprecation notes and versioning headers

▸Rate limits — requests per second/minute per token or IP, if known — or "unknown"

▸Audience — internal developers / external partners / public

▸Output format — Markdown for developer portals and READMEs / Plain prose for Confluence or Notion — note: OpenAPI YAML is not produced by this skill

✅ The bar it holds itself to

Every skill in this library self-verifies — these are this skill's own quality checks, straight from its definition.

✓Every parameter is documented (type, required/optional, description)

✓Response fields are fully documented with types

✓All relevant error codes are listed with resolution guidance

✓Error codes cover at minimum: 400 (bad request), 401/403 (auth), 404 (not found), 429 (rate limited), 500 (server error) — or explicitly note which don't apply to this endpoint

✓Code examples use the actual base URL and a realistic placeholder token — no examples reference undefined variables or "YOUR_ENDPOINT" outside the snippet

✓Auth method is clearly stated at the top

✓Enum values are listed where applicable

✓Pagination documented if the endpoint is a list endpoint

⚠️ What it refuses to do

Do not document only the happy path — every endpoint must have error codes for at least 400, 401/403, 404, 429, and 500

Do not use placeholder values like "YOUR_ENDPOINT" or "INSERT_TOKEN" in code examples — use realistic-looking placeholders anchored to the actual base URL

Do not skip enum values for fields with a fixed set of accepted values — undocumented enums cause integration bugs

Do not omit pagination documentation on list endpoints — developers who miss this will build integrations that silently miss data

Do not describe what a field "is" without describing what it "does" — "the ID" is not documentation; "the unique identifier used to retrieve or update this resource" is

Install

npx pm-claude-skills add --agent claude   # or codex · cursor · gemini · hermes
# or one-line MCP (every skill, any client):
claude mcp add pm-skills -- npx -y pm-claude-skills-mcp

Start with

Related skills

🔌 Embed this skill

Drop this on your blog, docs, or site — it renders a "Run this skill" card:

<div data-pm-skill="api-docs-writer"></div>
<script src="https://mohitagw15856.github.io/pm-claude-skills/embed.js" async></script>

💬 Discussion

API Docs Writer is one of 1098 open-source professional AI agent skills — all SkillSpec L3. Try them all in the browser · ⭐ Star on GitHub · Browse the full catalog