File Search Service

🚀 File Search Project

This project provides a file search tool. You can install and run it locally following the steps below.

🚀 Quick Start

📦 Installation

To start this project locally, please follow these steps:

On macOS:

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

On Windows:

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

Create a virtual environment and install dependencies (optional but recommended):

You may need to create a virtual environment and install project dependencies within it. Please perform the following steps:

1. Navigate to the project directory:

   cd /Users/rami/Desktop/file-search
   

2. Create a virtual environment (if needed): You can use venv or uv venv:

   python3 -m venv .venv
   

   Or

   uv venv .venv
   

3. Activate the virtual environment: macOS/Linux:

   source .venv/bin/activate
   

   Windows:

   .venv\Scripts\activate
   

4. Install project dependencies using uv:

   uv pip install -r pyproject.toml
   

💻 Usage Examples

Basic Usage

Subsequently, add the server to the extension's configuration file:

"file-search": {
  "command": "uv",
  "args": [
    "--directory",
    "/Users/rami/Desktop/file-search", // The path where the files are located.
    "run",
    "main.py"
  ]
}

After that, the server should be able to start and run. Please let your customers use the tool named file-search and pass parameters. Example:

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