Agent skill

API Documentation

by revfactory in revfactory/claude-code-harness

Write accurate and complete library API documentation. An agent skill from revfactory/claude-code-harness.

No licenceAuto-check passedDevelopment

Install API Documentation

skills CLI
$ npx skills add revfactory/claude-code-harness --skill api-documentation -a claude-code

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

GitHub CLI
$ gh skill install revfactory/claude-code-harness api-documentation --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/revfactory/claude-code-harness.git skills-src && mkdir -p .claude/skills && cp -r skills-src/experiments/results/case-004/harness/.claude/skills/api-documentation .claude/skills/api-documentation && 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-documentation
GitHub stars
120
Token cost
~263 tokens
SKILL.md length
85 words
Files
2 (incl. references)
Skills in repo
15
Repo updated
First seen
Licence
None found

At a glance

Write accurate and complete library API documentation. An agent skill from revfactory/claude-code-harness.

  • Works in 6 steps: 소스 코드에서 모든 public 함수 시그니처 추출 → 각 함수의 파라미터 (필수/선택) 및 반환값 타입 확인 → 함수 문서 템플릿에 맞춰 작성 → …
  • Creating API docs
  • SKILL.md covers 문서 작성 워크플로우, 함수 문서 템플릿 and 정확성 체크리스트
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Documentation is an agent skill from revfactory/claude-code-harness. Write accurate and complete library API documentation. Use when creating API docs, README files, or function reference documentation. Ensures all signatures, parameters, return types, and examples are precise.

Its SKILL.md is about 260 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/format-tokens.md`).

It sits in Development, covering Technical documentation.

When your agent uses it

  • Creating API docs
  • Function reference documentation

Example prompts

  • “/api-documentation”

Workflow steps

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

  1. 소스 코드에서 모든 public 함수 시그니처 추출
  2. 각 함수의 파라미터 (필수/선택) 및 반환값 타입 확인
  3. 함수 문서 템플릿에 맞춰 작성
  4. format 토큰 등 열거형 값은 전수 나열
  5. 예제 코드는 실제 동작과 일치하도록 작성
  6. 정확성 체크리스트로 최종 검증

What it can do on your machine

Read from SKILL.md and the folder at commit 267005c. 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 (its code samples are markdown).

    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 Documentation loads about 263 tokens when it runs, and up to ~548 if it reads all its reference files. Until then it costs about 57 tokens; SKILL.md has 85 words of instructions outside code blocks.

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

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

Without a licence we can't republish the file, so here is its outline and opening line. It has 85 words (~263 tokens).

“상세 format 토큰 목록은 references/format-tokens.md 참조.”

— opening of SKILL.md by revfactory
name
api-documentation

Read the full SKILL.md on GitHub

Files

SKILL.md and 1 other file (references) in experiments/results/case-004/harness/.claude/skills/api-documentation of revfactory/claude-code-harness.

  • SKILL.md
  • references/format-tokens.md

Open the folder on GitHubat commit 267005c

Compare with similar skills

API Documentation 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 compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Documentation this skillrevfactory/claude-code-harness120—~263Automated safety check: PassNone
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.4kAutomated safety check: PassGPL-3.0

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.

    44k GitHub starsUsed in 1 repo~7.5k 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
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 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.4k 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 5 days ago
    DevelopmentAuto-check: notes

More from revfactory/claude-code-harness

All 15 skills in this repo
  • Microservice Patterns

    revfactory/claude-code-harness

    Event-driven microservice architecture patterns guide. An agent skill from revfactory/claude-code-harness.

    120 GitHub stars~502 tokensUpdated 7 mo ago
    Auto-check passed
  • Query Engine Design

    revfactory/claude-code-harness

    SQL query engine design and implementation guide. An agent skill from revfactory/claude-code-harness.

    120 GitHub stars~474 tokensUpdated 7 mo ago
    Auto-check passed
  • Crdt Algorithms

    revfactory/claude-code-harness

    CRDT-based real-time collaborative text editor implementation guide.

    120 GitHub stars~375 tokensUpdated 7 mo ago
    Auto-check passed
  • Express API Design

    revfactory/claude-code-harness

    Express.js REST API design and implementation guide. An agent skill from revfactory/claude-code-harness.

    120 GitHub stars~276 tokensUpdated 7 mo ago
    Auto-check passed
  • Interpreter Design

    revfactory/claude-code-harness

    Programming language interpreter design and implementation guide.

    120 GitHub stars~387 tokensUpdated 7 mo ago
    Auto-check passed
  • Static Site Generator

    revfactory/claude-code-harness

    Build a markdown-based static site generator with zero dependencies.

    120 GitHub stars~291 tokensUpdated 7 mo ago
    Auto-check passed

Categories

Questions about API Documentation

What does API Documentation do?

Write accurate and complete library API documentation. An agent skill from revfactory/claude-code-harness. API Documentation is an agent skill from revfactory/claude-code-harness. Write accurate and complete library API documentation.

When should I use API Documentation?

API Documentation fits situations like: creating API docs; function reference documentation.

How do I install API Documentation in Claude Code?

Run `npx skills add revfactory/claude-code-harness --skill api-documentation -a claude-code`. Or copy the skill folder (experiments/results/case-004/harness/.claude/skills/api-documentation in revfactory/claude-code-harness) into .claude/skills/api-documentation in your project. Claude Code loads it when a task matches its description.

How do I install API Documentation in Codex?

Run `npx skills add revfactory/claude-code-harness --skill api-documentation -a codex`. Or copy the skill folder (experiments/results/case-004/harness/.claude/skills/api-documentation in revfactory/claude-code-harness) into .agents/skills/api-documentation in your project. Codex loads it when a task matches its description.

Can I use API Documentation 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 revfactory/claude-code-harness --skill api-documentation -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-documentation, .gemini/skills/api-documentation, .github/skills/api-documentation and .opencode/skills/api-documentation in your project.

What does API Documentation need to run?

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

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

No licence was found for API Documentation or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does API Documentation use?

About 263 tokens (SKILL.md is roughly 1.1k 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 285 tokens, read only when the agent opens those files.

What are the alternatives to API Documentation?

Skills that share tags, products or a category with API Documentation: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Documentation?

revfactory (a GitHub user) maintains it in revfactory/claude-code-harness, which has 120 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on March 6, 2026.

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