generate-api-docs

A code-based workflow for writing API documentation, which explains how software endpoints can be used by other programs.

In plain words
What is it for?
It helps inspect code, document its API endpoints, check the details against the implementation, and report what was produced.
Why use it?
It keeps the reference tied to endpoints that actually exist, avoiding misleading details and accidental exposure of secrets in examples.

Command for Cursor

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/emaraschio/cursor-commands/generate-api-docs
Clone the repo
git clone --depth 1 https://github.com/emaraschio/cursor-commands

Made for: Cursor.

Per session 10 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 382 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. 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.00010 $0.00382
Opus 5 $0.00005 $0.00191
Sonnet 5 $0.00002 $0.00076
Haiku 4.5 $0.00001 $0.00038

Measured 2d ago against content hash b84502aa3edb, 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-docs 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.

.cursor/commands/generate-api-docs.md · 38 lines

What it actually says

Overview

Generate API documentation from code. Full workflow: .cursor/skill-contracts/generate-api-docs/SKILL.md (user install: ~/.cursor/skill-contracts/generate-api-docs/SKILL.md).

Defaults

None. See skill for workflow defaults.

Steps

  1. Read .cursor/skill-contracts/generate-api-docs/SKILL.md for the full agent contract; if that file is missing, read ~/.cursor/skill-contracts/generate-api-docs/SKILL.md.
  2. Execute the workflow in order; do not skip safety steps.
  3. Report outcomes per skill (summary, tables, or checklist as specified).

Anti-patterns

  • Document only endpoints that exist in code. Trigger: writing the API reference. Wrong: inventing endpoints, parameters, or responses not present in the source. Correct: document only endpoints found in the code and verify each against the implementation. Reason: invented endpoints mislead consumers and break integrations.
  • Never expose secrets in examples. Trigger: writing example requests and responses. Wrong: pasting real tokens, keys, or credentials into samples. Correct: use placeholder values for any secret in examples. Reason: committed secrets leak credentials and force rotation.

Examples

  • /generate-api-docs

Maintainers

Behavioral eval: .cursor/skill-contracts/generate-api-docs/eval/cases.md. Ship gate sections: A before changing SKILL.md or this command.

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 · 38 lines · 10 tokens per session scan A b84502aa3edb

Subscribe to this mod's changes

generate-api-docs is a command published in the GitHub repository emaraschio/cursor-commands (9 stars, last pushed 25d ago), licensed MIT. It adds 10 tokens to every session and 382 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.