Skip to main content

MCP server for fast file search using fd - a modern find alternative

Project description

fd-mcp

A Model Context Protocol (MCP) server that provides fast file search capabilities using fd, a modern alternative to the traditional find command.

What is fd-mcp?

fd-mcp bridges fd with AI assistants like Claude Code through the Model Context Protocol. It exposes fd's powerful file search capabilities as MCP tools, enabling AI assistants to efficiently navigate and search codebases.

Why fd?

fd offers significant advantages over traditional file search tools:

  • Blazing Fast: Written in Rust, fd is often 5-10x faster than find for typical searches
  • User-Friendly Syntax: Simple, intuitive patterns instead of cryptic flags (fd pattern vs find -name "*pattern*")
  • Smart Defaults: Automatically respects .gitignore and skips hidden files/directories
  • Colorized Output: Enhanced readability with syntax highlighting
  • Parallel Execution: Leverages multiple CPU cores for faster searches
  • Regex Support: Built-in regex pattern matching without complex syntax

Use Cases

This MCP server is particularly useful for:

  • Codebase Navigation: Quickly locate files by name, extension, or pattern across large projects
  • Project Analysis: Find all files of a specific type (e.g., all Python test files, all configuration files)
  • Code Exploration: Help AI assistants understand project structure by efficiently listing directories and files
  • Pattern Matching: Search for files using regex patterns (e.g., find all migration files, test suites)
  • Selective Searches: Filter by file type, depth, or exclude specific patterns
  • Performance: Fast searches even in monorepos or large codebases with thousands of files

Prerequisites

Install fd:

# Ubuntu/Debian
sudo apt install fd-find

# macOS
brew install fd

# Arch
pacman -S fd

Install ripgrep (required for fd_search_content tool):

# Ubuntu/Debian
sudo apt install ripgrep

# macOS
brew install ripgrep

# Arch
pacman -S ripgrep

# Or download from: https://github.com/BurntSushi/ripgrep/releases

Installation

cd fd-mcp
pip install -e .

Usage with Claude Code

Add to your Claude Code MCP settings (~/.claude.json):

{
  "mcpServers": {
    "fd": {
      "command": "fd-mcp"
    }
  }
}

Or run directly:

{
  "mcpServers": {
    "fd": {
      "command": "python",
      "args": ["-m", "fd_mcp.server"],
      "cwd": "/home/th/dev/os/fd-mcp"
    }
  }
}

🚀 Claude Code Integration Best Practices

Once configured, Claude Code will have access to all fd-mcp tools. Here's how to get the most out of them:

Quick Start Commands

The project includes helpful slash commands to get started:

  • /find-py - Find all Python files (demonstrates fd_search)
  • /search-code - Search code patterns (demonstrates fd_search_content)
  • /recent - Show recently modified files (demonstrates fd_recent_files)
  • /count-files - Count files by type (demonstrates fd_count)
  • /demo-mcp - Run a full demonstration of all tools

Tool Selection Guide

When Claude Code needs to find files:

  • Use: mcp__fd__fd_search(extension="py")
  • Instead of: bash find . -name "*.py"
  • Why: 5-10x faster, respects .gitignore automatically

When Claude Code needs to search code:

  • Use: mcp__fd__fd_search_content(search_pattern="TODO", extension="py")
  • Instead of: bash find . -exec grep "TODO" {} \;
  • Why: 10-100x faster, single operation, shows context

When Claude Code needs to find recent changes:

  • Use: mcp__fd__fd_recent_files(hours=24)
  • Instead of: bash find . -mtime -1
  • Why: Intuitive time params, faster execution

Performance Benefits

The tools are optimized for AI assistant workflows:

Operation Traditional fd-mcp Speedup
Find 1000 Python files 2.5s 0.3s 8x faster
Search "TODO" in files 15s 0.5s 30x faster
Find files changed today 3s 0.4s 7x faster
Count all files 2s 0.25s 8x faster

Learning Resources

  • See CLAUDE.md for comprehensive usage patterns and examples
  • Check .claude/commands/ for ready-to-use slash commands
  • Review tool descriptions in Claude Code for quick reference

Tools

fd_search

Replaces: find, locate commands

Search for files and directories using fd (5-10x faster than find).

Parameter Type Description
pattern string Regex pattern (optional)
path string Search directory (default: ".")
type string f=file, d=dir, l=symlink, x=exec, e=empty
extension string Filter by extension
hidden bool Include hidden files
no_ignore bool Don't respect .gitignore
max_depth int Max search depth
exclude string Glob pattern to exclude
case_sensitive bool Case-sensitive search
absolute_path bool Return absolute paths
max_results int Limit results (default: 100)

fd_search_content ⭐

Replaces: find -exec grep, find | xargs grep commands

Search for content within files using fd+ripgrep. This is the key tool that replaces find . -exec grep pattern {} \; style commands.

Parameter Type Description
search_pattern string Text/regex to search in files (required)
file_pattern string Filter files by name pattern
path string Search directory (default: ".")
extension string Filter by extension (e.g., "py", "js")
type string Filter by type (f=file, d=dir, etc.)
hidden bool Include hidden files
no_ignore bool Don't respect .gitignore
case_sensitive bool Case-sensitive search
context_lines int Lines of context around matches
max_results int Max files to search (default: 100)

Note: Requires ripgrep (rg) to be installed.

fd_exec

Replaces: find -exec, find | xargs commands

Execute a command on files found by fd. Use {} as placeholder for filename.

Parameter Type Description
command string Command to run (use {} for filename)
pattern string File name pattern
path string Search directory (default: ".")
type string Filter by type
extension string Filter by extension
hidden bool Include hidden files
no_ignore bool Don't respect .gitignore
max_files int Max files to process (default: 100)

fd_recent_files

Replaces: find -mtime, find -newermt commands

Find recently modified files.

Parameter Type Description
path string Search directory (default: ".")
hours int Modified within N hours (default: 24)
type string Filter by type
extension string Filter by extension
max_results int Limit results (default: 50)

fd_count

Replaces: find | wc -l commands

Count files matching a pattern.

Examples

Basic File Search

Find all Python files:

fd_search(extension="py")

Find test files:

fd_search(pattern="test_.*", extension="py")

List directories only:

fd_search(type="d", max_depth=2)

Content Search (replaces find -exec grep)

Find "TODO" in all Python files:

fd_search_content(search_pattern="TODO", extension="py")

Find "import React" in JavaScript/TypeScript files with context:

fd_search_content(
    search_pattern="import.*React",
    extension="tsx",
    context_lines=2
)

Find error handling in specific directory:

fd_search_content(
    search_pattern="try.*except",
    path="src/",
    extension="py"
)

Execute Commands on Files

Count lines in all Python files:

fd_exec(command="wc -l {}", extension="py")

Format all JavaScript files:

fd_exec(command="prettier --write {}", extension="js")

Find Recent Changes

Files modified in last 2 hours:

fd_recent_files(hours=2)

Recent Python files modified in last day:

fd_recent_files(hours=24, extension="py")

Command Replacements

Old Command New MCP Tool
find . -name "*.py" fd_search(extension="py")
find . -type f -exec grep "TODO" {} \; fd_search_content(search_pattern="TODO")
find . -name "*.js" -exec prettier {} \; fd_exec(command="prettier {}", extension="js")
find . -mtime -1 fd_recent_files(hours=24)
find . -type f | wc -l fd_count(type="f")

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fd_mcp-0.2.1.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fd_mcp-0.2.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file fd_mcp-0.2.1.tar.gz.

File metadata

  • Download URL: fd_mcp-0.2.1.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fd_mcp-0.2.1.tar.gz
Algorithm Hash digest
SHA256 028f40be57258d20457396a823473b411906f460328da7b4c9e8ef26fe6cd0ea
MD5 e2bcfa60a939de807b1ff92da3fc3d93
BLAKE2b-256 474fdca08b1bd42f6bb6127b2ce6f8eeb4c9b5b99163362c21d0910effb22e68

See more details on using hashes here.

Provenance

The following attestation bundles were made for fd_mcp-0.2.1.tar.gz:

Publisher: python-publish.yml on thhart/fd-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fd_mcp-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: fd_mcp-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fd_mcp-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc755c7f04486b357ddd1bee9b9a7bafe7aa3b220dca0cdbf74043c9dd2d1948
MD5 6732d7d29eadcedf309956e5bfc31e1b
BLAKE2b-256 168b882bfb0ec4e512a7ac7c031d0d5578e08ad32165c20c1b4aed23a283d2cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for fd_mcp-0.2.1-py3-none-any.whl:

Publisher: python-publish.yml on thhart/fd-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page