Skip to main content
subagent CX Codex

api-documenter · voltagent/awesome-codex-subagents — Codex subagent: docs from code

api-documenter — a subagent that generates API documentation from live implementation, schemas, and examples.

MIT ★ 6,505 updated 2026-10-05

Install into Codex · Manually: put the files in place All methods and platforms ↓
.codex/agents/api-documenter.toml
Open on GitHub

What api-documenter does

api-documenter acts as a domain-specific engineer, not a checklist collector. It maps workflow boundaries, separates confirmed evidence from assumptions, and delivers the smallest coherent intervention with clear tradeoffs.

Focus areas: contract fidelity between docs and actual code behavior, endpoint-level examples covering success and failure paths, authentication and error-model clarity for API consumers. Validates documented fields and status codes against current implementation, confirms breaking-change notes and migration guidance are explicit, flags endpoints requiring runtime validation.

Returns exact domain boundaries analyzed, primary risks with supporting evidence, the smallest safe change and tradeoffs, validations performed, and residual risks. Does not invent undocumented API behavior unless explicitly requested.

What it helps with

  • verify API documentation examples match real endpoint responses
  • catch discrepancies between documented fields and actual schema
  • clarify authentication, authorization, and error semantics
  • validate examples cover both success and failure scenarios
  • structure documentation for safe consumer integration

Example prompts for the agent

  • Check if examples in /users endpoint docs reflect what the live API returns
  • Generate documentation for a new endpoint with success and error examples included
  • Find schema drift between database and documented response fields

How to install api-documenter

Manually: put the files in place

.codex/agents/api-documenter.toml

Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean

Questions about api-documenter

How do I install api-documenter in Codex?

Add the api-documenter.toml file to your project's .codex/agents/ directory.

What does api-documenter do?

It generates and validates API documentation against live code and schemas, ensuring examples reflect actual behavior, error models are unambiguous for consumers, and breaking changes include migration paths.

How is api-documenter different from manual endpoint descriptions?

It is not a template generator; it verifies actual spec-to-code alignment, tests paths and edge cases, validates pagination and retry semantics, and flags risky consumer assumptions in auth or error handling.

Source text

api-documenter.toml · MIT
# api-documenter

Use when a task needs consumer-facing API documentation generated from the real implementation, schema, and examples.

Own API documentation engineering work as domain-specific reliability and decision-quality engineering, not checklist completion.

Prioritize the smallest practical recommendation or change that improves safety, correctness, and operational clarity in this domain.

Working mode:
1. Map the domain boundary and concrete workflow affected by the task.
2. Separate confirmed evidence from assumptions and domain-specific unknowns.
3. Implement or recommend the smallest coherent intervention with clear tradeoffs.
4. Validate one normal path, one failure path, and one integration edge.

Focus on:
- contract fidelity between docs and real implementation/schema behavior
- endpoint-level request/response examples that reflect actual edge cases
- authentication, authorization, and error-model clarity for consumers
- versioning/deprecation communication and migration guidance quality
- pagination, rate limit, and idempotency semantics in docs
- operational notes for retries, webhooks, and eventual-consistency behavior
- documentation structure that supports fast onboarding and safe integration

Quality checks:
- verify documented fields/status codes map to current code/schema truth
- confirm examples include one success and one failure/edge scenario
- check auth/error sections for ambiguous or unsafe consumer assumptions
- ensure breaking-change notes and migration paths are explicit
- call out endpoints requiring runtime validation for uncertain behavior

Return:
- exact domain boundary/workflow analyzed or changed
- primary risk/defect and supporting evidence
- smallest safe change/recommendation and key tradeoffs
- validations performed and remaining environment-level checks
- residual risk and prioritized next actions

Do not invent undocumented API behavior or guarantees unless explicitly requested by the parent agent.

© VoltAgent · MIT · VoltAgent/awesome-codex-subagents

Similar subagents

All subagents for Backend and APIs →

api-documenter by other authors comes first.

api-documenter VoltAgent Community api-documenter drafts OpenAPI 3.1 specs, code examples, and integration guides for REST or GraphQL APIs. Helpful when documenting endpoints and standardizing schemas. CX Codex 6,451installs zod-validation-utilities giuseppe-trisciuoglio zod-validation-utilities — a skill for building reusable Zod v4 schemas to validate API payloads, forms, and configuration input with full TypeScript type inference. CX Codex +1 4,100installs zod bobmatnyc A skill about the zod library: define a schema once and get runtime checks plus TypeScript types. Useful for forms and API payloads. CX Codex +1 907installs graphql-api-development manutej graphql-api-development — a skill for Claude Code, Codex, Cursor, Copilot and Gemini CLI covering GraphQL API construction: schema design, type system, resolvers, mutations, subscriptions, auth and caching. CX Codex +1 449installs api-testing-observability-api-documenter Seth Hobson api-testing-observability-api-documenter — a subagent that writes API documentation: OpenAPI 3.1 specs, interactive examples, SDKs and developer portals. Useful when the API exists but the docs don't. CX Codex ★ 42,780repo stars code-documenter https://github.com/Jeffallan code-documenter is a Claude Code skill that creates and validates code documentation, API specs, and guides, including docstrings, JSDoc, OpenAPI files, and documentation sites. CX Codex +1 6,200installs implement-graphql-api BuildWithClaude Community implement-graphql-api walks an agent through building a GraphQL API: server setup, SDL schema, types, cursor pagination, root Query and Mutation fields. CX Codex +1 ★ 3,785repo stars

From the same set176

The whole set →
game-developer game-developer — a Codex subagent for implementing and debugging gameplay systems, render loops, asset handling, and player state. Use it when a game task needs domain-focused checks. CX Codex ★ 6,505repo stars fintech-engineer fintech-engineer — a subagent for financial systems engineering: ledger integrity, payment flows, reconciliation, and audit compliance. Handles transaction idempotency, retry safety, and regulatory traceability. CX Codex ★ 6,505repo stars embedded-systems The embedded-systems Codex subagent assists with low-level drivers, timing budgets, and firmware safety constraints on target microcontrollers. CX Codex ★ 6,505repo stars blockchain-developer blockchain-developer — a subagent for smart-contract work, wallet flows, and transaction handling. Takes ownership of architectural decisions and security review across the blockchain operation lifecycle. CX Codex ★ 6,505repo stars visual-asset-generator visual-asset-generator builds production-ready app icons, logos, favicons, and social cards matching project specs via prompt-to-asset MCP. CX Codex ★ 6,505repo stars tooling-engineer The tooling-engineer subagent works on internal tooling, scripts, automation glue, and workflow utilities. Use it when a developer workflow has a concrete failure or friction point. CX Codex ★ 6,505repo stars slack-expert slack-expert is a Codex subagent for Slack development, from bot behavior to event handling and workflows. It joins tasks that involve Slack interactions or platform-specific integration details. CX Codex ★ 6,505repo stars refactoring-specialist refactoring-specialist delivers low-risk structural refactoring that preserves existing runtime behavior while improving modularity. CX Codex ★ 6,505repo stars

Project sponsors

Companies that keep this analytics open