Search MCP 使用说明

项目简介

Search MCP 是一个基于 Model Context Protocol (MCP) 构建的服务端应用。它就像一个为你AI助手(如 Claude Desktop、Cursor)定制的“本地搜索引擎”,能够让你的AI理解你的整个项目代码,并快速、准确地找到相关内容,无需手动复制粘贴文件。

主要功能点

  • 本地语义搜索:AI可以通过自然语言(例如“查找用户登录的逻辑”)搜索你的代码,而不是手动查找和粘贴文件。
  • 全本地化:你的代码和所有处理过程都只保存在你的电脑上,不会上传到任何云端,保证了隐私和安全。
  • 自动更新索引:当你修改或保存文件时,索引会自动更新,确保AI助手总是基于最新的代码回答问题。
  • 支持多种AI客户端:可以轻松配置到 Claude Desktop、Claude Code、Cursor、Windsurf 等流行的AI开发工具中。
  • 安全的路径防护:内置了保护机制,防止恶意路径遍历攻击,确保只索引你的项目文件。
  • 高性能:采用语义向量搜索,比传统文本搜索(如grep)效率高40倍以上,且每次查询占用的AI上下文令牌数更少。

安装步骤

  1. 环境要求:确保你的电脑已安装 Node.js (18或更高版本)。
  2. 快速安装:打开你的终端(命令行工具),导航到你的项目文件夹。
  3. 运行安装命令:执行以下命令,它会引导你完成配置,并自动为你检测和配置已安装的AI助手。
    npx @liraz-sbz/search-mcp setup
  4. 重启AI助手:安装完成后,请重启你使用的AI桌面应用(如 Claude Desktop 或 Cursor)。

服务器配置(供AI客户端使用)

Search MCP 服务器通常通过 'npx' 命令启动。你需要在你AI助手的MCP配置文件中添加以下配置项:

  • 服务器名称 (Server Name): 'search'
  • 启动命令 (Command): 'npx'
  • 命令参数 (Args): '["-y", "@liraz-sbz/search-mcp"]'
    • '-y' 参数表示自动同意所有提示,确保连接稳定。
    • '@liraz-sbz/search-mcp' 是要运行的包。

基本使用方法

配置并重启AI助手后,你就可以像平常一样和AI对话了。例如:

  • 提问:“这个项目的用户认证是怎么实现的?”
  • AI会自动搜索:AI会使用 Search MCP 服务器在你的代码库中查找最相关的代码片段,并基于这些信息来回答你。
  • 其他常用指令
    • 告诉AI“索引这个项目”,来为当前项目创建搜索索引。
    • 告诉AI“显示搜索索引状态”,来查看索引的统计信息。
  • 验证连接:在你的AI助手中输入 '/mcp',如果列表中能看到 'search',说明连接成功。

信息

分类

开发者工具