Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.
The English summary is being prepared. Showing the original description.
See how to installReview the instructions the agent will receive before you install.
Generate structured API documentation from a route manifest.
You will receive a route manifest (JSON array) from the previous pipeline stage. Each entry contains: method, path, file, line, middleware, type.
For each route in the manifest, read the source file to understand:
Use the template at templates/endpoint-doc.md for each route group.
Group routes by their source file (e.g., all product routes together).
Write one markdown file per route group to the docs/ directory:
docs/products-api.mddocs/categories-api.mdReturn a manifest of generated documentation files:
{
"files_generated": ["docs/products-api.md", "docs/categories-api.md"],
"routes_documented": 8,
"routes_skipped": [],
"warnings": []
}
This manifest will be consumed by the next pipeline stage (quality-checking).
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 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.
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.
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.
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.