API Docs Writer

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 in the Playground View SKILL.md ↗

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

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

Related skills

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