OpenAPI2AgentContext

This project makes OpenAPI schemas more digestible for AI agents such as Claude Code and OpenAI Codex.

What it does

Converts OpenAPI schemas into agent-friendly documentation by generating:

• An index.md file with a summary of all endpoints
• Individual markdown files for each endpoint containing:
  • Endpoint description
  • Parameters and request body schemas
  • Response status codes and descriptions (without schemas)

Request schemas are included to help agents understand what data to send, while response schemas are excluded to keep the documentation focused and concise.

All generated files are stored in the .OpenAPI4Agents directory.

Usage

node main.ts <my-project-openapi.(json|yaml|yml)>

Examples

# JSON format
node main.ts api-spec.json

# YAML format
node main.ts api-spec.yaml
node main.ts api-spec.yml