MCP Documentation Server
2024.12.27
0
TypeScriptAI 文档管理代码质量分析开发框架支持开发效率
MCP Documentation Server 是一个智能文档服务器，通过集成 Claude Desktop 提供 AI 辅助的代码改进和文档管理功能。它能够维护和更新文档知识库，分析并改进代码质量，支持多种开发框架，并集成 Brave Search 进行智能文档搜索和检索。随着时间的推移，其学习系统会不断改进建议质量。
View on GitHub
Overview
基本能力
产品定位
MCP Documentation Server 是一个智能文档服务器，旨在通过 AI 技术辅助开发者进行代码改进和文档管理。
核心功能
- AI 文档指南：维护和更新文档知识库
- AI 代码助手：分析并改进代码质量
- 框架支持：
- React.js
- Next.js (with App Router)
- Python
- Vue.js
- Angular
- Node.js
- Brave Search 集成：智能文档搜索和检索
- 学习系统：随着时间的推移改进建议
适用场景
- 开发者需要快速查找和理解框架文档
- 代码质量分析和改进建议
- 学习新技术和最佳实践
- 自动化文档维护和更新
工具列表
- npm：用于安装和管理依赖
- git：用于版本控制和协作开发
- Brave Search API：用于智能文档搜索
常见问题解答
- 如何配置 Brave Search API 密钥？
- 在
.env文件中设置BRAVE_API_KEY环境变量 - 如何启动开发服务器？
- 运行
npm run dev - 如何运行测试？
- 运行
npm test
使用教程
使用依赖
- 确保已安装 Node.js 和 npm
- 确保已安装 git
安装教程
- 安装全局包：
npm install -g mcp-documentation-server
- 配置 Claude Desktop (config.json)：
{
"mcpServers": {
"documentation": {
"command": "npx",
"args": ["-y", "mcp-documentation-server"],
"env": {
"BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"
}
}
}
}
- 开始使用 Claude：
Claude, search documentation for Next.js App Router
开发设置
- 克隆仓库：
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
调试方式
- 运行测试套件：
npm test
- 运行特定测试：
npm test -- tests/integration/BraveSearchIntegration.test.ts