File Search Service

🚀 项目本地启动指南

本项目旨在为用户提供便捷的本地启动方案。以下将详细介绍如何在不同操作系统上启动项目，以及创建虚拟环境、安装依赖项和配置服务器的具体步骤。

🚀 快速开始

安装项目工具

在 macOS 上

在终端中执行以下命令：

curl -LsSf https://astral.sh/uv/install.sh | sh

在 Windows 上

打开 PowerShell 并运行以下命令：

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

创建虚拟环境并安装依赖项（可选，但推荐）

1. 进入项目目录

在终端中执行以下命令：

cd /Users/rami/Desktop/file-search

2. 创建虚拟环境（如果需要）

您可以使用 venv 或 uv venv 来创建虚拟环境。

使用 venv 创建：

python3 -m venv .venv

或者使用 uv venv 创建：

uv venv .venv

3. 激活虚拟环境

• macOS/Linux：

source .venv/bin/activate

• Windows：

.venv\Scripts\activate

4. 使用 uv 安装项目依赖

在激活虚拟环境后，执行以下命令：

uv pip install -r pyproject.toml

配置服务器

将服务器添加到扩展的配置文件中，示例配置如下：

"file-search": {
  "command": "uv",
  "args": [
    "--directory",
    "/Users/rami/Desktop/file-search", // 文件所在的路径。
    "run",
    "main.py"
  ]
}

启动服务器并使用工具

完成上述步骤后，服务器应该可以启动运行。请让您的客户使用其名称为 file-search 的工具，并传递参数。示例如下：

<use_mcp_tool>
  <server_name>file-search</server_name>
  <tool_name>file_search</tool_name>
  <arguments>
    {
      "query": "your_search_term"
    }
  </arguments>
</use_mcp_tool>

项目截图