Skip to main content

A Model Context Protocol server providing tools to read, search,describe, and manipulate Git repositories programmatically via LLMs

Project description

mcp-server-git: A git MCP server

Overview

A Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.

Please note that mcp-server-git is currently in early development. The functionality and available tools are subject to change and expansion as we continue to develop and improve the server.

Version Lists
  • Ver0.0.1: 添加tool:git_describe
  • Ver0.0.2: 一致性优化
  • Ver0.0.3: 完善README.md中Using uvx示例

Tools

  1. git_status

    • Shows the working tree status
    • Input:
      • repo_path (string): Path to Git repository
    • Returns: Current status of working directory as text output
  2. git_diff_unstaged

    • Shows changes in working directory not yet staged
    • Input:
      • repo_path (string): Path to Git repository
    • Returns: Diff output of unstaged changes
  3. git_diff_staged

    • Shows changes that are staged for commit
    • Input:
      • repo_path (string): Path to Git repository
    • Returns: Diff output of staged changes
  4. git_diff

    • Shows differences between branches or commits
    • Inputs:
      • repo_path (string): Path to Git repository
      • target (string): Target branch or commit to compare with
    • Returns: Diff output comparing current state with target
  5. git_commit

    • Records changes to the repository
    • Inputs:
      • repo_path (string): Path to Git repository
      • message (string): Commit message
    • Returns: Confirmation with new commit hash
  6. git_add

    • Adds file contents to the staging area
    • Inputs:
      • repo_path (string): Path to Git repository
      • files (string[]): Array of file paths to stage
    • Returns: Confirmation of staged files
  7. git_reset

    • Unstages all staged changes
    • Input:
      • repo_path (string): Path to Git repository
    • Returns: Confirmation of reset operation
  8. git_log

    • Shows the commit logs
    • Inputs:
      • repo_path (string): Path to Git repository
      • max_count (number, optional): Maximum number of commits to show (default: 10)
    • Returns: Array of commit entries with hash, author, date, and message
  9. git_create_branch

    • Creates a new branch
    • Inputs:
      • repo_path (string): Path to Git repository
      • branch_name (string): Name of the new branch
      • start_point (string, optional): Starting point for the new branch
    • Returns: Confirmation of branch creation
  10. git_checkout

  • Switches branches
  • Inputs:
    • repo_path (string): Path to Git repository
    • branch_name (string): Name of branch to checkout
  • Returns: Confirmation of branch switch
  1. git_show
  • Shows the contents of a commit
  • Inputs:
    • repo_path (string): Path to Git repository
    • revision (string): The revision (commit hash, branch name, tag) to show
  • Returns: Contents of the specified commit
  1. git_describe
  • Shows the closest tag associated with the current commit
  • Inputs:
    • repo_path (string): Path to Git repository
  • Returns: Contents of the specified tagged commit

Installation

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-git.

Using PIP

Alternatively you can install mcp-server-git via pip:

pip install mcp-server-git

After installation, you can run it as a script using:

python -m mcp_server_git

Configuration

Usage with Claude Desktop

Add this to your claude_desktop_config.json or mcp.json(Trae):

Using uvx
"mcpServers": {
  "git": {
    "command": "uvx",
    "args": ["mcp-server-git", "--repository", "path/to/git/repo"]
  }
}
使用pypi.org打包文件
{
  "mcpServers": {
    "git-airnet": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp_git_AirNet==0.0.3",
        "--refresh-package",
        "mcp_git_AirNet",
        "git_mcp_server_AirNet"
      ]
    }
  }
}
使用本地打包文件,--from 参数直接指定whl/tar.gz文件路径
{
    "mcpServers": {
        "git-whl": {
            "command": "uvx",
            "args": [
                "--from",
                "E:\\技术支持室\\Trae\\mcp_git_AirNet\\dist\\mcp_git_airnet-0.0.3-py3-none-any.whl",
                "git_mcp_server_AirNet"
            ]
        }
    }
}

{
    "mcpServers": {
        "git-tar": {
            "command": "uvx",
            "args": [
                "--from",
                "E:\\技术支持室\\Trae\\mcp_git_AirNet\\dist\\mcp_git_airnet-0.0.3.tar.gz",
                "git_mcp_server_AirNet"
            ]
        }
    }
}
Using docker
  • Note: replace '/Users/username' with the a path that you want to be accessible by this tool
"mcpServers": {
  "git": {
    "command": "docker",
    "args": ["run", "--rm", "-i", "--mount", "type=bind,src=/Users/username,dst=/Users/username", "mcp/git"]
  }
}
Using pip installation
"mcpServers": {
  "git": {
    "command": "python",
    "args": ["-m", "mcp_server_git", "--repository", "path/to/git/repo"]
  }
}

Usage with Zed

Add to your Zed settings.json:

Using uvx
"context_servers": [
  "mcp-server-git": {
    "command": {
      "path": "uvx",
      "args": ["mcp-server-git"]
    }
  }
],
Using pip installation
"context_servers": {
  "mcp-server-git": {
    "command": {
      "path": "python",
      "args": ["-m", "mcp_server_git"]
    }
  }
},

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx mcp-server-git

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/servers/src/git
npx @modelcontextprotocol/inspector uv run mcp-server-git

Running tail -n 20 -f ~/Library/Logs/Claude/mcp*.log will show the logs from the server and may help you debug any issues.

Development

If you are doing local development, there are two ways to test your changes:

  1. Run the MCP inspector to test your changes. See Debugging for run instructions.

  2. Test using the Claude desktop app. Add the following to your claude_desktop_config.json:

Docker

{
  "mcpServers": {
    "git": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--mount", "type=bind,src=/Users/username/Desktop,dst=/projects/Desktop",
        "--mount", "type=bind,src=/path/to/other/allowed/dir,dst=/projects/other/allowed/dir,ro",
        "--mount", "type=bind,src=/path/to/file.txt,dst=/projects/path/to/file.txt",
        "mcp/git"
      ]
    }
  }
}

UVX

{
"mcpServers": {
  "git": {
    "command": "uv",
    "args": [ 
      "--directory",
      "/<path to mcp-servers>/mcp-servers/src/git",
      "run",
      "mcp-server-git"
    ]
  }
}

Build

Docker build:

cd src/git
docker build -t mcp/git .

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

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

mcp_git_airnet-0.0.3.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

mcp_git_airnet-0.0.3-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file mcp_git_airnet-0.0.3.tar.gz.

File metadata

  • Download URL: mcp_git_airnet-0.0.3.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.17

File hashes

Hashes for mcp_git_airnet-0.0.3.tar.gz
Algorithm Hash digest
SHA256 051ec8b500e37b0a89edb4762f8672299971fcf1a9350fcc7b5421c827937b66
MD5 874eace75fb6f6c2b93f7338ee0a3958
BLAKE2b-256 99f5b618fb678ff06977aa4e117a4fdb51dd04e101268671ab50a9bba344c569

See more details on using hashes here.

File details

Details for the file mcp_git_airnet-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_git_airnet-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 10692562ca2105ad9d653c40e840e06551467f72c04c95d1ce3d6524f1f4f443
MD5 2640a89b453cd3896af0d0288d40a0f5
BLAKE2b-256 de0d3c096beaaeace920bb03f25283e492f5521b9d9f15540113f3862b731dd4

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