Zoekt MCP

🚀 Zoekt MCP Server

Zoektをベースにしたコード検索機能を備えた、Model Context Protocol (MCP) サーバーです。Sourcegraphが使用する索引付きコード検索エンジンであるZoektを活用しています。

🚀 クイックスタート

このMCPサーバーは、コードリポジトリ用に最適化されたテキスト検索エンジンであるZoektと統合されています。Zoektは、大規模なコードベース全体での検索にトライグラムベースのインデックスを提供し、コードパターンを見つけて理解する必要のあるAIアシスタントに適しています。

✨ 主な機能

• コード検索：Zoektのトライグラムインデックスを使用してコードベース全体を検索します。
• 高度なクエリ言語：正規表現パターン、ファイルフィルター、言語フィルター、およびブール演算子をサポートします。
• リポジトリ探索：名前でリポジトリを検索し、その構造を探索します。
• コンテンツ取得：リポジトリのファイルやディレクトリを閲覧します。
• AI統合：ガイド付き検索プロンプトを使用したLLM統合を目的として設計されています。

📦 インストール

前提条件

• Zoektインスタンス：実行中のZoekt検索サーバーにアクセスする必要があります。セットアップ手順については、Zoektのドキュメントを参照してください。
• Python 3.10+：MCPサーバーを実行するために必要です。
• UV (オプション)：依存関係の管理を容易にするための最新のPythonパッケージマネージャーです。

UVを使用する (推奨)

# 依存関係をインストールする
uv sync

# サーバーを起動する
uv run zoekt-mcp

pipを使用する

# 仮想環境を作成する
python -m venv venv
source venv/bin/activate  # Windowsの場合は: venv\Scripts\activate

# パッケージをインストールする
pip install -e .

# サーバーを起動する
python -m src.main

Dockerを使用する

# イメージをビルドする
docker build -t zoekt-mcp .

# デフォルトのポートでコンテナを起動する
docker run -p 8000:8000 -p 8080:8080 \
  -e ZOEKT_API_URL=http://your-zoekt-instance \
  zoekt-mcp

# または、カスタムポートで起動する
docker run -p 9000:9000 -p 9080:9080 \
  -e ZOEKT_API_URL=http://your-zoekt-instance \
  -e MCP_SSE_PORT=9000 \
  -e MCP_STREAMABLE_HTTP_PORT=9080 \
  zoekt-mcp

📚 ドキュメント

設定

必須環境変数

• ZOEKT_API_URL：Zoekt検索インスタンスのURL

オプションの環境変数

• MCP_SSE_PORT：SSEサーバーのポート (デフォルト: 8000)
• MCP_STREAMABLE_HTTP_PORT：HTTPサーバーのポート (デフォルト: 8080)

AIツールとの連携

Cursor

MCPサーバーを起動した後、 .cursor/mcp.json ファイルに以下を追加します。

{
  "mcpServers": {
    "zoekt": {
      "url": "http://localhost:8080/zoekt/mcp/"
    }
   }
}

MCPツール

このサーバーは、AIアシスタント用の3つの強力なツールを提供します。

🔍 search

Zoektの高度なクエリ構文を使用して、インデックス付きのコードベース全体を検索します。正規表現、言語フィルター、およびブール演算子をサポートしています。

📖 search_prompt_guide

特定の目的に基づいて、効果的な検索クエリを構築するためのコンテキスト認識ガイドを生成します。

📂 fetch_content

インデックス付きのリポジトリからファイルの内容を取得したり、ディレクトリ構造を探索したりします。

開発

コードのチェックと整形

# コードスタイルをチェックする
uv run ruff check src/

# コードを整形する
uv run ruff format src/