# Api Documentation

> Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior.

- **Type:** Skill
- **Install:** `agentstack add skill-jakesterns-agent-skills-api-documentation`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [jakesterns](https://agentstack.voostack.com/s/jakesterns)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [jakesterns](https://github.com/jakesterns)
- **Source:** https://github.com/jakesterns/agent-skills/tree/main/skills/documentation/api-documentation

## Install

```sh
agentstack add skill-jakesterns-agent-skills-api-documentation
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

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

1. Identify the API surface: endpoints, methods, request bodies, response shapes, auth, errors, pagination, rate limits, and webhooks.
2. Document the user goal before implementation details.
3. Include accurate request and response examples with realistic values.
4. Explain authentication, permissions, idempotency, retries, errors, and compatibility behavior.
5. Check examples against code or schemas when possible.
6. Add migration notes or versioning behavior if the API changed.
7. 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](https://github.com/jakesterns)
- **Source:** [jakesterns/agent-skills](https://github.com/jakesterns/agent-skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-jakesterns-agent-skills-api-documentation
- Seller: https://agentstack.voostack.com/s/jakesterns
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.