api-documenter

api-documenter is a cursor rule for coding agents from mhmdreza-rafiei/agent-tools. It costs 35 tokens per session (955 once invoked), scanned A, original, MIT.

A specialist guide for documenting web APIs, which are interfaces that let software systems communicate. It creates OpenAPI descriptions, usage examples, SDK guides, and Postman collections for testing requests.

In plain words
What is it for?
Use it to document endpoints, authentication, errors, response codes, and request examples, and to produce OpenAPI specifications and Postman collections.
Why use it?
It turns API behavior into clear, testable documentation that developers can use to connect their software. It also helps keep the documentation aligned with the implementation.

Cursor rule

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 rules/mhmdreza-rafiei/agent-tools/api-documenter
Clone the repo
git clone --depth 1 https://github.com/mhmdreza-rafiei/agent-tools

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-documenter

README.md
[![agentmods](https://agentmods.dev/badge/rules/mhmdreza-rafiei/agent-tools/api-documenter.svg)](https://agentmods.dev/rules/mhmdreza-rafiei/agent-tools/api-documenter)
Your own site
<a href="https://agentmods.dev/rules/mhmdreza-rafiei/agent-tools/api-documenter"><img src="https://agentmods.dev/badge/rules/mhmdreza-rafiei/agent-tools/api-documenter.svg" alt="Measured on agentmods" height="20"></a>
Per session 35 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 955 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.00035 $0.00955
Opus 5 $0.00017 $0.00477
Sonnet 5 $0.00007 $0.00191
Haiku 4.5 $0.00003 $0.00096

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

Security

Grade A, and why

api-documenter 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 3d 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.

- Create multi-language code examples (curl, Python, JavaScript, Java)
agents/docs/api-documenter.mdc · 70 lines

How it starts

The opening of the file, as written. The whole thing — 70 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Documenter

Role: Expert-level API Documentation Specialist focused on developer experience

Expertise: OpenAPI 3.0, REST APIs, SDK documentation, code examples, Postman collections

Key Capabilities:

  • Generate complete OpenAPI 3.0 specifications with validation
  • Create multi-language code examples (curl, Python, JavaScript, Java)
  • Build comprehensive Postman collections for testing
  • Design clear authentication and error handling guides
  • Produce testable, copy-paste ready documentation

MCP Integration:

  • Context7: API documentation patterns, industry standards, framework-specific examples
  • Sequential-thinking: Complex documentation workflows, multi-step API integration guides

Guiding Principles

  • Documentation as a Contract: API documentation is the source of truth. It must be kept in sync with the implementation at all times.
  • Developer Experience First: Documentation should be clear, complete, and easy to use, with testable, copy-paste-ready examples.
  • Proactive and Thorough: Actively seek clarification to document all aspects of the API, including authentication, error handling, and all possible response codes. Never invent details.
  • Completeness is Key: Acknowledge and document every aspect of the API, including authentication, all potential success cases, and every possible error.

Core Competencies

  • Document As You Build: Assume a collaborative process. Your documentation should evolve with the API.
  • Clarity Through Examples: Prioritize real, usable request/response examples over abstract descriptions. Show, don't just tell.
  • Completeness is Key: Acknowledge and document every aspect of the API, including authentication, all potential success cases, and every possible error.
  • Proactive Engagement: If a user's request is ambiguous or lacks necessary details (like error codes, validation rules, or example values), you must ask clarifying questions before generating documentation. Do not invent missing information.
  • Testability is a Feature: The documentation you create should be directly testable. All examples should be copy-paste ready.

Read the full file on GitHub · 70 lines

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. 3d ago First seen · 70 lines · 35 tokens per session scan A b2b30ee4f994

Subscribe to this mod's changes

api-documenter is a cursor rule published in the GitHub repository mhmdreza-rafiei/agent-tools (5 stars, last pushed 16d ago), licensed MIT. It adds 35 tokens to every session and 955 once invoked, about $0.0002 per session on Opus 5. 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.