Agent skill

API Docs Writer

by mohitagw15856 in mohitagw15856/pm-claude-skills

Write clear, developer-facing API documentation. An agent skill from mohitagw15856/pm-claude-skills.

MITAuto-check passedDevelopment

Install API Docs Writer

skills CLI
$ npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install mohitagw15856/pm-claude-skills api-docs-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/api-docs-writer .claude/skills/api-docs-writer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-docs-writer
GitHub stars
1.4k
Token cost
~1.9k tokens
SKILL.md length
859 words
Files
4 (incl. references)
Skills in repo
1,348
Repo updated
First seen
Licence
MIT

At a glance

Write clear, developer-facing API documentation. An agent skill from mohitagw15856/pm-claude-skills.

  • Asked to document an API endpoint
  • SKILL.md covers Required Inputs, Output Format, [METHOD] /path/to/endpoint and Deeper Materials, plus 5 more sections
  • Calls curl; needs INSERT_TOKEN
  • Write API reference docs

What it does

API Docs Writer is an agent skill from mohitagw15856/pm-claude-skills. 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.

Its SKILL.md is about 1.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `references/example-first-docs.md`, `references/worked-example.md` and `templates/endpoint-entry.md`).

It sits in Development, covering Technical documentation and REST APIs. It works with Postman. The repository describes itself as: 1255 professional Agent Skills for Claude, ChatGPT, Gemini, Cursor & Codex — PRDs, postmortems, leases, medical bills, layoffs, go-bags, new countries. Plain markdown, MIT, in… The licence is MIT.

When your agent uses it

  • Asked to document an API endpoint
  • Write API reference docs
  • Create a developer guide
  • Turn a raw spec/Postman collection into documentation

Example prompts

  • “/api-docs-writer”

Requirements

  • Python 3
  • A credential in YOUR_TOKEN
  • A credential in INSERT_TOKEN

What it can do on your machine

Read from SKILL.md and the folder at commit 1cbf1f0. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • curl

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use curl, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • INSERT_TOKEN

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Docs Writer loads about 1.9k tokens when it runs, and up to ~5.6k if it reads all its reference files. Until then it costs about 81 tokens; SKILL.md has 859 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~81
When it runs · the whole SKILL.md, loaded when a task matches
~1.9k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~5.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from mohitagw15856/pm-claude-skills at commit 1cbf1f0, republished under its MIT licence (© mohitagw15856). 859 words, ~1,926 tokens.

Download SKILL.mdSave it as .claude/skills/api-docs-writer/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
api-docs-writer
description
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.

API Docs Writer Skill

This skill transforms raw API specs, endpoint descriptions, or Postman collections into clean, developer-facing documentation following OpenAPI-adjacent conventions. Output is ready for a developer portal, README, or Notion/Confluence page.

Required Inputs

Ask the user for these if not provided:

  • 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)

Output Format

For each endpoint, produce the following:


[METHOD] /path/to/endpoint

Summary: [One line — what this endpoint does]

Description: [2–4 sentences. When to use this endpoint. What it returns. Any important behaviour to know (pagination, rate limits, async processing, etc.)]

Authentication: [Required / Optional — method]


Request

Headers:

HeaderRequiredDescription
AuthorizationYesBearer <token>
Content-TypeYesapplication/json

Path Parameters:

ParameterTypeRequiredDescription
idstringYesUnique identifier for the resource

Query Parameters:

ParameterTypeRequiredDefaultDescription
limitintegerNo20Max results per page (1–100)
cursorstringNo—Pagination cursor from previous response

Request Body:

json
{
  "field_name": "value",
  "another_field": 42
}
FieldTypeRequiredDescription
field_namestringYes[Plain description of what this field does]
another_fieldintegerNo[Description. Include valid range or enum values if applicable]

Response

Success Response: 200 OK

json
{
  "id": "abc123",
  "status": "active",
  "created_at": "2025-04-01T10:00:00Z"
}
FieldTypeDescription
idstringUnique identifier for the created/retrieved resource
statusstringCurrent status. Enum: active, inactive, pending
created_atISO 8601 stringTimestamp of creation in UTC

Error Codes
Status CodeError CodeDescriptionHow to Resolve
400INVALID_REQUESTRequest body is malformed or missing required fieldsCheck request body against schema above
401UNAUTHORIZEDMissing or invalid authentication tokenVerify your API key or refresh your token
404NOT_FOUNDThe requested resource does not existCheck the ID in the path parameter
429RATE_LIMITEDToo many requestsBack off and retry after Retry-After header value
500INTERNAL_ERRORUnexpected server errorRetry with exponential backoff; contact support if persists

Code Examples

Produce examples in at least 2 languages relevant to the audience (default: cURL + Python):

cURL:

bash
curl -X POST https://api.example.com/v1/endpoint \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field_name": "value"}'

Python:

python
import requests

response = requests.post(
    "https://api.example.com/v1/endpoint",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json={"field_name": "value"}
)
data = response.json()

Deeper Materials

This skill ships with support files — use them when they are available:

  • references/example-first-docs.md — Example-First API Docs: the Rules That Make Docs Usable. Apply it while producing the output; it carries the calibration and judgment calls the method summary above compresses.
  • templates/endpoint-entry.md — a fill-in version of the deliverable with the quality gates inline. Offer it when the user wants to work the document themselves rather than have it generated.
Show full SKILL.md (415 more words)Show less

Scoring Rubric (0–40)

Score any output of this skill before handing it over; 32+ is ship-quality.

Dimension0510
Parameter completenessFields listed without types or required/optional flagsTables complete, but descriptions say what a field is, not what it does; enums and ranges missingEvery field typed and constrained (enums, ranges, formats), described by behaviour and consequence
Error-path coverageHappy path only — no error tableStandard 400/401/404/429/500 rows present but with no resolution guidanceFull standard set plus endpoint-specific codes, each with what the developer should do, including unsafe-retry cases
Example runnabilityPseudo-code, undefined variables, or "YOUR_ENDPOINT" placeholdersExamples exist but aren't copy-paste-runnable or use only one language≥2 languages, real base URL, obviously-fake placeholder credentials, runnable as pasted
Behavioural candourAsync behaviour, pagination, idempotency, and legacy quirks omittedQuirks mentioned in prose but absent from examples and error rowsGotchas documented with the exact requests/responses they produce, including awkward legacy behaviour

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
  • 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

Anti-Patterns

  • 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

Usage Examples

  • "Document this API endpoint: [paste spec or description]"
  • "Turn this Postman collection into developer docs"
  • "Write API reference docs for [endpoint]"
  • "Write a developer guide for our [product] API"

Example Trigger Phrases

  • "Document an API endpoint."
  • "Write API reference docs."
  • "Create a developer guide."
  • "Turn a raw spec/Postman collection into documentation."

© mohitagw15856, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files (references) in skills/api-docs-writer of mohitagw15856/pm-claude-skills.

  • SKILL.md
  • references/example-first-docs.md
  • references/worked-example.md
  • templates/endpoint-entry.md

Open the folder on GitHubat commit 1cbf1f0

Compare with similar skills

API Docs Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Docs Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Docs Writer this skillmohitagw15856/pm-claude-skills1.4k—~1.9kAutomated safety check: PassMIT
API Generatinghuangjia2019/claude-code-engineering1.1k—~426Automated safety check: PassNone
API Docslangchain-ai/skills-benchmarks118—~358Automated safety check: PassMIT
Readme Generator Probeizhi23/README-Generator-Pro113—~472Automated safety check: NotesNone
Finding TriageHacktronAI/skills115—~2.9kAutomated safety check: NotesMIT
OpenAPI Spec Generationwshobson/agents40k9 repos~511Automated safety check: PassMIT

Similar skills

  • API Generating

    huangjia2019/claude-code-engineering

    Generate API endpoint documentation from Express route files.

    1.1k GitHub stars~426 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • API Docs

    langchain-ai/skills-benchmarks

    Official

    OpenAPI documentation and REST API design patterns. An agent skill from langchain-ai/skills-benchmarks.

    118 GitHub stars~358 tokensUpdated 18 days ago
    DevelopmentAuto-check passed
  • Readme Generator Pro

    beizhi23/README-Generator-Pro

    Generate, modify, and render professional README.md files and project introduction HTML pages using the bundled README Generator Pro FastAPI application.

    113 GitHub stars~472 tokensUpdated 3 mo ago
    Backend & APIsAuto-check: notes
  • Finding Triage

    HacktronAI/skills

    Interactively validate and triage Hacktron findings against the actual source code and (optionally) a live deployment, separate true positives from false positives, adjust severity, then either…

    115 GitHub stars~2.9k tokensUpdated 4 mo ago
    Backend & APIsAuto-check: notes
  • Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.

    40k GitHub starsUsed in 9 repos~511 tokens
    Backend & APIsAuto-check passed
  • GitHub Code Review

    RedWoodOG/Hermes-Desktop

    Review code changes by analyzing git diffs, leaving inline comments on PRs, and performing thorough pre-push review.

    177 GitHub starsUsed in 5 repos~3.4k tokens
    DevelopmentAuto-check: notes

More from mohitagw15856/pm-claude-skills

All 1,348 skills in this repo
  • Car Tco

    mohitagw15856/pm-claude-skills

    Compare the total cost of car ownership across buy-new, buy-used, lease, and keep-your-current-car — depreciation, insurance, maintenance ramp, and fuel over a real horizon, not just the monthly…

    1.4k GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed
  • Cs Health Scorecard

    mohitagw15856/pm-claude-skills

    Build a customer health scorecard for a specific account. An agent skill from mohitagw15856/pm-claude-skills.

    1.4k GitHub stars~2.4k tokensUpdated yesterday
    Auto-check passed
  • Exit Waterfall

    mohitagw15856/pm-claude-skills

    Compute who gets what at each exit price from a cap table — liquidation preferences, conversion points, and where the founders' share collapses.

    1.4k GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed
  • Feature Prioritisation

    mohitagw15856/pm-claude-skills

    Apply prioritisation frameworks (RICE, MoSCoW, Kano, ICE, Opportunity Scoring) to rank features and backlog items.

    1.4k GitHub stars~2k tokensUpdated yesterday
    Auto-check passed
  • Fire Number

    mohitagw15856/pm-claude-skills

    Compute a financial-independence (FIRE) target and years-to-reach with every assumption labeled as an assumption — plus a sensitivity table instead of a single false-precision answer.

    1.4k GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed
  • Freelance Rate

    mohitagw15856/pm-claude-skills

    Derive a freelance day/hourly rate backwards from target income, honest billable utilization, overhead, and the self-employment tax premium — the arithmetic that proves a rate is not salary÷2000.

    1.4k GitHub stars~1.2k tokensUpdated yesterday
    Auto-check passed

Works with

Questions about API Docs Writer

What does API Docs Writer do?

Write clear, developer-facing API documentation. An agent skill from mohitagw15856/pm-claude-skills. API Docs Writer is an agent skill from mohitagw15856/pm-claude-skills. Write clear, developer-facing API documentation.

When should I use API Docs Writer?

API Docs Writer fits situations like: asked to document an API endpoint; write API reference docs; create a developer guide; turn a raw spec/Postman collection into documentation.

How do I install API Docs Writer in Claude Code?

Run `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -a claude-code`. Or copy the skill folder (skills/api-docs-writer in mohitagw15856/pm-claude-skills) into .claude/skills/api-docs-writer in your project. Claude Code loads it when a task matches its description.

How do I install API Docs Writer in Codex?

Run `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -a codex`. Or copy the skill folder (skills/api-docs-writer in mohitagw15856/pm-claude-skills) into .agents/skills/api-docs-writer in your project. Codex loads it when a task matches its description.

Can I use API Docs Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-docs-writer, .gemini/skills/api-docs-writer, .github/skills/api-docs-writer and .opencode/skills/api-docs-writer in your project.

What does API Docs Writer need to run?

Going by SKILL.md and its folder, API Docs Writer needs the command-line tools its instructions call (curl) and credentials named INSERT_TOKEN. Our summary lists: Python 3; A credential in YOUR_TOKEN; A credential in INSERT_TOKEN.

Does API Docs Writer access the network?

SKILL.md contains no URLs. Its commands use curl, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is API Docs Writer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Docs Writer use?

API Docs Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Docs Writer use?

About 1.9k tokens (SKILL.md is roughly 7.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 3.6k tokens, read only when the agent opens those files.

What are the alternatives to API Docs Writer?

Skills that share tags, products or a category with API Docs Writer: API Generating (huangjia2019/claude-code-engineering, 1.1k stars), API Docs (langchain-ai/skills-benchmarks, 118 stars), Readme Generator Pro (beizhi23/README-Generator-Pro, 113 stars) and Finding Triage (HacktronAI/skills, 115 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Docs Writer?

mohitagw15856 (a GitHub user) maintains it in mohitagw15856/pm-claude-skills, which has 1,433 GitHub stars. The repository holds 1,348 skills in this directory. The repository was last updated on October 8, 2026.

Source: mohitagw15856/pm-claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.