MCP Git Ingest

🚀 MCP Git 倉庫導入工具

MCP Git 倉庫導入工具 是一個模型上下文協議（MCP）服務器，旨在幫助讀取 GitHub 倉庫結構和重要文件，為開發者提供便利。它受 gitingest 啟發而開發。

🚀 快速開始

配置

你可以按照以下方式對工具進行配置：

{
    "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']

✨ 主要特性

• 提供兩個主要工具：
  • 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

💻 使用示例

基礎用法

# 示例代碼結構
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()

🔧 技術細節

目的

mcp-git-ingest 是一個模型上下文協議（MCP）服務器，設計用於幫助讀取 GitHub 倉庫結構和重要文件。

技術實現

依賴項

• 使用 fastmcp 創建 MCP 服務器。
• 使用 gitpython 進行 Git 倉庫操作。
• 需要 Python 3.8+。

關鍵函數

• 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]：
  • 克隆倉庫。
  • 讀取指定文件。
  • 返回文件路徑到內容的字典映射。
  • 處理文件讀取錯誤。
  • 清理臨時倉庫。

錯誤處理

在克隆或讀取過程中處理常見 Git 和 I/O 錯誤，提供有意義的錯誤消息以幫助調試。

性能優化

• 使用輕量級承諾（lightweight commits）以減少磁盤空間使用。
• 實施垃圾收集機制以清理臨時倉庫。

📚 詳細文檔

• 官方文檔：https://github.com/adhikarp/mcp-git-ingest/wiki
• 提問與幫助：GitHub Issues