Git

mcp-server-git: A git MCP server

What is mcp-server-git?

mcp-server-git is a Model Context Protocol server designed for seamless interaction and automation with Git repositories. It provides a suite of tools that allow users to read, search, and manipulate Git repositories through Large Language Models. The project is currently in early development, with ongoing expansion of its functionalities and tools.

How to use mcp-server-git?

Installation can be done using uv (recommended) or pip.

• Using uv: No specific installation is needed. You can directly run mcp-server-git using uvx.
• Using pip: Install with pip install mcp-server-git and run using python -m mcp_server_git.

Configuration for various platforms like Claude Desktop, VS Code, Zed, and Zencoder is provided, detailing how to integrate mcp-server-git using uvx, Docker, or pip installations.

Key Features of mcp-server-git

The server offers the following Git-related tools:

• git_status: Shows the working tree status.
• git_diff_unstaged: Displays unstaged changes in the working directory.
• git_diff_staged: Shows changes staged for commit.
• git_diff: Compares differences between branches or commits.
• git_commit: Records changes to the repository with a commit message.
• git_add: Adds file contents to the staging area.
• git_reset: Unstages all staged changes.
• git_log: Retrieves commit logs with options for maximum count.
• git_create_branch: Creates a new branch.
• git_checkout: Switches between branches.
• git_show: Displays the contents of a specific commit.
• git_init: Initializes a new Git repository.
• git_branch: Lists local, remote, or all branches with filtering options.

Use Cases of mcp-server-git

• Automating Git operations through LLM interactions.
• Reading, searching, and manipulating Git repository data programmatically.
• Integrating Git functionalities into AI-powered development tools and workflows.
• Streamlining code reviews and change tracking.

FAQ from mcp-server-git

• Is mcp-server-git still under development? Yes, mcp-server-git is in early development, and its features are subject to change and expansion.
• How can I debug mcp-server-git? You can use the MCP inspector for debugging. For uvx installations, run npx @modelcontextprotocol/inspector uvx mcp-server-git. For local development, navigate to the project directory and run npx @modelcontextprotocol/inspector uv run mcp-server-git. Logs can be monitored via ~/Library/Logs/Claude/mcp*.log.
• What license is mcp-server-git distributed under? The project is licensed under the MIT License.

Development and Build

Local development can be tested using the MCP inspector or by integrating with the Claude desktop app. Docker images can be built using docker build -t mcp/git . after navigating to the src/git directory. The repository is available on GitHub at https://github.com/modelcontextprotocol/servers.

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.

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
   • Inputs:
     • repo_path (string): Path to Git repository
     • context_lines (number, optional): Number of context lines to show (default: 3)
   • Returns: Diff output of unstaged changes

3. git_diff_staged

   • Shows changes that are staged for commit
   • Inputs:
     • repo_path (string): Path to Git repository
     • context_lines (number, optional): Number of context lines to show (default: 3)
   • 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
     • context_lines (number, optional): Number of context lines to show (default: 3)
   • 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

11. 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

12. git_init

• Initializes a Git repository
• Inputs:
  • repo_path (string): Path to directory to initialize git repo
• Returns: Confirmation of repository initialization

13. git_branch

• List Git branches
• Inputs:
  • repo_path (string): Path to the Git repository.
  • branch_type (string): Whether to list local branches ('local'), remote branches ('remote') or all branches('all').
  • contains (string, optional): The commit sha that branch should contain. Do not pass anything to this param if no commit sha is specified
  • not_contains (string, optional): The commit sha that branch should NOT contain. Do not pass anything to this param if no commit sha is specified
• Returns: List of branches

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:

"mcpServers": {
  "git": {
    "command": "uvx",
    "args": ["mcp-server-git", "--repository", "path/to/git/repo"]
  }
}

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

"mcpServers": {
  "git": {
    "command": "python",
    "args": ["-m", "mcp_server_git", "--repository", "path/to/git/repo"]
  }
}

Usage with VS Code

For quick installation, use one of the one-click install buttons below...

For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is not needed in the .vscode/mcp.json file.

{
  "mcp": {
    "servers": {
      "git": {
        "command": "uvx",
        "args": ["mcp-server-git"]
      }
    }
  }
}

For Docker installation:

{
  "mcp": {
    "servers": {
      "git": {
        "command": "docker",
        "args": [
          "run",
          "--rm",
          "-i",
          "--mount", "type=bind,src=${workspaceFolder},dst=/workspace",
          "mcp/git"
        ]
      }
    }
  }
}

Usage with Zed

Add to your Zed settings.json:

"context_servers": [
  "mcp-server-git": {
    "command": {
      "path": "uvx",
      "args": ["mcp-server-git"]
    }
  }
],

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

Usage with Zencoder

1. Go to the Zencoder menu (...)
2. From the dropdown menu, select Agent Tools
3. Click on the Add Custom MCP
4. Add the name (i.e. git) and server configuration from below, and make sure to hit the Install button

{
    "command": "uvx",
    "args": ["mcp-server-git", "--repository", "path/to/git/repo"]
}

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.