Github Code Index MCP Server

🚀 コードインデックス MCP

コードインデックス MCP は、モデルコンテキストプロトコルサーバーです。これにより、大規模言語モデル（LLMs）がプロジェクトディレクトリ内のコードをインデックス化、検索、分析することができます。

✨ 主な機能

• プロジェクトのファイル構造をインデックス化し、ナビゲートする
• 特定のコードパターンを検索する
• ファイルの詳細な要約を取得する
• コード構造と複雑度を分析する
• 複数のプログラミング言語をサポートする
• プロジェクト設定を永続的に保存する

📦 インストール

このプロジェクトでは、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. コードを取得します：

   # リポジトリをクローンする
   git clone https://github.com/your-username/code-index-mcp.git
   

💻 使用例

基本的な使用法

サーバーを直接実行する

# uv を直接使用 - 追加の依存関係のインストールは不要
uv run run.py

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

Claude Desktop に統合する

コードインデックス 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"
          ]
       }
     }
   }
   

4. Claude Desktop を再起動して変更を適用します。

基本的なワークフロー

1. プロジェクトパスを設定する：
   • -p または --path パラメータを使用して、プロジェクトのルートディレクトリを指定します。
   • 例：code-indexer --path /your/project/path
2. コードを検索する：
   • -s または --search パラメータを使用して、コードを検索します。
   • 例：code-indexer --search "キーワード" --path /your/project/path
3. ファイルを分析する：
   • -a または --analyze パラメータを使用して、特定のファイルを分析します。
   • 例：code-indexer --analyze /your/project/path/file.js
4. プロジェクトをナビゲートする：
   • -n または --navigate パラメータを使用して、ディレクトリをナビゲートします。
   • 例：code-indexer --navigate /your/project/path

🔧 技術詳細

• 永続的なストレージ：.code_indexer フォルダはインデックスデータを保存するために使用され、デフォルトではプロジェクトのルートディレクトリに作成されます。
• 依存関係の管理：UV を使用して環境と依存関係を管理し、すべての依存関係が正しくインストールされるようにします。
• サポートされるファイルタイプ：以下のファイルタイプがサポートされています。
  • .js, .ts, .py, .java, .cpp, .php
  • .html, .css, .scss, .sass, .less
  • .json, .yaml, .yml, .xml, .ini
  • など

⚠️ 重要提示

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

🤝 貢献

新機能の追加やエラーの修正については、問題やプルリクエストを通じての貢献を歓迎します。

日本語ドキュメントを参照するには、README_zh.md をご覧ください。