DocuMCP

🤖 一款具备RAG功能的智能代码文档生成MCP服务器

DocuMCP使Claude能够使用向量嵌入和语义搜索来生成、搜索和管理您的代码库文档。它提供了创建用户指南、技术文档、代码解释和架构图的工具。

✨ 特性

• 📚 根据您的代码库生成和更新文档
• 🔍 在代码、文档和图表中进行语义搜索
• 📊 创建和合并架构图
• 📝 生成用户指南
• 💾 支持多种向量数据库（LanceDB、ChromaDB、Qdrant）
• 🧠 灵活的嵌入提供者（内置或Ollama）

🚀 快速开始

通过NPX安装（推荐）

使用DocuMCP最简单的方法是通过已发布的npm包配置Claude Desktop：

在您的Claude Desktop配置中添加以下内容：

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docu-mcp": {
      "command": "npx",
      "args": ["-y", "@myjungle/docu-mcp-server"]
    }
  }
}

重启Claude Desktop即可使用DocuMCP。

其他安装方法

使用Smithery CLI

通过Smithery CLI安装服务器：

# 如果没有安装Smithery CLI，请先安装
npm install -g @smithery/cli

# 然后安装Docu MCP服务器
npx -y @smithery/cli@latest install @YannickTM/docu-mcp --client claude

🚀 手动启动

1. 克隆并安装

git clone https://github.com/YannickTM/docu-mcp
cd docu-mcp
npm install

2. 构建MCP服务器

cd mcp
npm run build
cd ..

3. 高级配置

在您的Claude Desktop配置中添加以下内容：

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "docuassistant": {
      "command": "node",
      "env": {
        "VECTOR_DB_PROVIDER": "qdrant",
        "QDRANT_URL": "http://localhost:6333",
        "EMBEDDING_PROVIDER": "ollama",
        "EMBEDDING_MODEL": "bge-m3:latest",
        "EMBEDDING_DIMENSION": "11434",
        "OLLAMA_URL": "http://localhost:11434"
      },
      "args": ["/绝对路径/to/DocuMCP/mcp/dist/index.js"]
    }
  }
}

4. 启动所需服务（如果使用外部提供者）

对于Qdrant：

cd qdrant
npm run start

对于ChromaDB：

cd chromadb
npm run start

5. 重启Claude Desktop

重启Claude Desktop以加载新配置。

🛠️ 配置选项

向量数据库提供者

提供者	描述	配置
LanceDB	基于文件的本地数据库（默认）	VECTOR_DB_PROVIDER=lance<br/>LANCE_PATH=~/lanceDB
ChromaDB	带有Web界面的简单向量数据库	VECTOR_DB_PROVIDER=chroma<br/>CHROMA_URL=http://localhost:8000
Qdrant	生产级向量数据库	VECTOR_DB_PROVIDER=qdrant<br/>QDRANT_URL=http://localhost:6333

嵌入提供者

提供者	描述	配置
内置	使用all-MiniLM-L6-v2模型（默认）	EMBEDDING_PROVIDER=buildin<br/>EMBEDDING_MODEL=all-MiniLM-L6-v2<br/>EMBEDDING_DIMENSION=384
Ollama	使用任何Ollama模型	EMBEDDING_PROVIDER=ollama<br/>EMBEDDING_MODEL=bge-m3:latest<br/>EMBEDDING_DIMENSION=1024<br/>OLLAMA_URL=http://localhost:11434

🔧 可用工具

DocuMCP为Claude提供了以下工具：

• 📁 文件操作：read_file, write_file, create_directory, read_directory
• 🔎 搜索工具：search_codebase, search_documentation, search_diagram, search_user_guide
• 📚 文档：generate_documentation, generate_user_guide, explain_code
• 📊 图表：generate_diagram, merge_diagram
• 🗃️ 索引：index_file, index_directory
• 🔀 合并：merge_documentation

📋 要求

• Node.js 20.11.24+
• Claude Desktop
• （可选）Docker用于运行外部向量数据库

🤝 贡献

欢迎贡献！请随时提交Pull Request。

---

由❤️制作