MCP Git Ingest

🚀 MCP Git 仓库导入工具

このツールは、モデルコンテキストプロトコル（MCP）サーバーで、GitHubリポジトリの構造と重要なファイルを読み取るのを支援します。

このツールはgitingestにインスパイアされています。

🚀 クイックスタート

このツールは、モデルコンテキストプロトコル（MCP）サーバーで、GitHubリポジトリの構造と重要なファイルを読み取るのを支援します。

✨ 主な機能

mcp-git-ingestは、モデルコンテキストプロトコル（MCP）サーバーで、GitHubリポジトリの構造と重要なファイルを読み取るのを支援するために設計されています。主な機能は以下の通りです。

• github_directory_structure：リポジトリのディレクトリ構造を木構造で返します。
• github_read_important_files：指定されたファイルの内容を読み取り、返します。

📦 インストール

# プロジェクトの依存関係を管理する
pip install gitpython fastmcp

# リポジトリをクローンして実行する
git clone https://github.com/adhikarp/mcp-git-ingest.git
cd mcp-git-ingest
python3 src/main.py

📚 ドキュメント

設定

{
    "mcpServers": {
        "mcp-git-ingest": {
            "command": "uvx",
            "args": ["--from", "git+https://github.com/adhikasp/mcp-git-ingest", "mcp-git-ingest"],
        }
    }
}

使用方法

mcp-client-cliを使用します。

$ llm read https://github.com/adhikasp/mcp-git-ingest コードの動作方法を確認する

私は、mcp-git-ingestリポジトリの技術的な詳細を理解するのを手伝います。まず、ディレクトリ構造を取得し、次に重要なファイルを読み取ってコードの実装を分析します。

ツールの呼び出し:
  github_directory_structure
  パラメータ:
    repo_url: https://github.com/adhikasp/mcp-git-ingest

現在、技術的な実装を理解するために重要なファイルを読み取ります:

ツールの呼び出し:
  github_read_important_files
  パラメータ:
    repo_url: https://github.com/adhikarp/mcp-git-ingest
    file_paths: ['README.md', 'src/mcp_git_ingest/main.py', 'pyproject.toml']

コードの動作方法を分解しましょう:

1. 目的:
`mcp-git-ingest`は、モデルコンテキストプロトコル（MCP）サーバーで、GitHubリポジトリの構造と重要なファイルを読み取るのを支援するために設計されています。主に2つのツールを提供します:
- `github_directory_structure`：リポジトリのディレクトリ構造を木構造で返します。
- `github_read_important_files`：指定されたファイルの内容を読み取り、返します。

2. 技術的な実装:

a. 依存関係:
- `fastmcp`を使用してMCPサーバーを作成します。
- `gitpython`を使用してGitリポジトリを操作します。
- Python 3.8以上が必要です。

b. 重要な関数:

`clone_repo(repo_url: str) -> str`：
- リポジトリのURLのハッシュ値に基づいて、決定論的な一時ディレクトリを作成します。
- すでにクローンされているかどうかを確認します。
- まだクローンされていない場合は、リポジトリをクローンします。
- エラーを処理し、クリーンアップします。
- クローンされたリポジトリのパスを返します。

`get_directory_tree(path: str, prefix: str = "") -> str`：
- ディレクトリ構造の木構造を再帰的に生成します。
- `.git`ディレクトリを無視します。
- Unicodeのボックス図文字を使用して、視覚的な木構造を作成します。
- エントリの並べ替えを処理します。

`github_directory_structure(repo_url: str) -> str`：
- リポジトリをクローンします。
- ディレクトリツリーを生成します。
- 処理が完了したら、一時リポジトリをクリーンアップします。
- ツリー構造またはエラーメッセージを返します。

`github_read_important_files(repo_url: str, file_paths: List[str]) -> dict[str, str]`：
- リポジトリをクローンします。
- 指定されたファイルを読み取ります。
- ファイルパスから内容への辞書マッピングを返します。
- ファイルの読み取りエラーを処理します。
- 一時リポジトリをクリーンアップします。

c. エラー処理:
- クローンまたは読み取り中に一般的なGitとI/Oのエラーを処理します。
- デバッグを支援するために、意味のあるエラーメッセージを提供します。

d. パフォーマンスの最適化:
- 軽量コミットを使用して、ディスク空間の使用を削減します。
- 一時リポジトリをクリーンアップするためのガベージコレクションメカニズムを実装します。

e. 独自の機能:
- 複数のリポジトリを並列に処理することをサポートします。
- デバッグ能力を強化するために、詳細なログ記録を提供します。

3. コード構造:
```python
# コード構造の例
class GitRepository:
    def __init__(self, url):
        self.url = url
        self.repository_path = None
        
    def clone(self):
        # リポジトリをクローンするロジック
        pass
    
    def get_file(self, path):
        # 指定されたパスのファイル内容を取得する
        pass

def main():
    repo = GitRepository("https://github.com/adhikarp/mcp-git-ingest")
    repo.clone()
    tree = get_directory_tree(repo.repository_path)
    files = [repo.get_file(f) for f in ["README.md", "pyproject.toml"]]
    
if __name__ == "__main__":
    main()

4. ドキュメントとサポート:

• 公式ドキュメント: https://github.com/adhikarp/mcp-git-ingest/wiki
• 質問とヘルプ: GitHub Issues

以上の手順に従うことで、mcp-git-ingestツールを効果的に使用して、GitHubリポジトリの内容を処理および分析することができます。

## 🔧 技術詳細
### 依存関係
- `fastmcp`を使用してMCPサーバーを作成します。
- `gitpython`を使用してGitリポジトリを操作します。
- Python 3.8以上が必要です。

### 重要な関数
- `clone_repo(repo_url: str) -> str`：リポジトリをクローンし、クローン先のパスを返します。
- `get_directory_tree(path: str, prefix: str = "") -> str`：リポジトリのディレクトリ構造を木構造で返します。
- `github_directory_structure(repo_url: str) -> str`：リポジトリのディレクトリ構造を取得します。
- `github_read_important_files(repo_url: str, file_paths: List[str]) -> dict[str, str]`：指定されたファイルの内容を読み取ります。

### エラー処理
- クローンや読み取り時の一般的なGitとI/Oのエラーを処理します。
- デバッグを支援するために、意味のあるエラーメッセージを提供します。

### パフォーマンス最適化
- 軽量コミットを使用してディスク空間の使用を削減します。
- 一時リポジトリを定期的にクリーンアップするガベージコレクション機能を備えています。

### 独自機能
- 複数のリポジトリを並列処理することができます。
- 詳細なログを出力してデバッグを支援します。