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.
npx skills add zircote-plugins/documentation-review --skill api-documentationgit clone --depth 1 https://github.com/zircote-plugins/documentation-reviewWrote 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.
[](https://agentmods.dev/skills/zircote-plugins/documentation-review/api-documentation)<a href="https://agentmods.dev/skills/zircote-plugins/documentation-review/api-documentation"><img src="https://agentmods.dev/badge/skills/zircote-plugins/documentation-review/api-documentation/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/zircote-plugins/documentation-review/api-documentation"><img src="https://agentmods.dev/badge/skills/zircote-plugins/documentation-review/api-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00163 | $0.02519 |
| Opus 5.5 | $0.00065 | $0.01008 |
| Sonnet 5.5 | $0.00033 | $0.00504 |
| Haiku 4.5 | $0.00016 | $0.00252 |
Grade A, and why
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 1mo 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.
How it starts
The opening of the file, as written. The whole thing — 311 lines — stays where its author put it; the contents beside it link to each section on GitHub.
API Documentation
API documentation is the contract between your service and its consumers. Incomplete or inaccurate API docs cause integration failures, support tickets, and abandoned adoption. This skill covers REST (OpenAPI), event-driven (AsyncAPI), and language-native API documentation patterns.
Review Workflow
When reviewing existing API documentation, follow this sequence:
- Inventory endpoints — scan route handlers/controllers and cross-reference against the spec's
paths. Missing endpoints are the most common defect. - Check required elements — for each endpoint, verify all 7 elements below (summary, description, parameters, request body, responses, examples, auth).
- Validate examples — request/response examples should be valid JSON matching the declared schemas. Invalid examples break SDK generators and mislead consumers.
- Audit error responses — every endpoint should document at least 400, 404 (for resource endpoints), and 500 responses. Missing error docs force consumers to discover failures at runtime.
- Verify authentication — security schemes should be defined in
components/securitySchemesand applied globally or per-endpoint. - Check the quality checklist at the end of this document for a final pass.
Quick Reference
For copy-paste endpoint templates, see references/endpoint-templates.md. For advanced OpenAPI patterns (discriminators, webhooks, callbacks), see references/openapi-patterns.md. For complete working specs, see examples/petstore-openapi.yaml and examples/events-asyncapi.yaml.
OpenAPI/Swagger Overview
OpenAPI Specification (OAS) is the standard for describing REST APIs. Use it for:
- Auto-generating documentation portals
- Client SDK generation
- API testing and validation
- Contract-first development
Supported Versions
- OpenAPI 3.1 - Current standard, JSON Schema compatible
- OpenAPI 3.0 - Widely supported, stable
- Swagger 2.0 - Legacy, migrate when feasible since tooling is converging on 3.x
What ships with it
5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
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.
- 1mo ago First seen · 311 lines · 163 tokens per session scan A 9c7f1f605a26
api-documentation is a skill published in the GitHub repository zircote-plugins/documentation-review (5 stars, last pushed 4mo ago), licensed MIT. It adds 163 tokens to every session and 2,519 once invoked, about $0.0007 per session on Opus 5.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.
Other skills, from other repositories
API Documentation Generator
AI-powered API documentation generation tool that auto-generates comprehensive API docs from source code, including OpenAPI/Swagger specs, Postman collections, and markdown documentation with examples and authentication details.
docpull-research
Use the docpull MCP tools (listindexed, ensuredocs, grepdocs, readdoc, fetchurl) to ground answers in real web/source material when the user asks about a specific library, framework, API, vendor, product page, website, or public source URL. Activate on questions like "how do I X in [library]", "what's the API for…
documentator-api-docs
Build, change, diagnose, or verify Laravel API endpoints documented by tsitsishvili/documentator. Use for routes, controllers, closures, FormRequests, inline validation, API Resources, Eloquent models, Spatie Data, Laravel Actions, HTTP QUERY operations, callbacks, webhooks, streaming responses, recorded examples…
api-documentation-v2
API Documentation Workflow workflow skill. Use this skill when the user needs API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation and the operator should preserve the upstream workflow, copied support files, and provenance before merging…
documentation-standards
Use when writing README files, API documentation, user guides, or technical documentation following industry standards from Google, Microsoft, and GitLab style guides.
documentation-writer
Write clear, scannable documentation with a research-first, phase-separated workflow. Pick one Diátaxis mode, then apply STE and Global English. Apply when the user asks for documentation, READMEs, doc sites, API reference, migration guides, or technical markdown. Use marketing-psychology for marketing copy. Use…