Skip to main content

An MCP server for gitingest

Project description

trelis-gitingest-mcp 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.

Examples

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"
}

Configuration

Quickstart

Install

Claude Desktop

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

Development/Unpublished Servers Configuration

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

Published Servers Configuration

"mcpServers": {
  "trelis-gitingest-mcp": {
    "command": "uvx",
    "args": [
      "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.

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

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.2.tar.gz (24.5 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.2-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for trelis_gitingest_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5ec3ff31cae59e739e54a3a965a9d1e00fbdf3f3093f5ccd13dafe826c153cd6
MD5 92d90560f9649a68b669fbf321afeeab
BLAKE2b-256 c8d0705db60d6000694b856e982753e339d4333bf7a801ec61f951ce4b7856be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for trelis_gitingest_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5ff5eee8c1635ccf2b5e5937211789414ac691f91d9ad1a09e735e42146bbe7d
MD5 5b02797c6cefeb441b08680bd07554fa
BLAKE2b-256 b590258cdc1d4a2a5e2f2685fc1d1ad188053ef5b70d30e3ae58bfaea81c6c11

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