DocuMCP
🤖具有 RAG 功能的智能代码文档生成 MCP 服务器
DocuMCP 使 Claude 能够使用向量嵌入和语义搜索为您的代码库生成、搜索和管理文档。它提供了用于创建用户指南、技术文档、代码说明和架构图的工具。
✨ 特点
📚 根据你的代码库生成和更新文档
🔍 跨代码、文档和图表的语义搜索
📊 创建和合并架构图
📝 生成用户指南
💾 支持多种矢量数据库(LanceDB、ChromaDB、Qdrant)
🧠 灵活的嵌入提供程序(内置或 Ollama)
Related MCP server: Claude AI Documentation Assistant
🚀 快速入门
通过 NPX 安装(推荐)
使用 DocuMCP 最简单的方法是使用已发布的 npm 包配置 Claude Desktop:
将以下内容添加到您的 Claude Desktop 配置中:
MacOS :
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows :
%APPDATA%/Claude/claude_desktop_config.json
就这样!重启 Claude Desktop,DocuMCP 即可使用。
替代安装方法
使用 Smithery CLI
通过 Smithery CLI 安装服务器:
🚀 手动启动
1. 克隆并安装
2. 搭建 MCP 服务器
3.高级配置
将以下内容添加到您的 Claude Desktop 配置中:
MacOS :
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows :
%APPDATA%/Claude/claude_desktop_config.json
4.启动所需服务(如果使用外部提供商)
对于 Qdrant:
对于 ChromaDB:
5. 重启 Claude Desktop
重新启动 Claude Desktop 以加载新配置。
🛠️ 配置选项
矢量数据库提供商
提供者 | 描述 | 配置 |
LanceDB | 基于文件的本地数据库(默认) |
|
ChromaDB | 带有 Web UI 的简单矢量数据库 |
|
卡德兰特 | 生产级矢量数据库 |
|
嵌入提供程序
提供者 | 描述 | 配置 |
内置 | 使用全 MiniLM-L6-v2 模型(默认) |
|
奥拉马 | 使用任何 Ollama 型号 |
|
🔧 可用工具
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+
克劳德桌面
(可选)用于运行外部矢量数据库的 Docker
🤝 贡献
欢迎贡献代码!欢迎提交 Pull 请求。
用❤️制作