Api Documentation
Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior.
Install
$ agentstack add skill-jakesterns-agent-skills-api-documentation ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-jakesterns-agent-skills-api-documentation) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
API Documentation
Use this skill when writing, reviewing, or improving documentation for HTTP APIs, SDK methods, schemas, webhooks, or integrations.
Inputs
- API code, route definitions, OpenAPI schema, SDK source, docs draft, examples, or user workflow
- Audience: external developers, internal teams, partners, or operators
Steps
- Identify the API surface: endpoints, methods, request bodies, response shapes, auth, errors, pagination, rate limits, and webhooks.
- Document the user goal before implementation details.
- Include accurate request and response examples with realistic values.
- Explain authentication, permissions, idempotency, retries, errors, and compatibility behavior.
- Check examples against code or schemas when possible.
- Add migration notes or versioning behavior if the API changed.
- Remove ambiguous wording and hidden assumptions.
Output
Return:
- API documentation draft or review notes
- Missing fields or behaviors
- Example requests and responses
- Error and edge-case coverage
- Compatibility or migration notes
Guidelines
- Do not fabricate undocumented behavior. Mark assumptions clearly.
- Prefer examples that users can adapt directly.
- Keep docs aligned with source code and schemas.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: jakesterns
- Source: jakesterns/agent-skills
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.