api-docs

api-docs is a skill for Cursor from girijashankarj/cursor-handbook. It costs 21 tokens per session (557 once invoked), scanned A, original, MIT.

A workflow for documenting API endpoints, the URLs and operations that software exposes to other programs. It can organize request and response details into an OpenAPI specification and interactive documentation.

In plain words
What is it for?
Use it to inventory endpoints, describe parameters and schemas, document success and error responses, create OpenAPI definitions, and publish browsable API docs.
Why use it?
It gives developers a reliable reference for authentication, inputs, outputs, errors, and rate limits. Accurate examples reduce integration mistakes between services and clients.

Skill for Cursor

Written for Cursor: installed under .cursor/.

Good fit Use it to inventory endpoints, describe parameters and schemas, document success and error responses, create OpenAPI definitions, and publish browsable API docs.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/girijashankarj/cursor-handbook/api-docs
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.

Any agent
npx skills add girijashankarj/cursor-handbook --skill api-docs
Clone the repo
git clone --depth 1 https://github.com/girijashankarj/cursor-handbook

Made for: Cursor.

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-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/girijashankarj/cursor-handbook/api-docs.svg)](https://agentmods.dev/skills/girijashankarj/cursor-handbook/api-docs)
Your own site
<a href="https://agentmods.dev/skills/girijashankarj/cursor-handbook/api-docs"><img src="https://agentmods.dev/badge/skills/girijashankarj/cursor-handbook/api-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 557 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00021 $0.00557
Opus 5 $0.00010 $0.00279
Sonnet 5 $0.00004 $0.00111
Haiku 4.5 $0.00002 $0.00056

Measured 3d ago against content hash 6899e764e5f7, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

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 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.

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/skills/documentation/api-docs/SKILL.md · 65 lines

How it starts

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

Skill: Create API Documentation

Trigger

When the user needs to document API endpoints.

Prerequisites

  • API endpoints exist or are designed
  • OpenAPI/Swagger tooling available (optional)
  • Access to route definitions or handler files

Steps

Step 1: Inventory Endpoints

  • List all API endpoints
  • Group by resource/entity
  • Note HTTP method and path for each

Step 2: Document Each Endpoint

For each endpoint:

  • HTTP method and URL
  • Description and purpose
  • Authentication requirements
  • Request parameters (path, query, header)
  • Request body schema
  • Response schemas (success + errors)
  • Example request and response
  • Rate limiting details

Step 3: Create OpenAPI Spec

  • Define info, servers, security schemes
  • Create component schemas (reusable)
  • Define paths with all operations
  • Add examples for all schemas
  • Validate spec

Step 4: Generate Documentation

  • Use Swagger UI or Redoc for interactive docs
  • Host at /api/docs or similar
  • Include in CI/CD for auto-updates

Step 5: Review

  • All endpoints documented
  • Examples are accurate and working
  • Error responses documented
  • Authentication flow documented

Completion Checklist

  • All endpoints have method, URL, params, body, response
  • Error responses (4xx, 5xx) documented
  • Examples validated against live API or schema
  • OpenAPI spec validates (if used)

If Step Fails

  • Step 1 (inventory): Search for route definitions: **/*.route*.ts, **/routes/**, app.get|post|put|delete
  • Step 3 (OpenAPI): Use minimal spec first; add complexity incrementally. Validate with swagger-cli validate
  • Step 4 (generate): Swagger UI needs valid spec; Redoc is more forgiving. Check CORS if hosted separately

Example

Step 2 for POST /api/v1/orders: Method POST, URL /api/v1/orders, Body { customerId, items: [{ productId, quantity }] }, Response 201 { data: { id, status } }, Errors 400 validation, 404 customer not found.

Read the full file on GitHub · 65 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 · 65 lines · 21 tokens per session scan A 6899e764e5f7

Subscribe to this mod's changes

api-docs is a skill published in the GitHub repository girijashankarj/cursor-handbook (30 stars, last pushed 7d ago), licensed MIT. It adds 21 tokens to every session and 557 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-09-03.