MCP Git Ingest

1# MCP Git Ingest
2[![smithery badge](https://smithery.ai/badge/mcp-git-ingest)](https://smithery.ai/server/mcp-git-ingest)
3 
4A Model Context Protocol (MCP) server that helps read GitHub repository structure and important files.
5 
6Inspired by [gitingest](https://gitingest.com/).
7 
8<a href="https://glama.ai/mcp/servers/un2zatig9e"><img width="380" height="200" src="https://glama.ai/mcp/servers/un2zatig9e/badge" /></a>
9 
10## Configuration
11 
12```json
13{
14    "mcpServers": {
15        "mcp-git-ingest": {
16            "command": "uvx",
17            "args": ["--from", "git+https://github.com/adhikasp/mcp-git-ingest", "mcp-git-ingest"],
18        }
19    }
20}
21```
22 
23## Usage
24 
25Using [mcp-client-cli](https://github.com/adhikasp/mcp-client-cli):
26 
27```
28$ llm read https://github.com/adhikasp/mcp-git-ingest and determine how the code technically works
29 
30I'll help you understand the technical details of the mcp-git-ingest repository. I'll first fetch the directory structure and then read the important files to analyze how the code works.
31 
32Tool Calls:
33  github_directory_structure
34  Args:
35    repo_url: https://github.com/adhikasp/mcp-git-ingest
36 
37Now, I'll read the important files to understand the technical implementation:
38 
39Tool Calls:
40  github_read_important_files
41  Args:
42    repo_url: https://github.com/adhikasp/mcp-git-ingest
43    file_paths: ['README.md', 'src/mcp_git_ingest/main.py', 'pyproject.toml']
44 
45Let me break down how this code technically works:
46 
471. Purpose:
48The `mcp-git-ingest` is a Model Context Protocol (MCP) server designed to help read GitHub repository structures and important files. It provides two main tools:
49- `github_directory_structure`: Returns a tree-like representation of a repository's directory structure
50- `github_read_important_files`: Reads and returns the contents of specified files in a repository
51 
522. Technical Implementation:
53 
54a. Dependencies:
55- Uses `fastmcp` for creating an MCP server
56- Uses `gitpython` for Git repository operations
57- Requires Python 3.8+
58 
59b. Key Functions:
60 
61`clone_repo(repo_url: str) -> str`:
62- Creates a deterministic temporary directory based on the repository URL's hash
63- Checks if the repository is already cloned
64- If not, clones the repository
65- Handles error cases and cleanup
66- Returns the path to the cloned repository
67 
68`get_directory_tree(path: str, prefix: str = "") -> str`:
69- Recursively generates a tree-like directory structure
70- Skips `.git` directories
71- Uses Unicode box-drawing characters to create a visual tree representation
72- Handles sorting of entries
73 
74`github_directory_structure(repo_url: str) -> str`:
75- Clones the repository
76- Generates directory tree
77- Cleans up the temporary repository after processing
78- Returns the tree structure or an error message
79 
80`github_read_important_files(repo_url: str, file_paths: List[str]) -> dict[str, str]`:
81- Clones the repository
82- Reads specified files
83- Returns a dictionary mapping file paths to their contents
84- Handles file reading errors
85- Cleans up the temporary repository
86 
873. Error Handling:
88- Uses try-except blocks to handle repository cloning, file reading errors
89- Ensures temporary directories are always cleaned up using `finally` blocks
90- Returns descriptive error messages
91 
924. Performance Optimizations:
93- Uses a hash-based temporary directory naming to potentially reuse cloned repositories
94- Checks for existing repositories before cloning
95- Implements cleanup to prevent accumulation of temporary files
96 
975. Unique Features:
98- Deterministic temporary directory creation
99- Unicode tree representation
100- Flexible file reading with error handling
101 
1026. Execution:
103- Can be run as a CLI tool via `mcp-git-ingest`
104- Configured through `pyproject.toml`
105- Depends on `fastmcp` for MCP server functionality
106 
107The code is a robust, flexible tool for programmatically exploring and reading GitHub repositories, with a focus on error handling and clean implementation.
108 
109Would you like me to elaborate on any specific aspect of the implementation?
110```
111 
112