Code Index MCP

Code Index MCP

Code Index MCP は、LLM がプロジェクトディレクトリ内のコードをインデックス化、検索、分析できるようにする Model Context Protocol サーバーです。

機能

• プロジェクトのファイル構造をインデックス化して移動する
• コード内の特定のパターンを検索する
• 詳細なファイル概要を取得する
• コードの構造と複雑さを分析する
• 複数のプログラミング言語に対応する
• プロジェクト設定を永続的に保存する

インストール

このプロジェクトでは、環境管理と依存関係のインストールに uv を使用します。

1. Python 3.10 以降がインストールされていることを確認します

2. uv をインストールします（推奨）：

   # Windows
   powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
   # macOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. コードを取得します：

   # Clone the repository
   git clone https://github.com/your-username/code-index-mcp.git
   

使用方法

サーバーを直接実行する

# Run directly with uv - no additional dependency installation needed
uv run run.py

UV は、プロジェクトの設定に基づいてすべての依存関係を自動的にインストールします。

Claude Desktop との統合

Code Index MCP は Claude Desktop と簡単に統合できます。

1. UV がインストールされていることを確認します（上記のインストールのセクションを参照）

2. Claude Desktop の設定ファイルを探すか、作成します：

   • Windows：%APPDATA%\Claude\claude_desktop_config.json
   • macOS/Linux：~/Library/Application Support/Claude/claude_desktop_config.json

3. 次の設定を追加します（実際のパスに置き換えてください）：

   Windows の場合：

   {
     "mcpServers": {
       "code-indexer": {
         "command": "uv",
         "args": [
            "--directory",
            "C:\\Users\\username\\path\\to\\code-index-mcp",
            "run",
            "run.py"
          ]
       }
     }
   }
   

   macOS/Linux の場合：

   {
     "mcpServers": {
       "code-indexer": {
         "command": "uv",
         "args": [
            "--directory",
            "/home/username/path/to/code-index-mcp",
            "run",
            "run.py"
          ]
       }
     }
   }
   

   注：--directory オプションは重要です。これにより、uv が正しいプロジェクトディレクトリで実行され、すべての依存関係を正しく読み込めるようになります。

4. Claude Desktop を再起動すると、Code Indexer を使用してコードプロジェクトを分析できます

手動で依存関係をインストールする必要はありません。サーバーの実行時に、UV がすべての依存関係を自動的に処理します。

基本的なワークフロー

1. プロジェクトパスの設定（最初に必ず行う手順）：

   • 初めて使用する際は、分析対象のプロジェクトパスを設定する必要があります
   • Claude への指示：「プロジェクトを分析したいので、プロジェクトパスの設定を手伝ってください」
   • プロジェクトディレクトリの完全なパスを指定します

2. コード検索：

   • 特定のキーワードやパターンを検索します：「プロジェクト内で 'function name' を検索して」
   • ファイルタイプで絞り込みます：「すべての .py ファイルから 'import' を検索して」

3. ファイル分析：

   • 特定のファイルを分析します：「ファイル src/main.py を分析して」
   • ファイルの概要を取得します：「utils/helpers.js 内の関数の一覧を出して」

4. プロジェクト内の移動：

   • プロジェクト構造を表示します：「このプロジェクトの構造を表示して」
   • 特定のパターンに一致するファイルを探します：「test_*.py ファイルをすべて探して」

技術詳細

永続ストレージ

すべてのインデックスと設定データは、プロジェクトディレクトリ内の .code_indexer フォルダーに保存されます。

• config.json：プロジェクト設定情報
• file_index.pickle：ファイルインデックスデータ
• content_cache.pickle：ファイルコンテンツのキャッシュ

これにより、使用するたびにプロジェクト全体を再インデックス化する必要がなくなります。

UV による依存関係の管理

Code Index MCP は依存関係の管理に UV を使用しており、次のような利点があります。

• プロジェクトの要件に基づく依存関係の自動解決
• パッケージのインストールと環境のセットアップを高速化
• ロックファイルによる依存関係のバージョンの一貫性

対応ファイルタイプ

現在、インデックス化と分析に対応しているファイルタイプは次のとおりです。

• Python (.py)
• JavaScript/TypeScript (.js, .ts, .jsx, .tsx)
• Java (.java)
• C/C++ (.c, .cpp, .h, .hpp)
• C# (.cs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Swift (.swift)
• Kotlin (.kt)
• Rust (.rs)
• Scala (.scala)
• Shell (.sh, .bash)
• HTML/CSS (.html, .css, .scss)
• Markdown (.md)
• JSON (.json)
• XML (.xml)
• YAML (.yml, .yaml)

セキュリティに関する考慮事項

• ファイルパスの検証により、ディレクトリトラバーサル攻撃を防止します
• 絶対パスへのアクセスは許可されていません
• プロジェクトパスは明示的に設定する必要があり、デフォルト値はありません
• .code_indexer フォルダーには .gitignore ファイルが含まれており、インデックスデータがコミットされるのを防ぎます

貢献

新機能の追加やバグ修正のための issue やプルリクエストによる貢献を歓迎します。

---

中国語のドキュメントについては、README_zh.md をご覧ください。