File Find MCP

🚀 File Find MCP

A Model Context Protocol (MCP) server designed for rapid file search, written in Rust for the file system and powered by ripgrep for high-speed searches.

🚀 Quick Start

File Find MCP is a tool that offers powerful search capabilities for files within a specified directory. It leverages ripgrep for efficient content searches, delivering extremely fast performance. This project implements the Model Context Protocol (MCP), making it compatible with AI assistants and other systems that support this protocol.

✨ Features

• High-performance Search: Utilizes ripgrep for ultra-fast content searches within directory structures.
• File Content Reader: Can read and display the content of specific text files.
• Intelligent File Recognition: Automatically identifies text files and skips binary files.
• MCP Integration: Compatible with systems supporting the Model Context Protocol.
• Fallback Mechanism: When the ripgrep command is unavailable, a pure Rust implementation serves as a backup.

📋 Prerequisites

Before using this tool, ensure the following are installed:

1. Rust - Install Rust
2. ripgrep - On macOS, you can install it via Homebrew:

   brew install ripgrep
   

📦 Installation

Build the project:

# Clone the repository
git clone https://github.com/joisun/file-find-mcp
cd file-find-mcp

# Build in release mode
cargo build --release

The compiled binary will be located at target/release/file-find-mcp.

⚙️ Configuration

Add the following to your MCP settings (e.g., in Cursor, Claude, or other MCP-supported tools):

{
  "mcpServers": {
    "file-find-mcp": {
      "command": "/path/to/your/file-find-mcp/target/release/file-find-mcp"
    }
  }
}

Replace /path/to/your/file-find-mcp with the actual path where you cloned the repository.

🛠️ Available Tools

Search Tool

• Description: Searches for keywords in text files within a specified directory.
• Parameters:
  • directory: The path of the directory to search.
  • keyword: The keyword to search for.

File Content Reader Tool

• Description: Reads and displays the content of a specific file.
• Parameters:
  • file_path: The path of the file to read.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

• ripgrep - Thanks for its lightning-fast search performance.
• RMCP - Thanks for the implementation of the Model Context Protocol.
• This project is forked from file-search-mcp and modified to use ripgrep for improved search efficiency.