项目简介

这是一个使用Python Flask框架构建的文件查找服务器。它允许用户通过简单的HTTP请求,根据文件路径片段在服务器的文件系统中搜索文件,并以JSON格式返回文件信息,包括文件名、完整路径、文件大小和创建时间。此服务器可以与Cline等MCP客户端集成,作为工具扩展 LLM 的能力。

主要功能点

  • 文件搜索: 根据用户提供的关键词在服务器指定目录下(默认为当前目录)搜索文件。
  • 详细文件信息: 返回搜索结果,包含文件名、完整路径、文件大小和创建时间等详细信息。
  • HTTP接口: 通过标准的HTTP GET请求进行文件搜索,易于集成和使用。
  • Cline 集成: 可以方便地配置为 Cline MCP 服务器,为 Cline 提供文件查找功能。

安装步骤

  1. 环境准备: 确保您的计算机上已安装 Python 3.1 或更高版本。
  2. 下载仓库: 下载或克隆此 GitHub 仓库到本地。
  3. 安装依赖: 在仓库根目录下,使用 pip 安装 Flask 依赖:
    pip install flask

服务器配置

要将此服务器配置为 Cline 的 MCP 服务器,您需要在 Cline 的配置文件中添加 'mcpServers' 配置项。以下是一个示例配置,您可以将其添加到 Cline 的配置文件中:

{
    "mcpServers": {
      "file-finder-mcp": {
        "command": "py", // 启动服务器的命令,这里使用 python 解释器来运行 Python 脚本
        "args": [
          "main.py"  // 服务器启动脚本的文件名
        ],
        "autoApprove": ["search"], // 允许 Cline 自动批准调用的工具名称,这里指 /search 接口
        "disabled": false // 设置为 false 表示启用此服务器
        }
    }
}

配置参数说明:

  • 'server name': 'file-finder-mcp' - 服务器名称,可以自定义,用于在 Cline 中标识和引用此服务器。
  • 'command': 'py' - 运行服务器的命令。由于服务器是 Python 脚本,这里使用 'py' (或 'python',取决于您的系统配置) 来调用 Python 解释器。
  • 'args': '["main.py"]' - 传递给 'command' 的参数,这里指定服务器启动脚本为 'main.py'。
  • 'autoApprove': '["search"]' - 列出可以被 Cline 自动批准执行的工具名称。这里 '"search"' 对应服务器提供的 '/search' 接口,意味着 Cline 可以直接调用文件搜索功能,无需用户手动批准。
  • 'disabled': 'false' - 布尔值,用于启用或禁用此服务器。'false' 表示启用,'true' 表示禁用。

基本使用方法

  1. 启动服务器: 在仓库根目录下打开终端,运行以下命令启动 Flask 服务器:

    python main.py

    服务器默认会在 'http://127.0.0.1:5000' 启动。

  2. 发送搜索请求: 使用浏览器、curl 或其他 HTTP 客户端,访问以下 URL 进行文件搜索:

    http://127.0.0.1:5000/search?query=<你的文件路径片段>

    将 '<你的文件路径片段>' 替换为您想要搜索的文件名或路径片段。例如,搜索包含 "test" 的文件,可以访问:

    http://127.0.0.1:5000/search?query=test
  3. 查看结果: 服务器会返回一个 JSON 数组,其中包含了匹配到的文件信息,例如:

    [
      {
        "name": "test_file.txt",
        "path": "C:/Users/Example/Documents/test_file.txt",
        "size": 1024,
        "created": "2025-03-17T12:00:00"
      }
    ]

修改默认搜索路径

默认情况下,服务器会在当前目录 ('.') 下搜索文件。如果您想要修改搜索的根目录,请编辑 'main.py' 文件,找到 'search_files' 函数的定义:

def search_files(query, search_path='.'):

将 'search_path='.'' 中的 ''.'' 修改为您希望的搜索根目录的路径。例如,修改为 ''C:/'' 将在 C 盘根目录下搜索。

信息

分类

数据库与文件