使用说明

项目简介

docs-mcp-server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 提供第三方软件包文档的上下文信息。它可以抓取、处理、索引和搜索各种软件库和包的文档，并通过 MCP 协议与客户端通信，为 LLM 应用提供结构化的上下文数据访问能力。

主要功能点

文档抓取与索引: 能够从指定的 URL 自动抓取第三方软件包的文档内容，并进行语义切分和向量化索引，以便于快速检索。
版本控制: 支持对不同版本的软件包文档进行区分存储和查询，方便用户获取特定版本或版本范围内的文档信息。
MCP 工具支持: 内置 'scrape_docs', 'search_docs', 'list_libraries', 'find_version' 等 MCP 标准工具，方便 LLM 客户端调用和集成。
CLI 工具: 提供 'docs-mcp' 命令行工具，用于本地的文档管理和服务器交互，例如文档抓取、搜索和版本查询等。
多种传输协议: 支持 Server-Sent Events (SSE) 和 POST 消息等多种传输协议，可以灵活地与各种 MCP 客户端集成。

安装步骤

克隆仓库: 首先，你需要将仓库克隆到本地：

git clone https://github.com/arabold/docs-mcp-server

进入目录: 克隆完成后，进入项目目录：
```
cd docs-mcp-server
```
安装依赖: 使用 npm 安装项目依赖：
```
npm install
```
构建项目: 构建 TypeScript 代码到 JavaScript：
```
npm run build
```
配置环境变量: 复制 '.env.example' 文件为 '.env'，并根据需要配置 'OPENAI_API_KEY' 环境变量，用于向量 embedding 生成。

服务器配置

为了让 MCP 客户端（例如 Claude Desktop）连接到 docs-mcp-server，你需要配置客户端的 MCP 服务器设置。以下是一个典型的配置示例，以 JSON 格式添加到 MCP 客户端的配置文件中（例如 Claude Desktop 的 'claude_desktop_config.json'）：

{
  "mcpServers": {
    "docs-mcp-server": {
      "command": "node",
      "args": ["/path/to/docs-mcp-server/dist/server.js"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here" // 请替换为你的 OpenAI API 密钥
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

参数说明:

'server name': 'docs-mcp-server' - 服务器名称，用于客户端识别。
'command': 'node' - 启动服务器的命令，这里使用 Node.js 运行时。
'args': '["/path/to/docs-mcp-server/dist/server.js"]' - 启动命令的参数，指向构建后的服务器 JavaScript 文件路径，请务必替换为你的实际文件路径。
'env': '{"OPENAI_API_KEY": "your-api-key-here"}' - 环境变量配置，请将 'your-api-key-here' 替换为你的 OpenAI API 密钥。
'disabled': 'false' - 设置为 'false' 表示启用该服务器。
'autoApprove': '[]' - 自动批准的工具列表，默认为空。

注意: '/path/to/docs-mcp-server' 需要替换为 'docs-mcp-server' 仓库在你的本地文件系统中的绝对路径。

基本使用方法

启动服务器: 在 'docs-mcp-server' 项目目录下，运行以下命令启动 MCP 服务器：

node dist/server.js

或者使用 Docker 运行：

docker run -p 8000:8000 --env-file .env --name docs-mcp-server-container docs-mcp-server

配置 MCP 客户端: 将上述服务器配置 JSON 添加到你的 MCP 客户端配置文件中。
使用 MCP 客户端: 在 MCP 客户端中，即可调用 'docs-mcp-server' 提供的 MCP 工具，例如 'scrape_docs' 抓取文档， 'search_docs' 搜索文档等。
使用 CLI 工具: 在 'docs-mcp-server' 项目目录下，可以使用 'docs-mcp' 命令行工具进行文档管理和测试，具体命令请参考仓库 README 文档或运行 'docs-mcp --help' 查看帮助信息。

关键词