使用说明

项目简介

Everything Search MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为 LLM 客户端提供本地文件搜索能力。它允许用户通过 LLM 客户端,方便快捷地搜索 Windows、macOS 和 Linux 系统中的文件和文件夹。该服务器集成了各平台原生的搜索工具,例如 Windows 上的 Everything SDK,macOS 上的 mdfind 命令,以及 Linux 上的 locate/plocate 命令,从而实现高效且准确的本地文件检索。

主要功能点

  • 跨平台文件搜索: 支持 Windows, macOS, Linux 三大操作系统。
  • 集成原生搜索工具: 充分利用各平台高效的本地搜索技术,提供快速搜索体验。
  • 灵活的搜索参数: 支持多种搜索参数,如查询关键词、最大结果数、路径匹配、大小写敏感、全字匹配、正则表达式等,满足不同的搜索需求。
  • 详细的搜索结果: 返回文件路径、文件名、大小、创建/修改/访问日期等详细信息。
  • 易于安装和配置: 提供多种安装方式,并提供详细的配置说明,方便用户快速部署和使用。
  • 标准 MCP 协议: 基于 MCP 协议开发,可与任何兼容 MCP 协议的 LLM 客户端配合使用。

安装步骤

您可以通过 pip 或 uv (推荐) 安装 Everything Search MCP Server。

  • 使用 uv (推荐)

    推荐使用 uv 进行安装和运行,无需额外安装步骤。uvx 可以直接运行 'mcp-server-everything-search'。请确保您已安装 uv。

  • 使用 pip

    您可以使用 pip 命令安装 'mcp-server-everything-search':

    pip install mcp-server-everything-search

    安装完成后,可以通过以下命令运行服务器:

    python -m mcp_server_everything_search

服务器配置

MCP 服务器是为 MCP 客户端设计的,例如 Claude Desktop。要将 Everything Search MCP Server 与 MCP 客户端连接,您需要在客户端的配置文件中添加服务器配置信息。以下是针对不同平台和安装方式的配置示例 (以 Claude Desktop 的 'claude_desktop_config.json' 文件为例):

  • Windows (使用 uvx)

    "mcpServers": {
      "everything-search": {
        "command": "uvx",
        "args": ["mcp-server-everything-search"],
        "env": {
          "EVERYTHING_SDK_PATH": "path/to/Everything-SDK/dll/Everything64.dll"
        }
      }
    }
    • 'command': 启动服务器的命令,这里使用 'uvx' 直接运行。
    • 'args': 传递给命令的参数,'mcp-server-everything-search' 是服务器包的名称。
    • 'env': 环境变量配置。 Windows 平台必须配置 'EVERYTHING_SDK_PATH' 环境变量,指向 Everything SDK 中 'Everything64.dll' 文件的路径。 请将 'path/to/Everything-SDK/dll/Everything64.dll' 替换为实际的 SDK 路径。
  • Windows (使用 pip 安装)

    "mcpServers": {
      "everything-search": {
        "command": "python",
        "args": ["-m", "mcp_server_everything_search"],
        "env": {
          "EVERYTHING_SDK_PATH": "path/to/Everything-SDK/dll/Everything64.dll"
        }
      }
    }
    • 'command': 启动服务器的命令,这里使用 'python -m mcp_server_everything_search' 运行 pip 安装的包。
    • 'args': 传递给命令的参数。
    • 'env': 环境变量配置,与 uvx 方式相同。
  • Linux 和 macOS (使用 uvx)

    "mcpServers": {
      "everything-search": {
        "command": "uvx",
        "args": ["mcp-server-everything-search"]
      }
    }
    • 'command': 启动服务器的命令,使用 'uvx' 运行。
    • 'args': 传递给命令的参数。
    • Linux 和 macOS 平台无需额外环境变量配置。
  • Linux 和 macOS (使用 pip 安装)

    "mcpServers": {
      "everything-search": {
        "command": "python",
        "args": ["-m", "mcp_server_everything_search"]
      }
    }
    • 'command': 启动服务器的命令,使用 'python -m mcp_server_everything_search' 运行 pip 安装的包。
    • 'args': 传递给命令的参数。
    • Linux 和 macOS 平台无需额外环境变量配置。

基本使用方法

  1. 确保 MCP 服务器已成功安装并根据您的平台和客户端配置正确启动。
  2. 在您的 MCP 客户端(例如 Claude Desktop)中,配置并启用 'everything-search' 服务器。
  3. 在客户端中,您可以使用 'search' 工具进行文件搜索。例如,您可以向 LLM 发送指令,要求其调用 'search' 工具,并提供搜索关键词和参数。
  4. 服务器将返回搜索结果,客户端可以解析并展示这些结果。

具体的工具调用方式和参数请参考仓库 README.md 文件中 "Tools" 和 "Search Syntax Guide" 部分的说明。

注意:

  • Windows 用户 必须预先安装 Everything 搜索工具 并下载 Everything SDK,并正确配置 'EVERYTHING_SDK_PATH' 环境变量。
  • Linux 用户 需要安装 'locate' 或 'plocate',并更新数据库 ('sudo updatedb' 或 'sudo /etc/cron.daily/mlocate')。
  • macOS 用户 无需额外配置。

信息

分类

桌面与硬件