使用说明

项目简介

probe-mcp 是 Probe 代码搜索工具的 MCP 服务器端组件，它基于 Model Context Protocol (MCP) 标准协议，旨在使 AI 客户端（如代码编辑器、智能助手等）能够以标准化的方式调用 Probe 的强大代码搜索功能。通过 probe-mcp，AI 应用可以方便地集成本地代码库的语义搜索能力，提升代码理解和辅助编程的智能化水平。

主要功能点

MCP 服务器实现: 实现了 MCP 协议，可以作为 MCP 服务器与 AI 客户端进行通信。
代码搜索工具桥梁: 作为桥梁，连接 MCP 客户端和 Probe 代码搜索工具，将客户端的搜索请求转化为 Probe 的 CLI 命令执行。
本地代码库语义搜索: 支持 AI 客户端通过 MCP 协议，对本地代码库进行快速、精准的语义搜索。
工具注册与调用: 将 Probe 的代码搜索功能注册为 MCP 工具 'probe'，允许 AI 客户端通过 'callTool' 方法调用。
标准化接口: 遵循 MCP 标准协议，提供与各种支持 MCP 协议的 AI 客户端集成的能力。

安装步骤

前提条件: 确保已安装 Node.js 和 npm。
安装 probe-mcp: 可以通过 npm 全局安装 probe-mcp 包，以便在任何地方运行 MCP 服务器。
```
npm install -g @buger/probe-mcp
```

服务器配置

MCP 服务器配置是为 MCP 客户端准备的，用于告知客户端如何启动和连接 probe-mcp 服务器。以下是配置信息（JSON 格式），你需要将其添加到你的 MCP 客户端的配置文件中。

{
  "mcpServers": {
    "probe-server": { # MCP服务器名称，可以自定义
      "command": "npx", # 启动命令，这里使用 npx 运行 npm 包
      "args": [
        "-y",  # 自动确认安装包
        "@buger/probe-mcp" # 要运行的 npm 包名，即 probe-mcp
      ]
    }
  }
}

配置参数说明:

'server name': 'probe-server' - 服务器名称，可以根据你的喜好自定义，用于在客户端配置中引用。
'command': '"npx"' - 指定用于启动服务器的命令为 'npx'，它允许直接运行 npm 包，无需全局安装。
'args': 一个字符串数组，包含传递给 'npx' 命令的参数：
- '"-y"': 告诉 'npx' 自动确认安装 '@buger/probe-mcp' 包，如果尚未安装的话。
- '"@buger/probe-mcp"': 指定要运行的 npm 包为 '@buger/probe-mcp'，即 probe-mcp 的 MCP 服务器实现。

注意:

'command' 和 'args' 的配置旨在简化 MCP 客户端的配置过程，使其能够方便地启动和连接 probe-mcp 服务器。用户无需手动下载或构建 probe-mcp 服务器，只需配置好启动命令，客户端即可自动处理服务器的启动和连接。

基本使用方法

启动 MCP 服务器: 当 MCP 客户端连接 probe-mcp 服务器时，客户端会根据配置自动启动服务器。通常你无需手动启动 probe-mcp 服务器。
在 AI 客户端中使用: 在支持 MCP 协议的 AI 客户端中（如集成了 MCP 客户端的代码编辑器或智能助手），配置上述服务器信息。
发起代码搜索: 在 AI 客户端中，使用自然语言或特定指令，指示 AI 使用 Probe 进行代码搜索。例如，你可以提问："使用 Probe 搜索关于 ranking algorithm 的实现" 或 "Do the probe and search my codebase for implementations of the ranking algorithm"。
查看搜索结果: AI 客户端会将你的搜索请求通过 MCP 协议发送到 probe-mcp 服务器，服务器调用 Probe 代码搜索工具进行搜索，并将结果返回给 AI 客户端展示。

通过以上步骤，你就可以在支持 MCP 协议的 AI 客户端中，利用 probe-mcp 提供的 MCP 服务器，便捷地使用 Probe 代码搜索工具来探索和理解你的代码库。

关键词