Generate API Documentation

A command that creates Markdown documentation from source code for an API. An API is an interface that lets software systems communicate through defined requests and responses.

In plain words
What is it for?
Use it to document API endpoints by module, including request and response formats, error information, and usage examples.
Why use it?
It turns scattered endpoint details, signatures, schemas, errors, and examples into one organised reference.

Command

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/leihuang830102-hash/opencode-howto/generate-api-docs
Clone the repo
git clone --depth 1 https://github.com/leihuang830102-hash/Opencode-Howto
Per session 11 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 81 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod 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.00011 $0.00081
Opus 5 $0.00005 $0.00041
Sonnet 5 $0.00002 $0.00016
Haiku 4.5 $0.00001 $0.00008

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

Security

Grade A, and why

Generate API Documentation scanned grade A with 0 findings 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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to Generate API Documentation — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

07-plugins/documentation/commands/generate-api-docs.md · 14 lines

What it actually says

API Documentation Generator / API 文档生成

  1. 扫描 API endpoints
  2. 提取函数签名和注释
  3. 按模块整理
  4. 生成 Markdown 文档
  5. 补 request / response schema
  6. 补错误说明和示例
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 · 14 lines · 11 tokens per session scan A 615b2e57a1f0

Subscribe to this mod's changes

Generate API Documentation is a command published in the GitHub repository leihuang830102-hash/Opencode-Howto (5 stars, last pushed 4mo ago), licensed MIT. It adds 11 tokens to every session and 81 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to Generate API Documentation, differing in 0 lines, and is treated as a copy.