Agent skill

API Documentation Generator

by luongnv89 in luongnv89/claude-howto

“Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs…”

— description from SKILL.md by luongnv89
MITAuto-check passedDevelopment

Install API Documentation Generator

skills CLI
$ npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code

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

GitHub CLI
$ gh skill install luongnv89/claude-howto doc-generator --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/luongnv89/claude-howto.git skills-src && mkdir -p .claude/skills && cp -r skills-src/03-skills/doc-generator .claude/skills/doc-generator && 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
doc-generator
GitHub stars
42k
Token cost
~429 tokens
SKILL.md length
56 words
Files
2
Skills in repo
25
Repo updated
First seen
Licence
MIT

At a glance

  • SKILL.md covers Generates and Documentation Structure
  • Runs Python scripts from its folder

About this skill

“Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.”

— description from SKILL.md by luongnv89

API Documentation Generator is a skill in luongnv89/claude-howto (42k stars). Its SKILL.md is about 429 tokens, with 1 other file in the folder. Licence: MIT.

What it can do on your machine

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

    Ships script files (Python), which the agent can run.

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

  • Network

    Links to these hosts (documentation or services it may open):

    • code.claude.com

    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 Documentation Generator loads about 429 tokens when it runs. Until then it costs about 55 tokens; SKILL.md has 56 words of instructions outside code blocks.

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

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 luongnv89/claude-howto at commit 556af8d, republished under its MIT licence (© luongnv89). 56 words, ~429 tokens.

Download SKILL.mdSave it as .claude/skills/doc-generator/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
doc-generator
description
Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.

API Documentation Generator Skill

Generates

  • OpenAPI/Swagger specifications
  • API endpoint documentation
  • SDK usage examples
  • Integration guides
  • Error code references
  • Authentication guides

Documentation Structure

For Each Endpoint
markdown
## GET /api/v1/users/:id

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

**200 Success**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}
```

**404 Not Found**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}
```

### Examples

**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```

**Python**
```python
response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()
```

Last Updated: August 4, 2026 Claude Code Version: 2.1.220 Sources:

© luongnv89, 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 1 other file in 03-skills/doc-generator of luongnv89/claude-howto.

  • SKILL.md
  • generate-docs.py

Open the folder on GitHubat commit 556af8d

Compare with similar skills

API Documentation Generator 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 Documentation Generator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Documentation Generator this skillluongnv89/claude-howto42k—~429Automated safety check: PassMIT
Agentic Workflows API Documentation Lungoagntcy/coffeeAgntcy112—~2.6kAutomated safety check: PassApache-2.0
OpenAPI Spec Generationwshobson/agents40k10 repos~511Automated safety check: PassMIT
Docs Interfacesjh941213/my-cc-harness126—~863Automated safety check: NotesNone
API DesignMadAppGang/claude-code284—~1.7kAutomated safety check: PassMIT
API Design Assistantmajiayu000/claude-skill-registry6661 repos~2.7kAutomated safety check: PassMIT

Similar skills

  • Authors and maintains the human-facing Agentic Workflows API documentation for the lungo subproject at coffeeAGNTCY/coffeeagents/lungo/docs/workflow-instanceapi.md.

    112 GitHub stars~2.6k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • 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 10 repos~511 tokens
    Backend & APIsAuto-check passed
  • Docs Interfaces

    jh941213/my-cc-harness

    Generate interface/API docs — OpenAPI 3.1/AsyncAPI 3.0 specs, API topology diagrams, interface flow (sequence) diagrams, API changelog.

    126 GitHub stars~863 tokensUpdated 2 mo ago
    Backend & APIsAuto-check: notes
  • API Design

    MadAppGang/claude-code

    A skill your agent uses when designing REST or GraphQL APIs, defining endpoints, implementing pagination/filtering, handling API versioning, or establishing API documentation with OpenAPI/Swagger.

    284 GitHub stars~1.7k tokensUpdated 6 mo ago
    Backend & APIsAuto-check passed
  • API Design Assistant

    majiayu000/claude-skill-registry

    Design and review APIs with suggestions for endpoints, parameters, return types, and best practices.

    666 GitHub starsUsed in 1 repo~2.7k tokens
    Backend & APIsAuto-check passed
  • Nacos API Doc Update

    nacos-group/nacos-group.github.io

    Updates Nacos API documentation from Swagger api.json. An agent skill from nacos-group/nacos-group.github.io.

    115 GitHub stars~3.3k tokensUpdated 14 days ago
    DevelopmentAuto-check passed

More from luongnv89/claude-howto

All 25 skills in this repo
  • Systematic Code Refactoring

    luongnv89/claude-howto

    Guides refactoring in phases based on Martin Fowler's method: research, test coverage check, planning and small tested steps, with your approval at each phase.

    42k GitHub stars~3k tokensUpdated 8 days ago
    Auto-check passed
  • Code Refactoring Workflow

    luongnv89/claude-howto

    Guides systematic, test-backed refactoring in the style of Martin Fowler, moving through research, planning and small incremental changes with your approval at each phase.

    42k GitHub stars~3.1k tokensUpdated 8 days ago
    Auto-check passed
  • Blog Post Drafting

    luongnv89/claude-howto

    Guides drafting a blog post from an idea and optional source material: research, brainstorming, outlining and version-tracked drafts, with user approval at each step.

    42k GitHub stars~2.1k tokensUpdated 8 days ago
    Auto-check passed
  • Brand Voice Guide

    luongnv89/claude-howto

    Ensure all communication matches brand voice and tone guidelines. Use when creating marketing copy, customer communications, public-facing content, or when…

    42k GitHub stars~609 tokensUpdated 8 days ago
    Auto-check passed
  • Code Review Specialist

    luongnv89/claude-howto

    Reviews code for security, performance, quality and maintainability, using a checklist, a finding template and two metrics scripts.

    42k GitHub stars~764 tokensUpdated 8 days ago
    Auto-check passed
  • Claude Code Skill Assessment

    luongnv89/claude-howto

    Runs a quick or deep quiz on Claude Code skills, scores ten feature areas and generates a personalized learning path with prioritized next steps.

    42k GitHub stars~5.5k tokensUpdated 8 days ago
    Auto-check passed

Works with

Questions about API Documentation Generator

How do I install API Documentation Generator in Claude Code?

Run `npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code`. Or copy the skill folder (03-skills/doc-generator in luongnv89/claude-howto) into .claude/skills/doc-generator in your project. Claude Code loads it when a task matches its description.

How do I install API Documentation Generator in Codex?

Run `npx skills add luongnv89/claude-howto --skill doc-generator -a codex`. Or copy the skill folder (03-skills/doc-generator in luongnv89/claude-howto) into .agents/skills/doc-generator in your project. Codex loads it when a task matches its description.

Can I use API Documentation Generator 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 luongnv89/claude-howto --skill doc-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-generator, .gemini/skills/doc-generator, .github/skills/doc-generator and .opencode/skills/doc-generator in your project.

What does API Documentation Generator need to run?

Going by SKILL.md and its folder, API Documentation Generator needs Python for the scripts in its folder.

Does API Documentation Generator access the network?

SKILL.md names 1 domain. As links in the text: code.claude.com. This is read from the text; nothing was executed.

Is API Documentation Generator 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 Documentation Generator use?

API Documentation Generator 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 Documentation Generator use?

About 429 tokens (SKILL.md is roughly 1.7k 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 Documentation Generator?

Skills that share tags, products or a category with API Documentation Generator: Agentic Workflows API Documentation Lungo (agntcy/coffeeAgntcy, 112 stars), OpenAPI Spec Generation (wshobson/agents, 40k stars), Docs Interfaces (jh941213/my-cc-harness, 126 stars) and API Design (MadAppGang/claude-code, 284 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Documentation Generator?

luongnv89 (a GitHub user) maintains it in luongnv89/claude-howto, which has 41,769 GitHub stars. The repository holds 25 skills in this directory. The repository was last updated on September 30, 2026.

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