agentsclimarketplace
Sign in

Api documentation

Skill jakesterns/agent-skills/skills/documentation/api-documentation

Creates or reviews API documentation for endpoints, SDKs, schemas, examples, errors, authentication, and compatibility behavior.From its SKILL.md

Install
npx -y skills add jakesterns/agent-skills --skill api-documentation

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.6 KB, as published. Nobody here has run it

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.

Keep looking

Skills are one crate of 626,194. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.