返回 MCP 目录
public公开dns本地运行

mcp-documentation-server

MCP文档服务器是一个智能文档管理工具,集成了AI代码辅助和文档搜索功能,支持多种主流开发框架。

article

README

🚀 MCP 文档服务器

MCP 文档服务器是一款智能文档服务器,它与 Claude Desktop 集成,提供 AI 辅助代码改进和文档管理功能,能有效提升代码质量与文档维护效率。

✨ 主要特性

  • AI 文档指南:对文档知识库进行维护和更新,确保知识的准确性和时效性。
  • AI 代码助手:深入分析代码,提出针对性建议,提升代码质量。
  • 框架支持:支持多种主流框架,包括 React.js、Next.js(App Router)、Python、Vue.js、Angular 和 Node.js。
  • Brave Search 集成:实现智能文档搜索与检索,快速定位所需文档。
  • 学习系统:随着时间推移不断改进建议,提供更精准的辅助。

🚀 快速开始

  1. 安装包
npm install -g mcp-documentation-server
  1. 配置 Claude Desktop(config.json)
{
  "mcpServers": {
    "documentation": {
      "command": "npx",
      "args": ["-y", "mcp-documentation-server"],
      "env": {
        "BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"
      }
    }
  }
}
  1. 使用 Claude 开始
Claude,搜索 Next.js App Router 的文档

查看更多详细设置说明,请参阅Claude Desktop 设置指南

📦 安装指南

开发环境搭建

  1. 克隆仓库
git clone https://github.com/mahawi1992/mcp-documentation-server.git
cd mcp-documentation-server
  1. 安装依赖项
npm install
  1. 创建.env 文件
PORT=3000
UPDATE_INTERVAL=3600000
CACHE_DURATION=86400000
BRAVE_API_KEY=your_brave_api_key
  1. 启动开发服务器
npm run dev

💻 使用示例

基本用法

Claude,搜索 React Hooks 的文档
Claude,分析这段 Python 代码并提出改进建议...
Claude,查找 Next.js App Router 的最佳实践

高级用法

Claude,搜索关于 Python 3.9 中 async/await 的文档
Claude,分析这段代码中的安全问题并建议修复方案...

更多示例,请参阅使用指南

📚 详细文档

🔧 技术细节

与 Claude Desktop 配合使用

通过特定的命令与 Claude Desktop 交互,实现文档搜索、代码分析等功能。基本命令可满足常见需求,高级用法则能处理更复杂的场景。

开发与测试

开发环境搭建需要克隆仓库、安装依赖、配置环境变量并启动开发服务器。测试方面,可运行测试套件或特定测试。

🤝 贡献方式

  1. 叉克仓库
  2. 创建功能分支
git checkout -b feature/amazing-feature
  1. 提交更改
git commit -m '添加 amazing 功能'
  1. 推送到分支
git push origin feature/amazing-feature
  1. 提交 Pull Request

🧪 测试

运行测试套件

npm test

运行特定测试

npm test -- tests/integration/BraveSearchIntegration.test.ts

📄 许可证

该项目采用 MIT License,具体细节请参阅 LICENSE 文件。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端