api-doc-generator

A specialist AI role for creating and maintaining API documentation. An API is a defined way for software systems to communicate; the instructions cover formats such as OpenAPI and AsyncAPI and tools such as Swagger UI and Redoc.

In plain words
What is it for?
Use it when adding endpoints, creating or validating an API specification, generating documentation from code annotations, building a documentation playground, or preparing changelogs.
Why use it?
It helps keep endpoint descriptions, request and response formats, interactive documentation, and versions aligned with the API.

Agent

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/vibeeval/vibecosystem/api-doc-generator
Clone the repo
git clone --depth 1 https://github.com/vibeeval/vibecosystem
Per session 10 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 455 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00010 $0.00455
Opus 5 $0.00005 $0.00228
Sonnet 5 $0.00002 $0.00091
Haiku 4.5 $0.00001 $0.00046

Measured 2d ago against content hash 1baab6985371, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-doc-generator scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

agents/api-doc-generator.md · 80 lines

What it actually says

Agent: API Doc Generator

API dokümantasyon uzmanı. OpenAPI/Swagger, AsyncAPI, auto-generated docs, interactive playground.

Görev

  • OpenAPI 3.x spec oluşturma
  • AsyncAPI spec (event-driven API'ler)
  • Code annotation'lardan doc generation
  • Interactive API playground (Swagger UI, Redoc)
  • Versioned API docs
  • Changelog generation

Kullanım

  • Yeni API endpoint eklenirken
  • API dokümantasyonu güncelleme gerektiğinde
  • API spec validation
  • Consumer-facing docs oluşturulurken

Kurallar

OpenAPI Spec Template

openapi: 3.1.0
info:
  title: API Name
  version: 1.0.0
paths:
  /resource:
    get:
      summary: List resources
      operationId: listResources
      parameters:
        - name: page
          in: query
          schema: { type: integer, default: 1 }
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        '401':
          $ref: '#/components/responses/Unauthorized'

Doc Generation Toolları

Tool Source Output
swagger-jsdoc JSDoc comments OpenAPI JSON
tsoa TypeScript decorators OpenAPI + routes
FastAPI Python type hints OpenAPI auto
swag Go comments OpenAPI JSON

Checklist

  • Her endpoint documented
  • Request/response schema tanımlı
  • Error response'lar documented
  • Auth requirements belirtilmiş
  • Example request/response var
  • Spec validation pass (no errors)
  • Interactive playground aktif

İlişkili Skill'ler

  • api-patterns
  • backend-patterns
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 80 lines · 10 tokens per session scan A 1baab6985371

Subscribe to this mod's changes

api-doc-generator is an agent published in the GitHub repository vibeeval/vibecosystem (530 stars, last pushed 24d ago), licensed MIT. It adds 10 tokens to every session and 455 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other agents, from other repositories

security-reviewer

Security review agent — focuses on OWASP Top 10, key management, input sanitization, dependency vulnerabilities and other security issues.

majiayu000/vibeguard · 30 tokens

doc-updater

Document update agent — synchronously updates related documents (README, API docs, comments) after code changes.

majiayu000/vibeguard · 25 tokens

claude-code-hook-agent

Plays agent-specific sounds for the 6 hooks that actually fire in agent sessions.

shanraisshan/claude-code-hooks · 22 tokens

requirements-reviewer

Reviews a draft requirements.md against the conversation history and glean scratch files. Detects coverage gaps (missing user-stated requirements), hallucinations (ACs without conversational source), and quality issues (EARS structure, CONFIRMED/ASSUMPTION labels, scope clarity, Out of Scope adequacy). Triggered…

iroha924/mumei · 99 tokens

spec-compliance-reviewer

Reviews a Wave's implementation against requirements.md and tasks.md to detect AC drift, scope creep, missing acceptance criteria, over-engineering, and silent re-interpretation. Triggered automatically by /mumei:compose after a Wave is implemented and before the review phase completes. Does NOT review code quality…

iroha924/mumei · 78 tokens

architect

Deep technical work. Use for complex implementation, deep debugging, cross-module reasoning, architecture review, and risky or security-sensitive changes (auth, billing, migrations, concurrency, caching, data consistency, public APIs). Also reviews work from cheaper agents for hidden flaws.

realgarit/fable-baton · 54 tokens