🚀 MCP 文档服务器
MCP 文档服务器是一款智能文档服务器，它与 Claude Desktop 集成，提供 AI 辅助代码改进和文档管理功能，能有效提升代码质量与文档维护效率。
✨ 主要特性
- AI 文档指南：对文档知识库进行维护和更新，确保知识的准确性和时效性。
- AI 代码助手：深入分析代码，提出针对性建议，提升代码质量。
- 框架支持：支持多种主流框架，包括 React.js、Next.js（App Router）、Python、Vue.js、Angular 和 Node.js。
- Brave Search 集成：实现智能文档搜索与检索，快速定位所需文档。
- 学习系统：随着时间推移不断改进建议，提供更精准的辅助。
🚀 快速开始
- 安装包：
npm install -g mcp-documentation-server
- 配置 Claude Desktop（config.json）：
{
"mcpServers": {
"documentation": {
"command": "npx",
"args": ["-y", "mcp-documentation-server"],
"env": {
"BRAVE_API_KEY": ""
}
}
}
}
- 使用 Claude 开始：
Claude，搜索 Next.js App Router 的文档
查看更多详细设置说明，请参阅Claude Desktop 设置指南
📦 安装指南
开发环境搭建
- 克隆仓库：
git clone https://github.com/mahawi1992/mcp-documentation-server.git
cd mcp-documentation-server
- 安装依赖项：
npm install
- 创建.env 文件：
PORT=3000
UPDATE_INTERVAL=3600000
CACHE_DURATION=86400000
BRAVE_API_KEY=your_brave_api_key
- 启动开发服务器：
npm run dev
💻 使用示例
基本用法
Claude，搜索 React Hooks 的文档
Claude，分析这段 Python 代码并提出改进建议...
Claude，查找 Next.js App Router 的最佳实践
高级用法
Claude，搜索关于 Python 3.9 中 async/await 的文档
Claude，分析这段代码中的安全问题并建议修复方案...
更多示例，请参阅使用指南
📚 详细文档
- 使用指南
- Claude Desktop 设置
- API 文档
- 贡献指南
🔧 技术细节
与 Claude Desktop 配合使用
通过特定的命令与 Claude Desktop 交互，实现文档搜索、代码分析等功能。基本命令可满足常见需求，高级用法则能处理更复杂的场景。
开发与测试
开发环境搭建需要克隆仓库、安装依赖、配置环境变量并启动开发服务器。测试方面，可运行测试套件或特定测试。
🤝 贡献方式
- 叉克仓库
- 创建功能分支：
git checkout -b feature/amazing-feature
- 提交更改：
git commit -m '添加 amazing 功能'
- 推送到分支：
git push origin feature/amazing-feature
- 提交 Pull Request
🧪 测试
运行测试套件
npm test
运行特定测试
npm test -- tests/integration/BraveSearchIntegration.test.ts
📄 许可证
该项目采用 MIT License，具体细节请参阅 LICENSE 文件。