File Find Mcp

File Find Mcp

By joisun GitHub

-

file-find-mcp file-search
Overview

what is File Find MCP?

File Find MCP is a specialized Model Context Protocol (MCP) server designed for fast file searching within a filesystem, utilizing Rust and powered by ripgrep for high-performance searches.

how to use File Find MCP?

To use File Find MCP, clone the repository from GitHub, build the project using Cargo, and configure it in your MCP-compatible tools by adding the server command to your settings.

key features of File Find MCP?

  • High-performance search using ripgrep
  • File content reader for displaying text file contents
  • Smart file detection that skips binary files
  • MCP integration for compatibility with AI assistants
  • Fallback mechanism using pure Rust implementation if ripgrep is unavailable

use cases of File Find MCP?

  1. Quickly searching for keywords in large codebases
  2. Reading and displaying contents of specific text files
  3. Integrating with AI systems that support the Model Context Protocol for enhanced file search capabilities

FAQ from File Find MCP?

  • What is ripgrep?

Ripgrep is a command-line search tool that recursively searches your current directory for a regex pattern.

  • Do I need to install ripgrep?

Yes, ripgrep must be installed for optimal performance, but a pure Rust implementation is available as a fallback.

  • Is File Find MCP open source?

Yes, File Find MCP is open source and available on GitHub.

Content

File Find MCP

A specialized Model Context Protocol (MCP) server for fast file search within a filesystem, built with Rust and powered by ripgrep.

🔍 Overview

File Find MCP is a tool that provides powerful search capabilities for files in a specified directory. It uses ripgrep to perform high-performance searches through file content efficiently.

This project implements the Model Context Protocol (MCP), making it compatible with AI assistants and other systems that support the protocol.

✨ Features

  • High-performance search: Uses ripgrep for extremely fast searches across directory structures
  • File content reader: Read and display the content of specific text files
  • Smart file detection: Automatically identifies text files and skips binary files
  • MCP integration: Works with systems that support the Model Context Protocol
  • Fallback mechanism: Uses pure Rust implementation when ripgrep command is not available

📋 Prerequisites

Before using this tool, make sure you have:

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

📦 Building

To 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 available at target/release/file-find-mcp.

⚙️ Configuration

Add this to your MCP settings (in Cursor, Claude, or other MCP-compatible 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 to your cloned repository.

🛠️ Available Tools

Search Tool

  • Description: Search for keywords in text files within a specified directory
  • Parameters:
    • directory: Path to the directory to search
    • keyword: Keyword to search for

File Content Reader Tool

  • Description: Read and display the content of a specific file
  • Parameters:
    • file_path: Path to the file to read

📄 License

MIT License

🙏 Acknowledgements

  • ripgrep for the lightning-fast search capabilities
  • RMCP for the Model Context Protocol implementation
  • This project is forked from file-search-mcp and modified to use ripgrep for improved search efficiency
No tools information available.
No content found.