Mcp Grep

What is Mcp Grep about?

Mcp Grep provides an MCP server that wraps the local grep binary, allowing clients to retrieve grep information and perform search operations using MCP calls or natural‑language prompts.

How to use Mcp Grep?

1. Install

   npx -y @smithery/cli install @erniebrodeur/mcp-grep --client claude
   # or manual Python install
   pip install mcp-grep
   

2. Start the server

   mcp-grep-server
   

   or launch the interactive inspector with mcp-grep-inspector.
3. Interact via MCP client

   from mcp.client import MCPClient
   client = MCPClient()
   info = client.get_resource("grep://info")
   result = client.use_tool("grep", {
       "pattern": "error",
       "paths": ["logs/"],
       "ignore_case": True,
       "recursive": True
   })
   

Key features of Mcp Grep

• Retrieves system grep binary details (path, version, capabilities).
• Executes pattern searches with regular expressions or fixed‑string mode.
• Supports common grep options: case‑insensitive, context lines, max match count, recursive directory traversal.
• Accepts natural‑language prompts, simplifying use with LLMs.
• Provides an MCP Inspector UI for interactive debugging and testing.

Use cases of Mcp Grep

• Automated log analysis within AI assistants.
• Integrating grep‑style search into custom MCP‑based workflows.
• Rapid prototyping of text‑search features without writing shell scripts.
• Debugging and exploring file contents through the web‑based MCP Inspector.

FAQ from the Mcp Grep

Q: Do I need to have grep installed? A: Yes, Mcp Grep relies on the system grep binary.

Q: Can I run the server on Windows? A: The server works on any OS where a compatible grep executable is available.

Q: How do I limit the number of matches? A: Use the max_matches parameter in the tool request.

Q: Is there a way to see available resources and tools? A: Launch mcp-grep-inspector to explore resources like grep://info and the grep tool.

MCP-Grep

A grep server implementation that exposes grep functionality through the Model Context Protocol (MCP).

Installation

Installing via Smithery

To install Grep Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @erniebrodeur/mcp-grep --client claude

Manual Installation

pip install mcp-grep

Usage

MCP-Grep runs as a server that can be used by MCP-compatible clients:

# Start the MCP-Grep server
mcp-grep-server

# Or use the MCP Inspector for interactive debugging and testing
mcp-grep-inspector

The server exposes the following MCP functionality:

• Resource: grep://info - Returns information about the system grep binary
• Tool: grep - Searches for patterns in files using the system grep binary

Features

• Information about the system grep binary (path, version, supported features)
• Search for patterns in files using regular expressions
• Support for common grep options:
  • Case-insensitive matching
  • Context lines (before and after matches)
  • Maximum match count
  • Fixed string matching (non-regex)
  • Recursive directory searching
• Natural language prompt understanding for easier use with LLMs
• Interactive debugging and testing through MCP Inspector

Example API Usage

Using the MCP Python client:

from mcp.client import MCPClient

# Connect to the MCP-Grep server
client = MCPClient()

# Get information about the grep binary
grep_info = client.get_resource("grep://info")
print(grep_info)

# Search for a pattern in files
result = client.use_tool("grep", {
    "pattern": "search_pattern",
    "paths": ["file.txt", "directory/"],
    "ignore_case": True,
    "recursive": True
})
print(result)

Natural Language Prompts

MCP-Grep understands natural language prompts, making it easier to use with LLMs. Examples:

# Basic search
Search for 'error' in log.txt

# Case-insensitive search
Find all instances of 'WARNING' regardless of case in system.log

# With context lines
Search for 'exception' in error.log and show 3 lines before and after each match

# Recursive search
Find all occurrences of 'deprecated' in the src directory and its subdirectories

# Fixed string search (non-regex)
Search for the exact string '.*' in config.js

# Limited results
Show me just the first 5 occurrences of 'TODO' in the project files

# Multiple options
Find 'password' case-insensitively in all .php files, show 2 lines of context, and limit to 10 results

MCP Inspector Integration

MCP-Grep includes an MCP Inspector integration for interactive debugging and testing:

# Start the MCP Inspector with MCP-Grep
mcp-grep-inspector

This opens a web-based UI where you can:

• Explore available resources and tools
• Test grep operations with different parameters
• View formatted results
• Debug issues with your grep queries

Development

# Clone the repository
git clone https://github.com/erniebrodeur/mcp-grep.git
cd mcp-grep

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

License

MIT