api-doc-generator

api-doc-generator is an agent for Claude Code from vibeeval/vibecosystem. It costs 10 tokens per session (455 once invoked), scanned A, original, MIT.

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 for Claude Code

Written for Claude Code: a Claude Code subagent (agents/*.md).

Good fit Use it when adding endpoints, creating or validating an API specification, generating documentation from code annotations, building a documentation playground, or preparing changelogs.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/vibeeval/vibecosystem/api-doc-generator
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.

Clone the repo
git clone --depth 1 https://github.com/vibeeval/vibecosystem

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-doc-generator

README.md
[![agentmods](https://agentmods.dev/badge/agents/vibeeval/vibecosystem/api-doc-generator/github.svg)](https://agentmods.dev/agents/vibeeval/vibecosystem/api-doc-generator)
Your own site
<a href="https://agentmods.dev/agents/vibeeval/vibecosystem/api-doc-generator"><img src="https://agentmods.dev/badge/agents/vibeeval/vibecosystem/api-doc-generator/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-doc-generator

Your own site · 80×15
<a href="https://agentmods.dev/agents/vibeeval/vibecosystem/api-doc-generator"><img src="https://agentmods.dev/badge/agents/vibeeval/vibecosystem/api-doc-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00010 $0.00455
Opus 5.5 $0.00004 $0.00182
Sonnet 5.5 $0.00002 $0.00091
Haiku 4.5 $0.00001 $0.00046

Measured 1mo ago against content hash 1baab6985371, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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. 1mo 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 (536 stars, last pushed 2mo ago), licensed MIT. It adds 10 tokens to every session and 455 once invoked, about $0.0000 per session on Opus 5.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

backend-api-security-backend-security-coder

Expert in secure backend coding practices specializing in input validation, authentication, and API security. Use PROACTIVELY for backend security implementations or security code reviews.

wshobson/agents · 40 tokens

mcp-specialist

MCP server design, implementation, client configuration, and integration troubleshooting. Triggers: mcp, model context protocol, json-rpc, sse, stdio, mcp server, mcp config, mcp integration, mcp connection, claude desktop, mcp client.

softspark/ai-toolkit · 63 tokens

go-expert

Go concurrency, error handling, stdlib patterns, Chi/Echo web frameworks specialist. Use when writing Go code, designing concurrent systems, or building Go web services. Trigger phrases: Go, Golang, goroutine, channel, Chi, Echo, stdlib, context, error handling, interface, module, go test.

travisjneuman/.claude · 69 tokens

api-spec-writer

Produces api-requirements.md from an approved plan. Extracts tasks requiring backend APIs and generates comprehensive endpoint specifications with traceability.

closedloop-ai/claude-plugins · 31 tokens

scg-mapper

Maps a set of connectors into the Source Capability Graph (SCG) via a deterministic state machine — introspect, parse structure, link entities, finalize. Indexes reachability only, never the data behind it.

bearlike/Assistant · 48 tokens

gcp-cloud-architect

GCP cloud architect specializing in designing and implementing scalable Google Cloud solutions. Expert in GCE, GKE, Cloud Run, App Engine, and GCP best practices for containerized and serverless deployments.

andisab/swe-marketplace · 47 tokens