This project provides an MCP server for reading GitHub repository structures and important files, targeting developers and AI agents needing programmatic access to repository content. It simplifies fetching directory trees and file contents from GitHub repositories.

How It Works

The server leverages fastmcp for MCP protocol handling and gitpython for Git operations. It clones repositories into deterministic, hash-based temporary directories, allowing for potential reuse. Key functions include clone_repo for managing local copies, get_directory_tree for generating a visual tree structure, and github_read_important_files for reading specified file contents. Error handling and temporary directory cleanup are prioritized.

Quick Start & Requirements

• Install via pip install mcp-git-ingest (assuming it's published).
• Requires Python 3.8+.
• Usage demonstrated with mcp-client-cli for github_directory_structure and github_read_important_files tools.

Highlighted Details

• Fetches GitHub repository directory structure as a tree.
• Reads specified file contents from GitHub repositories.
• Uses deterministic temporary directories for cloned repositories.
• Implements robust error handling and cleanup mechanisms.

Maintenance & Community

No specific community channels, contributors, or roadmap details are provided in the README.

Licensing & Compatibility

The README does not explicitly state a license. Compatibility for commercial or closed-source use is undetermined.

Limitations & Caveats

The project appears to be a single-purpose tool with no explicit mention of advanced features like branch handling, commit history, or large file support. The lack of a stated license is a significant caveat for adoption.