Skip to main content

An MCP server for gitingest

Project description

Gitingest MCP server

An MCP server for gitingest that provides access to Git repository analysis through the Model Context Protocol (MCP). This server leverages the gitingest library to analyze Git repositories and make their content available in a format optimized for LLMs.

Overview

This MCP server provides a single unified tool for accessing Git repository data. It automatically handles repository ingestion as needed, so users can immediately query repository content without an explicit ingestion step.

Tool: gitingest

The server provides a single tool called gitingest that can be used to analyze Git repositories. The tool accepts the following parameters:

  • repo_uri (required): URL or local path to the Git repository
  • resource_type: Type of data to retrieve (summary, tree, content, or all). Default is summary.
  • max_file_size: Maximum file size in bytes to include in the analysis. Default is 10MB.
  • include_patterns: Comma-separated patterns of files to include in the analysis.
  • exclude_patterns: Comma-separated patterns of files to exclude from the analysis.
  • branch: Specific branch to analyze.
  • output: File path to save the output to.

Resource Types and Large Repositories

For large repositories, it's recommended to first request only the summary (which is the default). After ingestion, you can access more detailed information through the resources:

  • Use the tree resource to explore the repository structure
  • Use the content resource to access the full content (if not too large)

If the repository is too large, consider using include_patterns and/or exclude_patterns to limit the scope of the ingestion.

Automatic Ingestion and Simple Caching

The server will automatically ingest repositories on demand. You don't need to call a separate ingestion function before querying.

Results are cached in memory during the server's runtime, so subsequent requests for the same repository will be faster. However, the cache is cleared when the server restarts.

Once a repository is ingested, you can access its data either by calling the gitingest tool again or by using the resources interface.

Quickstart

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Published Servers Configuration

"mcpServers": {
  "trelis-gitingest-mcp": {
    "command": "uvx",
    "args": [
      "trelis-gitingest-mcp"
    ]
  }
}

Development/Unpublished Servers Configuration

"mcpServers": {
  "trelis-gitingest-mcp": {
    "command": "uv",
    "args": [
      "--directory",
      "/Users/your-username/trelis-gitingest-mcp",
      "run",
      "trelis-gitingest-mcp"
    ]
  }
}

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

Examples & MCP Inspector

Get everything for a repository:

{
  "repo_uri": "https://github.com/user/repo"
}

Get just the summary:

{
  "repo_uri": "https://github.com/user/repo",
  "resource_type": "summary"
}

Get the file tree:

{
  "repo_uri": "https://github.com/user/repo",
  "resource_type": "tree"
}

Get the full content:

{
  "repo_uri": "https://github.com/user/repo",
  "resource_type": "content"
}

Custom ingestion parameters:

{
  "repo_uri": "https://github.com/user/repo",
  "branch": "dev",
  "exclude_patterns": "*.md,tests/*",
  "max_file_size": 5242880
}

Using include patterns to focus on specific files:

{
  "repo_uri": "https://github.com/user/repo",
  "include_patterns": "src/*.py,bin/*"
}

Note: The patterns src/*.py and bin/* will only match Python files directly in the src directory and any files directly in the bin directory, not in subdirectories.

Save output to a file:

{
  "repo_uri": "https://github.com/user/repo",
  "resource_type": "all",
  "output": "/path/to/output/file.txt"
}

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /Users/your-username/trelis-gitingest-mcp run trelis-gitingest-mcp

or using uvx for the mcp server:

npx @modelcontextprotocol/inspector uvx trelis-gitingest-mcp

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trelis_gitingest_mcp-0.1.3.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trelis_gitingest_mcp-0.1.3-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file trelis_gitingest_mcp-0.1.3.tar.gz.

File metadata

File hashes

Hashes for trelis_gitingest_mcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 628569a584927447d6e378d95c936c74d7b4a58a74c55132f419f86bbdd8abca
MD5 b9b600b3d7b2a93afe995b587f1dd8ea
BLAKE2b-256 b94f2d6135796a0c8eff9d0bbfe42409edb26690f8cd377ba231a12b3fcb1d62

See more details on using hashes here.

File details

Details for the file trelis_gitingest_mcp-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for trelis_gitingest_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f47c99eea902c5a8c63ea566fb6ea524abca92cad433b4f3e2fd8695c7e5b322
MD5 d46c2312d7c019b346f8dc8c3c1a772b
BLAKE2b-256 dcf28f84042ddd87e9a4630c0af0ae4e1b8a530a66de8844118ec54b4ba93630

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page