使用说明
MCP文档服务器
一个智能文档服务器,通过Claude Desktop集成提供人工智能辅助的代码改进和文档管理。
特性
- AI文档指南:维护和更新文档知识库
- AI代码助手:分析并提高代码质量
- 框架支持:
- React.js
- Next.js(带应用路由器)
- python
- Vue.js
- Angular
- Node.js
- 勇敢的搜索集成:智能文档搜索和检索
- 学习系统:随着时间的推移改进建议
快速开始
- 安装软件包:
npm install -g mcp-documentation-server
- 配置克劳德桌面(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
有关详细的设置说明,请参阅 Claude桌面设置指南
开发设置
- 克隆存储库:
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 Desktop一起使用
基本命令
Claude, search documentation for React hooks
Claude, analyze this Python code and suggest improvements...
Claude, find best practices for Next.js App Router
高级用法
Claude, search for documentation about async/await in Python 3.9
Claude, analyze this code for security issues and suggest fixes...
有关更多示例,请参阅 使用指南
贡献
- 分叉存储库
- 创建特征分支:
git checkout -b feature/amazing-feature - 提交您的更改:
git commit -m 'Add amazing feature' - 推到分支:
git push origin feature/amazing-feature - 打开拉取请求
测试
运行测试套件:
npm test
运行特定测试:
npm test -- tests/integration/BraveSearchIntegration.test.ts
许可证
此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件
