Git MCP

🚀 Git MCP Usage Guide

An MCP server for managing Git operations in local repositories.

🚀 Quick Start

This is an MCP server designed to manage Git operations within local repositories, offering a convenient way to handle various Git - related tasks.

📦 Installation

Install via Smithery

To automatically install Git MCP for Claude Desktop via Smithery:

npx -y @smithery/cli install @kjozsa/git-mcp --client claude

Manual Installation

uvx install git-mcp

🛠️ Configuration

Add the MCP server using the following JSON configuration snippet:

{
  "mcpServers": {
    "git-mcp": {
      "command": "uvx",
      "args": ["git-mcp"],
      "env": {
        "GIT_REPOS_PATH": "/path/to/your/git/repositories"
      }
    }
  }
}

✨ Features and Usage

Environment Variables

• GIT_REPOS_PATH: The directory path containing Git repositories (Required). You can create a .env file in the directory where the server runs or add it to your environment.

Available Methods

list_repositories

List all Git repositories under the configured path.

• Parameters: None
• Return Value: A list of repository names

get_last_git_tag

Get the last Git tag in the specified repository.

• Parameters:
  • repo_name (Required): The name of the Git repository
• Return Value: A dictionary containing version (tag name) and date (creation date)

list_commits_since_last_tag

List the commit information from the last Git tag to the latest commit.

• Parameters:
  • repo_name: The name of the Git repository
  • max_count (Optional): The maximum number of commits to return
• Return Value: A list of dictionaries containing hash, author, date, and message

create_git_tag

Create a new Git tag in the specified repository.

• Parameters:
  • repo_name: The name of the Git repository
  • tag_name: The name of the tag to create
  • message (Optional): Annotation information (If not provided, a lightweight tag is created by default)
• Return Value: A dictionary containing status, version (tag name), date (creation date), and type (annotated or lightweight)

push_git_tag

Push an existing Git tag to the default remote repository.

• Parameters:
  • repo_name: The name of the Git repository
  • tag_name: The name of the tag to push
• Return Value: A dictionary containing status, remote (remote name), tag (tag name), and message (success message)

refresh_repository

Refresh the repository by checking out the main branch (or falling back to the master branch as a backup) and pulling the latest changes.

• Parameters:
  • repo_name: The name of the Git repository
• Return Value: No return value, status information is output after the operation is completed

🚑 Troubleshooting

Repository Not Found

If you see an error like "Repository not found", check the following:

1. Ensure that the path /path/to/your/git/repositories is valid and contains Git repositories.
2. Make sure the repository name is spelled correctly.

Empty Commit List

If the returned commit list is empty, do the following:

1. Check if a tag has been created.
2. Confirm that there are any commit records in the repository.

💻 Development

uv pip install -r requirements.txt

🧪 Testing

To run tests:

# For basic functionality tests
uvx test

# For extended functionality tests
python3 tests.py

Test Scripts

• test: Quickly test core functions.
• tests.py: Provide more comprehensive tests covering more usage scenarios.

With the above guide, you can easily configure and use the Git MCP server to manage your Git repositories.