How do I install the API Docs skill?

Run npx skillmds@latest add diegosouzapw/api-docs-2 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is API Docs safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: reads secrets. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Docs?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Docs free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Docs?

diegosouzapw (@diegosouzapw) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Docs by diegosouzapw — Agent Skill

Name: API Docs
Rating: 4.2 (5 reviews)
Author: diegosouzapw

File contents

STANDARD OPERATING PROCEDURE

Purpose

Ship accurate, consumable API docs with validated schemas, runnable examples, and clear auth/error guidance.

Trigger Conditions

Positive: REST/GraphQL doc creation or updates, versioned API rollouts, deprecation notices, interactive explorer setup.
Negative: Narrative/internal docs (route to documentation) or prompt-focused tasks (route to prompt-architect).

Guardrails

Structure-first: maintain examples/, tests/, resources/, references/ alongside SKILL.md.
Constraint extraction: capture HARD/SOFT/INFERRED constraints on audience, security posture, and versioning; confirm inferred.
Validation: run spec validators (OpenAPI/GraphQL), exercise examples, and note unrun commands.
Confidence ceilings: apply {inference/report:0.70, research:0.85, observation/definition:0.95} to all claims.
Safety: no secret exposure; redact internal endpoints when producing public docs.

Execution Phases

Scope & Sources
- Identify surfaces (REST/GraphQL), auth schemes, target audience, and supported versions.
- Gather schemas, code annotations, and existing references; log constraints.
Outline & Contracts
- Define required sections: overview, auth, endpoints/operations, errors, rate limits, changelog.
- Confirm INFERRED needs (SDK snippets, language coverage).
Author & Validate
- Draft OpenAPI/GraphQL artifacts; generate runnable examples in examples/.
- Validate specs (swagger-cli, graphql-schema-linter) and sample requests.
Publish & Harden
- Wire interactive explorer (Swagger UI/GraphQL Playground) if in scope.
- Add tests in tests/ (lint, link check, example execution) and store outputs in resources/.
Review & Deliver
- Summarize deltas, risks, and next steps; cite sources in references/.
- Provide confidence statement with ceiling.

Output Format

Scope summary + constraints (HARD/SOFT/INFERRED, confirmed).
Spec status and validation results.
Example calls and changelog notes.
Evidence with Confidence: X.XX (ceiling: TYPE Y.YY).

Validation Checklist

Audience and version coverage confirmed; inferred asks resolved.
Specs validated; examples executed or annotated as not run.
Auth, errors, and rate limits documented.
Tests present in tests/; artifacts stored in resources/; references recorded.
Confidence ceilings applied to claims and guidance.

MCP / Memory Tags

Namespace: skills/delivery/api-docs/{api}/{version}
Tags: WHO=api-docs-{session}, WHY=skill-execution, WHAT=spec+docs

Confidence: 0.70 (ceiling: inference 0.70) - SOP integrates skill-forge structure-first and prompt-architect constraint/ceiling rules.

---name: api-docs-2description: Generate, validate, and maintain API documentation (REST/OpenAPI and GraphQL) with reproducible structure and evidence-backed confidence.--- ## STANDARD OPERATING PROCEDURE ### Purpose Ship accurate, consumable API docs with validated schemas, runnable examples, and clear auth/error guidance. ### Trigger Conditions - **Positive:** REST/GraphQL doc creation or updates, versioned API rollouts, deprecation notices, interactive explorer setup. - **Negative:** Narrative/internal docs (route to `documentation`) or prompt-focused tasks (route to `prompt-architect`). ### Guardrails - **Structure-first:** maintain `examples/`, `tests/`, `resources/`, `references/` alongside `SKILL.md`. - **Constraint extraction:** capture HARD/SOFT/INFERRED constraints on audience, security posture, and versioning; confirm inferred. - **Validation:** run spec validators (OpenAPI/GraphQL), exercise examples, and note unrun commands. - **Confidence ceilings:** apply `{inference/report:0.70, research:0.85, observation/definition:0.95}` to all claims. - **Safety:** no secret exposure; redact internal endpoints when producing public docs. ### Execution Phases 1. **Scope & Sources** - Identify surfaces (REST/GraphQL), auth schemes, target audience, and supported versions. - Gather schemas, code annotations, and existing references; log constraints. 2. **Outline & Contracts** - Define required sections: overview, auth, endpoints/operations, errors, rate limits, changelog. - Confirm INFERRED needs (SDK snippets, language coverage). 3. **Author & Validate** - Draft OpenAPI/GraphQL artifacts; generate runnable examples in `examples/`. - Validate specs (swagger-cli, graphql-schema-linter) and sample requests. 4. **Publish & Harden** - Wire interactive explorer (Swagger UI/GraphQL Playground) if in scope. - Add tests in `tests/` (lint, link check, example execution) and store outputs in `resources/`. 5. **Review & Deliver** - Summarize deltas, risks, and next steps; cite sources in `references/`. - Provide confidence statement with ceiling. ### Output Format - Scope summary + constraints (HARD/SOFT/INFERRED, confirmed). - Spec status and validation results. - Example calls and changelog notes. - Evidence with **Confidence: X.XX (ceiling: TYPE Y.YY)**. ### Validation Checklist - [ ] Audience and version coverage confirmed; inferred asks resolved. - [ ] Specs validated; examples executed or annotated as not run. - [ ] Auth, errors, and rate limits documented. - [ ] Tests present in `tests/`; artifacts stored in `resources/`; references recorded. - [ ] Confidence ceilings applied to claims and guidance. ### MCP / Memory Tags - Namespace: `skills/delivery/api-docs/{api}/{version}` - Tags: `WHO=api-docs-{session}`, `WHY=skill-execution`, `WHAT=spec+docs` Confidence: 0.70 (ceiling: inference 0.70) - SOP integrates skill-forge structure-first and prompt-architect constraint/ceiling rules.

Frequently asked questions

API Docs