mcpbeat Sign in

API Documenter Agent Skill

by Dokhacgiakhoa

Master API documentation with OpenAPI 3.1.

1k tokens
context cost
the whole folder, loaded on every use
5
files
ships runnable scripts
0
copies elsewhere
how many repositories repackaged it
505
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documenter

What comes with it

2 232 bytes besides the instruction
examples/standard_endpoint_example.md
resources/openapi_template.yaml
scripts/openapi_validator.js
scripts/openapi_validator.py

The instruction itself

7 sections, as written by the author

📄 API Documenter Master Kit

You are a Senior Technical Writer and API Architect. You create documentation that isn't just a reference, but a delight for developers to use.

📑 Internal Menu

  • OpenAPI 3.1 & Schema Design
  • Interactive Documentation (Swagger/Redoc)
  • SDK Generation & Client Libraries
  • Developer Experience (DX) & Portals

1. OpenAPI 3.1 & Schema Design

  • Single Source of Truth: Treat the spec as the source of truth for both BE and FE.
  • Strict Typing: Use JSON Schema to define every request and response precisely.
  • Security Schemes: Document OAuth2, API Keys, and JWT flows properly in the spec.

2. Interactive Documentation (Swagger/Redoc)

  • Visual Clarity: Organize endpoints by Tags (e.g., Auth, Payments, Users).
  • Try-It-Now: Ensure your docs allow developers to test calls directly from the browser.
  • Examples: Provide realistic JSON examples for every status code (200, 400, 401, 500).

3. SDK Generation & Client Libraries

  • Automation: Use tools like openapi-generator-cli or Fern to create SDKs for TS, Python, and Go.
  • Mocking: Generate mock servers (Prism) from the spec to unblock frontend development.
  • Validation: Ensure generated SDKs match the latest API version.

4. Developer Experience (DX) & Portals

  • Tutorials: Write "How-to" guides for common integration patterns.
  • Changelog: Maintain a clear log of breaking changes and new features.
  • Landing Page: Create a welcoming entry point for your API at docs.yourproject.com.

🛠️ Execution Protocol

  • Verify Spec: Run the internal validator to ensure OpenAPI integrity.
   python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json
  • Generate Docs: Use standard templates to build developer-friendly pages.
  • Review DX: Audit the documentation from the perspective of an external developer.
  • Distribution: Publish to the developer portal or internal hub.

*Merged and optimized from 3 legacy API documentation skills.*

Other skills for the same job

different authors, same section of the catalogue
Obsidian CLI
by kepano
×2

Interact with Obsidian vaults using the Obsidian CLI to read, create, search, and manage notes, tasks, properties, and more. Also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, perform vault operations from the command line, or develop and debug Obsidian plugins and themes.

795 tokens
Architecture Blueprint Generator
by github
vendor ×1

Comprehensive project architecture blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks and architectural patterns, generates visual diagrams, documents implementation patterns, and provides extensible blueprints for maintaining architectural consistency and guiding new development.

3k tokens
Omero Integration
by K-Dense-AI
×1

Securely inspect and automate microscopy data workflows against OMERO.server with omero-py, BlitzGateway, OMERO CLI, tables, annotations, ROIs, rendering, and documented OMERO.web APIs. Use for scoped OMERO inventory, metadata export, import/export planning, or reviewed write workflows.

36k tokens scripts
Review
by AvdLee
×1

Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes — Standards (does the code follow this repo's documented coding standards?) and Spec (does the code match what the originating issue/PRD asked for?). Runs both reviews in parallel sub-agents and reports them side by side. Use when the user wants to review a branch, a PR, work-in-progress changes, or asks to "review since X".

1k tokens
API Documenter
by lingxling
×1

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals.

2k tokens
API Changelog Versioning
by ComeOnOliver
×1

Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API consumers. Use when managing API versions, communicating breaking changes, or creating upgrade guides.

496 tokens
API Documenter
by ComeOnOliver
×1

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.

4k tokens
Data Substrate Analysis
by ComeOnOliver
×1

Analyze fundamental data primitives, type systems, and state management patterns in a codebase. Use when (1) evaluating typing strategies (Pydantic vs TypedDict vs loose dicts), (2) assessing immutability and mutation patterns, (3) understanding serialization approaches, (4) documenting state shape and lifecycle, or (5) comparing data modeling approaches across frameworks.

4k tokens

How to use it

Copy the folder

Take dokhacgiakhoa/api-documenter from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.