Agent skill

API Docs Writer

by zhuyansen in zhuyansen/agent-skills-hub

Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

MITAuto-check passedDevelopment

Install API Docs Writer

skills CLI
$ npx skills add zhuyansen/agent-skills-hub --skill api-docs-writer -a claude-code

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

GitHub CLI
$ gh skill install zhuyansen/agent-skills-hub 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/zhuyansen/agent-skills-hub.git skills-src && mkdir -p .claude/skills && cp -r skills-src/ops/skillmgr-runs/in/input/library/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
413
Token cost
~198 tokens
SKILL.md length
115 words
Files
1
Skills in repo
21
Repo updated
First seen
Licence
MIT

At a glance

Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

  • Works in 3 steps: Read the input the user points to. If… → Do the task described above, step by… → Show the result, then a short list of…
  • Tasks that involve Technical documentation
  • SKILL.md covers When to use, Steps and Notes
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Docs Writer is an agent skill from zhuyansen/agent-skills-hub. Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

Its SKILL.md is about 200 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: Discover and compare open-source Agent Skills, tools & MCP servers — with quality scoring, trending analysis, and automated GitHub sync. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/api-docs-writer”

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. Read the input the user points to. If none is given, ask for the file or text.
  2. Do the task described above, step by step, and keep the user's own wording where it matters.
  3. Show the result, then a short list of what you changed or found, so the user can check it.

What it can do on your machine

Read from SKILL.md and the folder at commit 2862275. 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

    No scripts in the folder and no shell commands in SKILL.md.

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

  • Network

    No URLs in SKILL.md.

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

  • Credentials

    Names no API keys, tokens, secrets or passwords.

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

Context cost

API Docs Writer loads about 198 tokens when it runs. Until then it costs about 30 tokens; SKILL.md has 115 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~30
When it runs · the whole SKILL.md, loaded when a task matches
~198

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 zhuyansen/agent-skills-hub at commit 2862275, republished under its MIT licence (© zhuyansen). 115 words, ~198 tokens.

Download SKILL.mdSave it as .claude/skills/api-docs-writer/SKILL.md (or your agent's skills folder).
name
api-docs-writer
description
Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

Api Docs Writer

Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

When to use

Use this skill when the user asks for it by name or describes this task. Do not use it for unrelated work.

Steps

  1. Read the input the user points to. If none is given, ask for the file or text.
  2. Do the task described above, step by step, and keep the user's own wording where it matters.
  3. Show the result, then a short list of what you changed or found, so the user can check it.

Notes

  • Keep changes small and reversible.
  • Say plainly when the input is incomplete instead of guessing.

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

Files

Just SKILL.md in ops/skillmgr-runs/in/input/library/api-docs-writer of zhuyansen/agent-skills-hub.

Open the folder on GitHubat commit 2862275

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 skillzhuyansen/agent-skills-hub413—~198Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design48k1 repos~7.6kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    48k GitHub starsUsed in 1 repo~7.6k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 8 days ago
    DevelopmentAuto-check: notes
  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from zhuyansen/agent-skills-hub

All 21 skills in this repo
  • AgentSkillsHub Skill Finder

    zhuyansen/agent-skills-hub

    Searches a locally cached, security-graded catalog of agent skills and MCP servers, and returns install commands after checking each one's grade.

    413 GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Accessibility Check

    zhuyansen/agent-skills-hub

    Check an HTML page for missing alt text, low contrast, unlabeled inputs and heading order.

    413 GitHub stars~193 tokensUpdated today
    Auto-check passed
  • Changelog Writer

    zhuyansen/agent-skills-hub

    Write a CHANGELOG entry from the commits since the last tag, grouped into added, changed and fixed.

    413 GitHub stars~196 tokensUpdated today
    Auto-check passed
  • Cron Explainer

    zhuyansen/agent-skills-hub

    Explain a cron expression in words and list its next five run times.

    413 GitHub stars~180 tokensUpdated today
    Auto-check passed
  • CSV Cleaner

    zhuyansen/agent-skills-hub

    Clean messy CSV files: fix headers, trim whitespace, normalise dates and drop duplicate rows before analysis.

    413 GitHub stars~199 tokensUpdated today
    Auto-check passed
  • Dependency Updater

    zhuyansen/agent-skills-hub

    Plan dependency upgrades: which packages are behind, which have breaking changes, in what order.

    413 GitHub stars~196 tokensUpdated today
    Auto-check passed

Categories

Questions about API Docs Writer

What does API Docs Writer do?

Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors. API Docs Writer is an agent skill from zhuyansen/agent-skills-hub. Write reference documentation for an HTTP endpoint from its handler code: parameters, responses, errors.

When should I use API Docs Writer?

API Docs Writer fits situations like: tasks that involve Technical documentation.

How do I install API Docs Writer in Claude Code?

Run `npx skills add zhuyansen/agent-skills-hub --skill api-docs-writer -a claude-code`. Or copy the skill folder (ops/skillmgr-runs/in/input/library/api-docs-writer in zhuyansen/agent-skills-hub) 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 zhuyansen/agent-skills-hub --skill api-docs-writer -a codex`. Or copy the skill folder (ops/skillmgr-runs/in/input/library/api-docs-writer in zhuyansen/agent-skills-hub) 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 zhuyansen/agent-skills-hub --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?

SKILL.md names no scripts, command-line tools or credentials: API Docs Writer is instructions for the agent only.

Does API Docs Writer access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. 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 198 tokens (SKILL.md is roughly 792 characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Docs Writer?

Skills that share tags, products or a category with API Docs Writer: Diagram Design (cathrynlavery/diagram-design, 48k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k 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?

zhuyansen (a GitHub user) maintains it in zhuyansen/agent-skills-hub, which has 413 GitHub stars. The repository holds 21 skills in this directory. The repository was last updated on October 10, 2026.

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