MCP.so
ログイン

Autodocument MCP Server

@PARS-DOE

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.

基本情報

カテゴリ

開発者ツール

ライセンス

CC0-1.0

ランタイム

node

トランスポート

stdio

公開者

PARS-DOE

設定

以下の設定を使って、このサーバーを MCP 対応クライアントに追加してください。

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

ツール

ツールは検出されませんでした

ツールは README から自動的に抽出されます。メンテナーは ## Tools という見出しの下に記載することで、このタブに反映できます。

概要

What is Autodocument MCP Server?

Autodocument MCP Server is an MCP (Model Context Protocol) server that automatically generates documentation, test plans, and code reviews for code repositories. It analyzes directory structures and code files using the OpenRouter API (default Claude 3.7) and creates markdown output files. It is designed for developers who want AI-powered documentation and code analysis integrated directly into their development workflow.

How to use Autodocument MCP Server?

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.

Key features of Autodocument MCP Server

  • 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

Use cases of Autodocument MCP Server

  • Automatically generate comprehensive documentation for an entire code repository
  • Create detailed test plans including edge cases, test types, and mocking requirements
  • Perform senior developer-level code reviews focusing on security and best practices

FAQ from Autodocument MCP Server

What are the prerequisites for running Autodocument MCP Server?

Node.js v16 or newer and an OpenRouter API key are required.

How do I configure the server?

Set environment variables: OPENROUTER_API_KEY, OPENROUTER_MODEL (default: anthropic/claude-3-7-sonnet), MAX_FILE_SIZE_KB (default: 100), and MAX_FILES_PER_DIR (default: 20). Alternatively, configure via MCP JSON config files for Roo/Cline or Claude Desktop.

What output files does the server create?

It creates documentation.md, testplan.md, and review.md in each processed directory. For directories exceeding size or file limits, it creates fallback files (undocumented.md, untested.md, review-skipped.md).

How can I customize the AI prompts?

Edit the src/prompt-config.ts file to adjust tone, style, or add project-specific instructions without changing the tool code.

What should I do if too many directories are skipped due to size limits?

Increase the MAX_FILE_SIZE_KB and MAX_FILES_PER_DIR environment variables, or document very large directories manually.

コメント

「開発者ツール」の他のコンテンツ