使用说明

项目简介

Docs MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在让 AI 助手能够轻松搜索文档和代码库。它利用 Probe 搜索引擎提供高效的搜索能力，使 AI 应用能够理解和利用项目文档或代码库中的上下文信息。

主要功能点

强大的搜索能力: 基于 Probe 搜索引擎，提供快速、准确的文档和代码搜索功能。
灵活的内容来源: 支持从 Git 仓库或本地目录加载文档和代码作为搜索内容。
动态配置: 通过配置文件、命令行参数或环境变量灵活配置内容来源、Git 设置和 MCP 工具信息。
自动 Git 更新: 可以配置自动从 Git 仓库拉取更新，保持搜索内容的实时性。
可定制的 MCP 工具: 允许自定义暴露给 AI 助手的搜索工具的名称和描述。
AI 集成: 无缝集成支持 Model Context Protocol (MCP) 的 AI 助手。

安装步骤

本项目无需本地安装，可以直接通过 'npx' 命令运行，方便快捷地与 AI 助手和 MCP 客户端集成。

对于 Claude Desktop 等客户端，可以使用 Smithery CLI 进行自动安装：

npx -y @smithery/cli install @buger/docs-mcp --client claude

对于其他 MCP 客户端，需要在客户端配置中指定启动命令。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能连接到 Docs MCP Server。以下是一个典型的 JSON 格式配置示例，用于配置 MCP 客户端：

{
  "mcpServers": {
    "docs-search": { // 服务器名称，可以自定义
      "command": "npx",
      "args": [
        "-y",
        "@buger/docs-mcp@latest", // 使用 npm 包名和 latest 版本
        "--gitUrl", "https://github.com/your-org/your-repo", // (可选) 要搜索的 Git 仓库 URL
        // "--includeDir", "/path/to/local/docs", // (可选) 本地文档目录路径 (gitUrl 和 includeDir 二选一)
        "--toolName", "search_my_docs", // (可选) 自定义搜索工具名称 (默认为 search_docs)
        "--toolDescription", "Search my documentation" // (可选) 自定义搜索工具描述 (默认为 "Search documentation using the probe search engine.")
      ],
      "enabled": true
    }
  }
}

参数说明:

'command': 设置为 'npx'，用于执行 npm 包。
'args': 参数列表，包括：
- '-y': 自动确认 'npx' 的安装提示。
- '@buger/docs-mcp@latest': Docs MCP Server 的 npm 包名和版本。
- '--gitUrl': (可选) 要索引和搜索的 Git 仓库的 URL。如果指定，服务器将克隆或下载该仓库的内容。
- '--includeDir': (可选) 要索引和搜索的本地目录的绝对路径。如果指定，服务器将使用该目录中的内容。'--gitUrl' 和 '--includeDir' 只能选择一个。
- '--toolName': (可选) 自定义 MCP 工具的名称，AI 助手会通过这个名称调用搜索功能。默认为 'search_docs'。
- '--toolDescription': (可选) 自定义 MCP 工具的描述，用于在 AI 助手界面上展示工具的功能说明。默认为 "Search documentation using the probe search engine."

基本使用方法

配置 MCP 客户端: 根据上述 "服务器配置" 示例，在您的 MCP 客户端中配置 Docs MCP Server 的启动命令和参数。
启动 MCP 服务器: 当 MCP 客户端连接服务器时，会自动通过 'npx' 启动 Docs MCP Server。
在 AI 助手中使用: 在支持 MCP 协议的 AI 助手（如 Claude Desktop）中，您可以使用配置中定义的 'toolName' (例如 'search_my_docs') 来调用文档或代码搜索功能。
发起搜索: 在 AI 助手中，使用类似 '{ "tool_name": "search_my_docs", "arguments": { "query": "你的搜索关键词" } }' 的格式调用搜索工具，并传入要搜索的关键词 'query'。服务器将返回搜索结果。

关键词