MCP Grep

🚀 MCP-Grep 服務器

MCP-Grep 服務器通過模型上下文協議（MCP）暴露 grep 功能，為用戶提供便捷的文件搜索服務，支持正則表達式搜索、常見 grep 選項，還能理解自然語言提示，與大語言模型結合使用更方便。

🚀 快速開始

MCP-Grep 作為服務器運行，可以通過 MCP 兼容客戶端使用：

# 啟動 MCP-Grep 服務器
mcp-grep-server

# 或通過 MCP 檢查器進行交互式調試和測試
mcp-grep-inspector

✨ 主要特性

• 系統grep二進制文件信息（路徑、版本、支持的功能）
• 使用正則表達式在文件中搜索模式
• 支持常見的grep選項：
  • 不區分大小寫的匹配
  • 匹配上下文行（前綴和後綴）
  • 最大匹配數
  • 固定字符串匹配（非正則表達式）
  • 遞歸目錄搜索
• 大語言模型（LLM）自然語言提示理解，使用更方便
• 通過MCP檢查器進行交互式調試和測試

📦 安裝指南

通過 Smithery 安裝

要自動為Claude Desktop安裝Grep Server，可通過Smithery進行：

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

手動安裝

pip install mcp-grep

💻 使用示例

基礎用法

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中搜索精確字符串‘.*’

# 結果限制
顯示項目文件中‘TODO’的前5個匹配項

# 多選項組合
在所有.php文件中不區分大小地查找‘password’，顯示2行上下文，並限制為10個結果

MCP 檢查器集成用法

MCP-Grep 包含一個MCP檢查器集成，用於交互式調試和測試：

# 啟動包含MCP-Grep的MCP檢查器
mcp-grep-inspector

這將打開一個基於Web的UI界面，您可以：

• 探索可用資源和工具
• 使用不同參數測試grep操作
• 查看格式化結果
• 調試您的grep查詢問題

📚 詳細文檔

該服務器暴露了以下MCP功能：

• 資源：grep://info - 返回有關係統grep二進制文件的信息
• 工具：grep - 使用系統grep二進制文件在文件中搜索模式

🔧 技術細節

開發步驟

# 克隆倉庫
git clone https://github.com/your-repository.git  # 請替換為實際倉庫地址
cd mcp-grep

# 安裝依賴項
pip install -r requirements.txt

# 運行測試
python -m pytest tests/

📄 許可證

[此處添加許可證信息，例如MIT License或其他適用的開源許可證]

此文檔為MCP-Grep項目的參考指南，介紹了其安裝、使用方法、功能特性以及開發指導。