Autodocument

Generates documentation, test plans, and code reviews for repositories using OpenRouter AI within an MCP workflow.

typescript

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "pars-doe-autodocument": {
      "command": "node",
      "args": [
        "/path/to/autodocument/build/index.js"
      ],
      "env": {
        "MAX_FILE_SIZE_KB": "100",
        "OPENROUTER_MODEL": "anthropic/claude-3-7-sonnet",
        "MAX_FILES_PER_DIR": "20",
        "OPENROUTER_API_KEY": "your-api-key-here"
      }
    }
  }
}

You run an MCP server that analyzes code repositories to automatically generate documentation, test plans, and code reviews. It operates bottom-up through directory structures, respects ignored files, and uses AI to produce coherent, up-to-date content that you can update over time. This makes maintaining code documentation and quality assurance much faster and more consistent across large projects.

How to use

Operate the MCP server with your preferred MCP client to generate documentation, test plans, or code reviews for a project. You can run it against a local project or integrate it into your development workflow to produce structured outputs at each directory level. Use the available tools to generate documentation, create test plans, or perform senior-level code reviews, and reuse or update existing outputs as your codebase evolves.

How to install

Prerequisites are installed on your machine so you can run the MCP server and interact with the AI backend.

Install Node.js (version 16 or newer) on your system.
Clone the project repository.
Install dependencies.
Build the project so you can run the built index.js.

Configuration

Configure environment variables and MCP server settings to control how the MCP server operates and how it talks to the OpenRouter API.

Key environment variables include the API key, the AI model, and file handling limits.

Security and maintenance

Set and protect your API key. Use environment-based configuration to avoid hard-coding secrets in your code or in client configurations. Regularly review generated outputs and update prompts to align with your evolving coding standards.

Troubleshooting

If you encounter issues with the API key, verify that the OPENROUTER_API_KEY variable is set and that your account has credits. If processing is slow or directories are skipped due to limits, adjust MAX_FILE_SIZE_KB and MAX_FILES_PER_DIR to fit your project size.

Examples and developer notes

You can customize prompts and outputs to fit your project’s needs. The system supports creating or updating documentation, test plans, and reviews at each directory level and aggregates content as it moves up the directory tree.

Available tools

generate_documentation

Generates comprehensive documentation for a repository by analyzing code and producing a documentation.md file per directory.

autotestplan

Generates test plans for functions and components, detailing unit, integration, and edge case tests.

autoreview

Produces a senior developer-level code review highlighting security, best practices, and improvement opportunities.

Built by

VeilStrat

AI signals for GTM teams