Skip to main content

Documentation Agents

api-documenter​

Category: docs

Adds complete OpenAPI documentation to all route handlers.

For each route, it adds:

  • Summary and description
  • Request body schema with field descriptions
  • Response schemas for all status codes
  • Parameter documentation (path, query, header)
  • Authentication requirements
  • Example requests and responses

Works with FastAPI (@app.get decorators), Flask-RESTX, Express (OpenAPI JSDoc), and Hono.

nimbus run --agent api-documenter

readme-architect​

Category: docs

Rewrites the README from scratch based on the actual codebase.

The generated README includes:

  • What the project does (derived from reading the code)
  • Installation instructions (derived from requirements.txt, package.json, etc.)
  • Quick start example (derived from tests and route handlers)
  • Configuration reference (derived from config files and env var usage)
  • Contributing guide
  • License

It does not preserve sections from the existing README unless the content is accurate.

nimbus run --agent readme-architect

inline-documenter​

Category: docs

Adds specific, accurate docstrings to every public function and class.

Rules it follows:

  • Docstrings describe what the function does, not how
  • Parameter types and return types are included
  • Side effects and exceptions are noted where relevant
  • Docstrings are short — one paragraph maximum
  • Does not add docstrings to private functions (prefixed with _)
nimbus run --agent inline-documenter