MCP-Grep

一个通过模型上下文协议 (MCP) 暴露 grep 功能的 grep 服务器实现。

安装

pip install mcp-grep

用法

MCP-Grep 作为一个服务器运行，可以被 MCP 兼容的客户端使用：

# 启动 MCP-Grep 服务器
mcp-grep-server

# 或者使用 MCP Inspector 进行交互式调试和测试
mcp-grep-inspector

该服务器暴露以下 MCP 功能：

• 资源: grep://info - 返回关于系统 grep 二进制文件的信息
• 工具: grep - 使用系统 grep 二进制文件在文件中搜索模式

特性

• 关于系统 grep 二进制文件的信息（路径、版本、支持的特性）
• 使用正则表达式在文件中搜索模式
• 支持常见的 grep 选项：
  • 忽略大小写匹配
  • 上下文行（匹配前后）
  • 最大匹配计数
  • 固定字符串匹配（非正则表达式）
  • 递归目录搜索
• 自然语言提示理解，更易于与 LLM 一起使用
• 通过 MCP Inspector 进行交互式调试和测试

API 使用示例

使用 MCP Python 客户端：

from mcp.client import MCPClient

# 连接到 MCP-Grep 服务器
client = MCPClient()

# 获取关于 grep 二进制文件的信息
grep_info = client.get_resource("grep://info")
print(grep_info)

# 在文件中搜索模式
result = client.use_tool("grep", {
    "pattern": "search_pattern",
    "paths": ["file.txt", "directory/"],
    "ignore_case": True,
    "recursive": True
})
print(result)

自然语言提示

MCP-Grep 理解自然语言提示，使其更易于与 LLM 一起使用。 示例：

# 基本搜索
在 log.txt 中搜索 'error'

# 忽略大小写搜索
查找 system.log 中所有 'WARNING' 实例，忽略大小写

# 带上下文行
在 error.log 中搜索 'exception'，并显示每个匹配项前后 3 行

# 递归搜索
在 src 目录及其子目录中查找所有 'deprecated' 的出现

# 固定字符串搜索（非正则表达式）
在 config.js 中搜索确切的字符串 '.*'

# 限制结果
在项目文件中只显示前 5 个 'TODO' 的出现

# 多个选项
在所有 .php 文件中不区分大小写地查找 'password'，显示 2 行上下文，并限制为 10 个结果

MCP Inspector 集成

MCP-Grep 包含一个 MCP Inspector 集成，用于交互式调试和测试：

# 使用 MCP-Grep 启动 MCP Inspector
mcp-grep-inspector

这将打开一个基于 Web 的 UI，您可以在其中：

• 浏览可用的资源和工具
• 使用不同的参数测试 grep 操作
• 查看格式化的结果
• 调试 grep 查询的问题

开发

# 克隆仓库
git clone https://github.com/erniebrodeur/mcp-grep.git
cd mcp-grep

# 以开发模式安装
pip install -e ".[dev]"

# 运行测试
pytest

许可证

MIT