MCP Git Ingest

🚀 MCP Git Repository Import Tool

A Model Context Protocol (MCP) server that helps read the GitHub repository structure and important files.

Inspired by gitingest.

🚀 Quick Start

This tool is a Model Context Protocol (MCP) server designed to read the structure and important files of GitHub repositories.

✨ Features

• Two Main Tools:
  • github_directory_structure: Returns a tree - like representation of the repository directory structure.
  • github_read_important_files: Reads and returns the content of specified files.
• Parallel Processing: Supports parallel processing of multiple repositories.
• Detailed Logging: Provides detailed logging for better debugging.

📦 Installation

# Project dependency management
pip install gitpython fastmcp

# Clone the repository and run
git clone https://github.com/adhikarp/mcp-git-ingest.git
cd mcp-git-ingest
python3 src/main.py

💻 Usage Examples

Basic Usage

Use mcp-client-cli:

$ llm read https://github.com/adhikasp/mcp-git-ingest and determine how the code works

I'll help you understand the technical details of the mcp-git-ingest repository. First, get the directory structure, then read important files to analyze the code implementation.

Tool call:
  github_directory_structure
  Parameters:
    repo_url: https://github.com/adhikasp/mcp-git-ingest

Now, I'll read important files to understand the technical implementation:

Tool call:
  github_read_important_files
  Parameters:
    repo_url: https://github.com/adhikarp/mcp-git-ingest
    file_paths: ['README.md', 'src/mcp_git_ingest/main.py', 'pyproject.toml']

Advanced Usage

Let's break down how the code works:

# Example code structure
class GitRepository:
    def __init__(self, url):
        self.url = url
        self.repository_path = None
        
    def clone(self):
        # Logic to clone the repository
        pass
    
    def get_file(self, path):
        # Get the content of the file at the specified 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()

📚 Documentation

• Official Documentation: https://github.com/adhikarp/mcp-git-ingest/wiki
• Ask Questions and Get Help: GitHub Issues

🔧 Technical Details

Dependencies

• Uses fastmcp to create an MCP server.
• Uses gitpython for Git repository operations.
• Requires Python 3.8+.

Key Functions

• clone_repo(repo_url: str) -> str:
  • Creates a deterministic temporary directory based on the hash value of the repository URL.
  • Checks if the repository has already been cloned.
  • Clones the repository if not already cloned.
  • Handles error cases and cleans up.
  • Returns the path of the cloned repository.
• get_directory_tree(path: str, prefix: str = "") -> str:
  • Recursively generates a tree - like representation of the directory structure.
  • Ignores the .git directory.
  • Uses Unicode box - drawing characters to create a visual tree structure representation.
  • Handles item sorting.
• github_directory_structure(repo_url: str) -> str:
  • Clones the repository.
  • Generates the directory tree.
  • Cleans up the temporary repository after processing.
  • Returns the tree structure or an error message.
• github_read_important_files(repo_url: str, file_paths: List[str]) -> dict[str, str]:
  • Clones the repository.
  • Reads the specified files.
  • Returns a dictionary mapping file paths to content.
  • Handles file - reading errors.
  • Cleans up the temporary repository.

Error Handling

• Handles common Git and I/O errors during cloning or reading.
• Provides meaningful error messages to assist with debugging.

Performance Optimization

• Uses lightweight commits to reduce disk space usage.
• Implements a garbage collection mechanism to clean up temporary repositories.

📄 Configuration

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