使用说明

项目简介

Developer Documentation Server 是一个智能文档服务器，旨在通过AI技术辅助开发者进行代码改进和文档管理。它集成了Brave Search搜索引擎，能够为开发者提供快速、准确的文档检索和代码分析服务，并可以通过Claude Desktop与大型语言模型（LLM）客户端集成。

主要功能点

AI文档助手：维护和更新文档知识库，提供智能文档检索功能。
AI代码助手：分析代码质量，并提供改进建议。
广泛的框架支持：支持 React.js, Next.js, Python, Vue.js, Angular, Node.js 等多种主流开发框架。
Brave Search 集成：利用 Brave Search 搜索引擎进行智能文档搜索和检索。
持续学习系统：通过学习不断优化建议质量。

安装步骤

安装软件包: 打开终端，运行以下命令全局安装 'mcp-documentation-server'：

npm install -g mcp-documentation-server

服务器配置

此 MCP 服务器主要与 MCP 客户端（如 Claude Desktop）配合使用。您需要在 MCP 客户端的配置文件中添加此服务器的配置信息。以下是一个 'config.json' 示例，展示了如何在 Claude Desktop 中配置并启动 Developer Documentation Server：

{
  "mcpServers": {
    "documentation": {
      "command": "npx",
      "args": ["-y", "mcp-documentation-server"],
      "env": {
        "BRAVE_API_KEY": "<YOUR_BRAVE_API_KEY>"
      }
    }
  }
}

配置参数说明:

'server name': 服务器名称，这里是 "documentation"，可以自定义。
'command': 启动服务器的命令，这里使用 'npx' 来运行全局安装的 'mcp-documentation-server' 包。
'args': 传递给启动命令的参数，这里 '-y' 参数通常用于跳过 'npm' 包安装时的确认提示（如果适用）。
'env': 环境变量配置，'BRAVE_API_KEY' 是 Brave Search API 的密钥，您需要替换 '<YOUR_BRAVE_API_KEY>' 为您自己的密钥。您需要从 Brave Search 获取API密钥才能使用文档搜索功能。

注意: 请确保您已经安装了 Node.js 和 npm 环境。并且需要配置 'BRAVE_API_KEY' 环境变量，否则文档搜索功能可能无法正常工作。

基本使用方法

配置完成后，您可以在 Claude Desktop 中通过自然语言指令来使用此文档服务器的功能。例如：

搜索文档:

Claude, search documentation for Next.js App Router

Claude, search documentation for React hooks

代码分析:

Claude, analyze this Python code and suggest improvements...

Claude, analyze this code for security issues and suggest fixes...

更多使用示例和高级用法，请参考仓库中的 Usage Guide 文档。

关键词