Optional integration for running external vector databases like ChromaDB and Qdrant to support the documentation system
Supports indexing and searching through codebases, enabling documentation generation based on source code repositories
Required runtime environment for the MCP server, with support for Node.js 20.11.24+
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
就这样!重启 Claude Desktop,DocuMCP 即可使用。
替代安装方法
使用 Smithery CLI
通过 Smithery CLI 安装服务器:
🚀 手动启动
1. 克隆并安装
2. 搭建 MCP 服务器
3.高级配置
将以下内容添加到您的 Claude Desktop 配置中:
- MacOS :
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows :
%APPDATA%/Claude/claude_desktop_config.json
4.启动所需服务(如果使用外部提供商)
对于 Qdrant:
对于 ChromaDB:
5. 重启 Claude Desktop
重新启动 Claude Desktop 以加载新配置。
🛠️ 配置选项
矢量数据库提供商
提供者 | 描述 | 配置 |
---|---|---|
LanceDB | 基于文件的本地数据库(默认) | VECTOR_DB_PROVIDER=lance LANCE_PATH=~/lanceDB |
ChromaDB | 带有 Web UI 的简单矢量数据库 | VECTOR_DB_PROVIDER=chroma CHROMA_URL=http://localhost:8000 |
卡德兰特 | 生产级矢量数据库 | VECTOR_DB_PROVIDER=qdrant QDRANT_URL=http://localhost:6333 |
嵌入提供程序
提供者 | 描述 | 配置 |
---|---|---|
内置 | 使用全 MiniLM-L6-v2 模型(默认) | EMBEDDING_PROVIDER=buildin EMBEDDING_MODEL=all-MiniLM-L6-v2 EMBEDDING_DIMENSION=384 |
奥拉马 | 使用任何 Ollama 型号 | EMBEDDING_PROVIDER=ollama EMBEDDING_MODEL=bge-m3:latest EMBEDDING_DIMENSION=1024 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+
- 克劳德桌面
- (可选)用于运行外部矢量数据库的 Docker
🤝 贡献
欢迎贡献代码!欢迎提交 Pull 请求。
用❤️制作
This server cannot be installed
MCP 服务器使 Claude 能够使用向量嵌入和语义搜索来生成、搜索和管理代码库文档,提供创建用户指南、技术文档、代码说明和架构图的工具。
Related MCP Servers
- AsecurityAlicenseAqualityAn MCP server implementation that integrates Claude with Salesforce, enabling natural language interactions with Salesforce data and metadata for querying, modifying, and managing objects and records.Last updated -78715TypeScriptMIT License
- -securityFlicense-qualityAn MCP server that enables Claude Desktop to interact with Sanity.io content, providing tools to create, edit, list documents and get schema templates.Last updated -TypeScript
- AsecurityAlicenseAqualityAn MCP server implementation that integrates Claude with Salesforce, enabling natural language interactions with Salesforce data and metadata for querying, modifying, and managing objects and records.Last updated -7184TypeScriptMIT License
- -securityAlicense-qualityAn MCP server that implements Claude Code-like functionality, allowing the AI to analyze codebases, modify files, execute commands, and manage projects through direct file system interactions.Last updated -151PythonMIT License