document-api

A command that creates documentation for web APIs and internal services. An API is a defined way for software systems to request data or actions from one another.

In plain words
What is it for?
Use it to produce OpenAPI or Swagger files, Markdown documentation, and JSDoc or TSDoc comments for API endpoints and internal functions.
Why use it?
It makes endpoints, authentication, inputs, outputs, errors, limits, and version changes easier for developers to understand and use correctly.

Command for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/thelobbi/claude/document-api
Clone the repo
git clone --depth 1 https://github.com/TheLobbi/claude

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 446 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00446
Opus 5 $0.00000 $0.00223
Sonnet 5 $0.00000 $0.00089
Haiku 4.5 $0.00000 $0.00045

Measured 2d ago against content hash f3d6d70d58bb, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

document-api scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

Include code examples in multiple languages/frameworks where relevant (curl, JavaScript, Python, etc.).
.claude/commands/document-api.md · 71 lines

What it actually says

API Documentation Generation

Generate comprehensive API documentation for all endpoints and services:

Documentation Requirements

For Each API Endpoint:

  1. Endpoint Details

    • HTTP Method (GET, POST, PUT, DELETE, PATCH)
    • URL path with parameters
    • Description and purpose
  2. Authentication

    • Required authentication method
    • Required permissions/roles
    • API key or token requirements
  3. Request

    • Headers (Content-Type, Authorization, etc.)
    • Path parameters
    • Query parameters
    • Request body schema with types
    • Example request
  4. Response

    • Success status codes (200, 201, 204)
    • Response body schema with types
    • Example successful response
    • Error status codes (400, 401, 403, 404, 500)
    • Error response format
    • Example error responses
  5. Additional Information

    • Rate limiting
    • Pagination (if applicable)
    • Sorting and filtering options
    • Versioning information
    • Deprecation warnings

Documentation Format

Generate documentation in:

  • OpenAPI/Swagger specification (YAML or JSON)
  • Markdown for README/docs folder
  • JSDoc/TSDoc inline comments for code

Service Documentation

For internal services and functions:

  • Purpose and functionality
  • Input parameters with types
  • Return values with types
  • Side effects
  • Example usage
  • Related functions/services

Output Structure

``` docs/ ├── api/ │ ├── openapi.yaml # OpenAPI specification │ ├── authentication.md # Auth guide │ ├── endpoints/ │ │ ├── users.md │ │ ├── products.md │ │ └── orders.md │ └── examples/ # Request/response examples └── services/ └── internal-apis.md # Internal service docs ```

Include code examples in multiple languages/frameworks where relevant (curl, JavaScript, Python, etc.).

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 71 lines · 0 tokens per session scan A f3d6d70d58bb

Subscribe to this mod's changes

document-api is a command published in the GitHub repository TheLobbi/claude (21 stars, last pushed 5d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 446 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.