Codebase Context Dumper

🚀 codebase-context-dumper MCP Server

このツールは、Model Context Protocol (MCP) サーバーであり、コードベースのコンテキストをLarge Language Models (LLMs) に簡単に投入することができます。

🚀 クイックスタート

LLMsの大きなコンテキストウィンドウは強力ですが、大規模なコードベースから手動でファイルを選択してフォーマットするのは面倒です。このツールは以下のようにしてプロセスを自動化します。

• プロジェクトディレクトリを再帰的にスキャンします。
• 指定されたディレクトリツリー内の、.gitignore ルールによって除外されないテキストファイルを含めます。
• バイナリファイルを自動的にスキップします。
• 内容を明確なファイルパスマーカーとともに連結します。
• LLMのコンテキストウィンドウより大きいコードベースを処理するためのチャンキングをサポートします。
• MCP互換クライアントとシームレスに統合します。

✨ 主な機能

ツール: dump_codebase_context

指定されたディレクトリからテキストファイルを再帰的に読み取り、.gitignore ルールを尊重し、バイナリファイルをスキップします。内容をファイルパスのヘッダーとフッターとともに連結します。大規模なコードベースに対するチャンキングをサポートします。

機能:

• base_path で指定されたディレクトリをスキャンします。
• すべてのレベルの .gitignore ファイルを尊重します（ネストされたものやデフォルトの .git も含む）。
• バイナリファイルを検出してスキップします。
• 各有効なテキストファイルの内容を読み取ります。
• 各ファイルの内容にヘッダー (--- START: relative/path/to/file ---) を追加し、フッター (--- END: relative/path/to/file ---) を付けます。
• すべての処理されたファイルの内容を1つの文字列に連結します。

入力パラメータ:

• base_path (文字列、必須): スキャンするプロジェクトディレクトリの絶対パス。
• num_chunks (整数、オプション、デフォルト: 1): 出力を分割するチャンクの総数。1以上である必要があります。
• chunk_index (整数、オプション、デフォルト: 1): 返すチャンクの1から始まるインデックス。num_chunks > 1 かつ chunk_index <= num_chunks が必要です。

出力: 連結された（場合によってはチャンク化された）テキスト内容を返します。

📦 インストール

推奨: npxを使用する方法

このツールを使用する最も簡単な方法は npx を通じてです。これにより、ローカルにインストールする必要なく最新バージョンを実行できます。

MCPクライアント（例: Claude Desktop、VS Code拡張機能）を次のコマンドを使用するように設定します。

{
  "mcpServers": {
    "codebase-context-dumper": {
      "command": "npx",
      "args": [
        "-y",
        "@lex-tools/codebase-context-dumper"
      ]
    }
  }
}

MCPクライアントは、このサーバーが提供する dump_codebase_context ツールを呼び出すことができるようになります。

ローカルインストールと使用（上級者向け）

ローカルバージョンを実行する場合（例: 開発用）は、以下の手順に従います。

1. リポジトリをクローンします。

   git clone git@github.com:lex-tools/codebase-context-dumper.git
   cd codebase-context-dumper
   

2. 依存関係をインストールします。

   npm install
   

3. サーバーをビルドします。

   npm run build
   

4. MCPクライアントをローカルビルド出力を指すように設定します。

   {
     "mcpServers": {
       "codebase-context-dumper": {
         "command": "/path/to/your/local/codebase-context-dumper/build/index.js" // パスを調整
       }
     }
   }
   

🤝 コントリビュート

コントリビューションは大歓迎です！開発、デバッグ、および新バージョンのリリースに関する詳細は CONTRIBUTING.md を参照してください。

📄 ライセンス

このプロジェクトはApache License 2.0の下でライセンスされています。詳細は LICENSE ファイルを参照してください。