Autodocument MCP Server

by PARS-DOE

5 stars

199 downloads

Not rated

GitHub

About

An MCP (Model Context Protocol) server that automatically generates documentation for code repositories by analyzing directory structures and code files using OpenRouter API.

Details

Author: PARS-DOE
GitHub stars: 5
Downloads: 199
Categories: Developer Tools, Knowledge Base, AI

- Smart directory analysis with recursive scanning and .gitignore support
- AI-powered documentation, test plan, and code review generation via OpenRouter
- Bottom-up approach: processes leaf directories first to create a coherent hierarchy
- Creates documentation.md, testplan.md, and review.md per directory
- Supports updating existing files and fallback files for size limit exceedances
- Highly configurable: file extensions, size limits, model, and prompts

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Autodocument MCP Server

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

From the repository

Install Node.js v16+, clone the repository, run npm install and npm build. Configure it with an OpenRouter API key via environment variables or an MCP configuration file. Use tools such as generate_documentation, autotestplan, or autoreview by sending JSON-RPC tool calls, or configure the server for use with Roo Code, Cline, or the Claude Desktop App. Invoke the server with node build/index.js and provide the target project path.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "autodocument mcp server": {
            "autodocument": {
                "command": "node",
                "args": [
                    "build/index.js",
                    "/path/to/your/project"
                ]
            }
        }
    }
}

McpServers

{
    "autodocument": {
        "command": "node",
        "args": [
            "build/index.js",
            "/path/to/your/project"
        ]
    }
}

Autodocument MCP Server

An MCP (Model Context Protocol) server that automatically generates documentation for code repositories by analyzing directory structures and code files using OpenRouter API.

Features

- Smart Directory Analysis: Recursively analyzes directories and files in a code repository
- Git Integration: Respects .gitignore patterns to skip ignored files
- AI-Powered Documentation: Uses OpenRouter API (with Claude 3.7 by default) to generate comprehensive documentation
- Test Plan Generation: Automatically creates test plans with suitable test types, edge cases, and mock requirements
- Code Review: Performs senior developer-level code reviews focused on security, best practices, and improvements
- Bottom-Up Approach: Starts with leaf directories and works upward, creating a coherent documentation hierarchy
- Intelligent File Handling:
- Creates documentation.md, testplan.md, and review.md files at each directory level
- Skips single-file directories but includes their content in parent outputs
- Supports updating existing files
- Creates fallback files for directories that exceed limits
- Progress Reporting: Provides detailed progress updates to prevent timeouts in long-running operations
- Highly Configurable: Customize file extensions, size limits, models, prompts, and more
- Extensible Architecture: Modular design makes it easy to add more auto-* tools in the future

Installation

Prerequisites

- Node.js (v16 or newer)
- An OpenRouter API key

Installation Steps

```bash

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

Autodocument MCP Server

Features

Installation

Prerequisites

Installation Steps

Install

More like this

Aws Kb Retrieval Server

Memory

Sentry

Github

Git

GitLab