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サーバーを自動的にインストールするには、Smitheryを使用します。

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

手動インストール

pip install mcp-grep

💻 使用例

基本的な使用法

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)

高度な使用法

自然言語プロンプトを使用した例です。

# 基本的な検索
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クエリの問題をデバッグする

開発

# リポジトリをクローンする
git clone https://github.com/your-repository.git  # 実際のリポジトリのURLに置き換えてください
cd mcp-grep

# 依存関係をインストールする
pip install -r requirements.txt

# テストを実行する
python -m pytest tests/

🔧 技術詳細

このサーバーは以下のMCP機能を公開しています。

• リソース：grep://info - システムのgrepバイナリに関する情報を返す
• ツール：grep - システムのgrepバイナリを使用してファイル内のパターンを検索する

📄 ライセンス

[ここにライセンス情報を追加してください。例：MIT Licenseまたはその他の適用可能なオープンソースライセンス]

このドキュメントは、MCP-Grepプロジェクトのリファレンスガイドであり、インストール方法、使用方法、機能特性、開発ガイドを紹介しています。