
MCP Documentation Server

2024.12.04
9
TypeScript智能文档服务器AI 代码助手文档管理开发效率
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:用于克隆和管理代码库
- Claude Desktop:用于与 AI 交互
常见问题解答
- 如何配置 Brave API 密钥?
在
config.json
或.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