Generate API documentation from code. Use when the user wants to document APIs, create API reference, generate endpoint documentation, or needs help with OpenAPI/Swagger specs.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
Generate comprehensive API documentation from source code.
For common documentation patterns, see PATTERNS.md.
See STANDARDS.md for our documentation conventions.
Look for:
For each endpoint, extract:
Use the template in templates/endpoint.md for consistent formatting.
Generate an index of all endpoints with the template in templates/index.md.
Generate markdown documentation suitable for README or docs site.
If requested, generate OpenAPI 3.0 spec. See templates/openapi.yaml for structure.
See EXAMPLES.md for sample inputs and outputs.
To auto-detect routes in common frameworks:
python scripts/detect_routes.py <source_directory>
To validate generated OpenAPI spec:
./scripts/validate_openapi.sh <spec_file>
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.
The English summary is being prepared. Showing the original description.
Generate API endpoint code and documentation from specifications. Use when the user wants to create new API endpoints, generate route handlers, scaffold REST APIs, or produce OpenAPI/Swagger specs from code.
The English summary is being prepared. Showing the original description.
Generate API endpoint documentation from Express route files. Use when the user asks to generate, update, or review API docs for Express.js routes.
The English summary is being prepared. Showing the original description.
Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.
The English summary is being prepared. Showing the original description.
Review code for quality, security, and best practices. Use when the user asks for code review, wants feedback on their code, mentions reviewing changes, or asks about code quality.
The English summary is being prepared. Showing the original description.
Generate an interactive tree visualization of your codebase. Use when exploring a new repo or understanding project structure.
The English summary is being prepared. Showing the original description.