Skip to main content
subagent CX Codex

api-docs — Claude Code subagent: what it does, how to install

api-docs — a Claude Code subagent that inspects application endpoints to produce and maintain OpenAPI 3.0 specifications.

no license ★ 850 updated 2026-10-26

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/agents/docs-api-openapi.md
Open on GitHub

What api-docs does

api-docs focuses strictly on REST API contracts. It scans files like *.route.js or *.controller.js, discovers defined methods, and writes the output directly into openapi.yaml. File modifications stay confined to designated folders like docs/, api/, openapi/, and swagger/. The agent cannot touch node_modules/ or hidden secrets.

Security guardrails keep execution tightly controlled. Shell execution through Bash, task runners, and web searches are entirely blocked. The agent relies exclusively on reading and writing local text files. If claude-flow is missing from the environment, execution hooks for saving pattern memory fail silently. Any version change or document deletion requires explicit developer confirmation.

What it helps with

  • generate an OpenAPI 3.0 definition from controller files
  • synchronize route parameters with an existing openapi.yaml
  • restrict API spec generation from accessing sensitive repository files

Example prompts for the agent

  • Inspect api/routes.js and write an OpenAPI 3.0 spec into openapi.yaml
  • Update the request and response schemas in swagger.yaml

How to install api-docs

Manually: put the files in place

.claude/agents/docs-api-openapi.md

For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

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

Questions about api-docs

How do I install api-docs in Claude Code?

Place the configuration file at .claude/agents/docs-api-openapi.md. Claude Code registers the subagent directly from this location.

What tool permissions does api-docs have?

It can inspect and write files using Read, Write, Edit, MultiEdit, Grep, and Glob. Execution tools like Bash, Task, and WebSearch are disabled.

Which files can this subagent modify?

Edits are limited to .yaml, .yml, .json, and .md files under 2 MB located inside docs/, api/, openapi/, or swagger/.

Similar subagents

All subagents for Writing and docs →

From the same set76

The whole set →
workflow-automation workflow-automation integrates multi-agent swarms with GitHub Actions pipelines to generate CI configurations, select tests, and inspect build failures. CX Codex +1 ★ 850repo stars trading-predictor trading-predictor — a Claude subagent that measures how far its computation runs ahead of market-data delivery, then uses the gap for predictions and risk numbers. CX Codex ★ 850repo stars backend-dev The backend-dev subagent builds backend APIs and draws on earlier API work. Use it for tasks involving endpoints, routes, REST, or GraphQL. CX Codex ★ 850repo stars project-board-sync project-board-sync — a command that keeps a GitHub Projects board in step with agent-swarm tasks: states, agent labels and priorities land in the right columns. CX Codex +1 ★ 850repo stars examples The examples command presents pair-programming sessions for JWT auth, Node.js debugging, TDD, refactoring, React performance, and Express APIs. CX Codex +1 ★ 850repo stars base-template-generator base-template-generator writes the starting file set for a new component, endpoint or project config, then reuses templates that worked before. CX Codex ★ 850repo stars planner planner is a Claude Code subagent that breaks down engineering goals, maps dependencies, and allocates agents using execution memory. CX Codex ★ 850repo stars researcher The researcher subagent examines code, documentation, and module relationships, then organizes findings into a research summary. Use it to map an unfamiliar project or spot gaps in its docs. CX Codex ★ 850repo stars

Project sponsors

Companies that keep this analytics open