https://github.com/narumiruna/gitingest-mcp
https://github.com/narumiruna/gitingest-mcp
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/narumiruna/gitingest-mcp
- Owner: narumiruna
- License: mit
- Created: 2025-05-05T17:03:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-05-05T18:37:03.000Z (7 months ago)
- Last Synced: 2025-05-05T18:49:10.763Z (7 months ago)
- Language: Python
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- metorial-index - Gitingest Server - Analyze and ingest Git repositories to produce structured text digests of their codebases, providing summaries, file structures, and content. Customize file filtering and branch selection for tailored analysis. (Document Processing)
- awesome-mcp-servers - **narumiruna/gitingest-mcp 🐍 🏠** - A MCP server that uses gitingest to convert any Git repository into a simple text digest of its codebase. `http` `git` `github` (📦 Other)
README
# Gitingest MCP Server
A Model Context Protocol (MCP) server implementation that integrates with [gitingest](https://github.com/cyclotruc/gitingest) for turning any Git repository into a simple text digest of its codebase.
## Features
- Easy integration with AI assistants through the Model Context Protocol
- Git repository analysis and ingestion capabilities
- Support for filtering files by size, patterns, and branches
- Returns comprehensive repository information including summaries, file structure, and content
## Usage
### Configuration Options
Add the following configuration to your AI assistant's settings to enable gitingest-mcp as an MCP server:
#### PyPI Installation
```json
{
"mcpServers": {
"gitingestmcp": {
"command": "uvx",
"args": ["gitingestmcp@latest"]
}
}
}
```
#### GitHub Installation
```json
{
"mcpServers": {
"gitingestmcp": {
"command": "uvx",
"args": [
"--from",
"git+https://github.com/narumiruna/gitingest-mcp",
"gitingestmcp"
]
}
}
}
```
#### Local Installation
```json
{
"mcpServers": {
"gitingestmcp": {
"command": "uv",
"args": [
"run",
"--directory",
"/home//workspace/gitingest-mcp",
"gitingestmcp"
]
}
}
}
```
## API
The server provides the following tool:
### `ingest_git`
Analyzes a Git repository and returns its content in a structured format.
#### Parameters:
- `source`: The URL of a Git repository or a local directory path
- `max_file_size` (optional): Maximum allowed file size in bytes (default: 10MB)
- `include_patterns` (optional): Pattern or set of patterns specifying files to include (e.g., "\*.md, src/")
- `exclude_patterns` (optional): Pattern or set of patterns specifying files to exclude
- `branch` (optional): The branch to clone and analyze (default: "main")
#### Returns:
A string containing:
1. Repository summary
2. Tree-like structure of the files
3. Content of the repository files
## Resources
- gitingest website: https://gitingest.com/
- gitingest repository: https://github.com/cyclotruc/gitingest
## License
See the [LICENSE](LICENSE) file for details.