mcp-server-git: 一个 Git MCP 服务器

概述

一个用于 Git 仓库交互和自动化的模型上下文协议服务器。该服务器提供了通过大语言模型读取、搜索和操作 Git 仓库的工具。

请注意，mcp-server-git 目前处于早期开发阶段。随着我们继续开发和改进服务器，功能和可用工具可能会发生变化和扩展。

工具

1. git_status

   • 显示工作树状态
   • 输入：
     • repo_path (字符串): Git 仓库路径
   • 返回：工作目录的当前状态，以文本形式输出

2. git_diff_unstaged

   • 显示尚未暂存的工作目录中的更改
   • 输入：
     • repo_path (字符串): Git 仓库路径
   • 返回：未暂存更改的差异输出

3. git_diff_staged

   • 显示已暂存待提交的更改
   • 输入：
     • repo_path (字符串): Git 仓库路径
   • 返回：已暂存更改的差异输出

4. git_diff

   • 显示分支或提交之间的差异
   • 输入：
     • repo_path (字符串): Git 仓库路径
     • target (字符串): 要比较的目标分支或提交
   • 返回：当前状态与目标之间的差异输出

5. git_commit

   • 记录对仓库的更改
   • 输入：
     • repo_path (字符串): Git 仓库路径
     • message (字符串): 提交消息
   • 返回：带有新提交哈希的确认信息

6. git_add

   • 将文件内容添加到暂存区
   • 输入：
     • repo_path (字符串): Git 仓库路径
     • files (字符串数组): 要暂存的文件路径数组
   • 返回：已暂存文件的确认信息

7. git_reset

   • 取消暂存所有已暂存的更改
   • 输入：
     • repo_path (字符串): Git 仓库路径
   • 返回：重置操作的确认信息

8. git_log

   • 显示提交日志
   • 输入：
     • repo_path (字符串): Git 仓库路径
     • max_count (数字, 可选): 要显示的最大提交数（默认：10）
   • 返回：包含哈希、作者、日期和消息的提交条目数组

9. git_create_branch

   • 创建一个新分支
   • 输入：
     • repo_path (字符串): Git 仓库路径
     • branch_name (字符串): 新分支的名称
     • start_point (字符串, 可选): 新分支的起点
   • 返回：分支创建的确认信息

10. git_checkout

    • 切换分支
    • 输入：
      • repo_path (字符串): Git 仓库路径
      • branch_name (字符串): 要切换到的分支名称
    • 返回：分支切换的确认信息

11. git_show

    • 显示提交的内容
    • 输入：
      • repo_path (字符串): Git 仓库路径
      • revision (字符串): 要显示的修订（提交哈希、分支名称、标签）
    • 返回：指定提交的内容

12. git_init

    • 初始化一个 Git 仓库
    • 输入：
      • repo_path (字符串): 要初始化 Git 仓库的目录路径
    • 返回：仓库初始化的确认信息

安装

使用 uv（推荐）

使用 uv 时无需特定安装。我们将使用 uvx 直接运行 mcp-server-git。

使用 PIP

或者，您可以通过 pip 安装 mcp-server-git：

pip install mcp-server-git

安装后，您可以使用以下命令运行它：

python -m mcp_server_git

配置

与 Claude Desktop 一起使用

将此添加到您的 claude_desktop_config.json 中：

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

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

与 VS Code 一起使用

要快速安装，请使用以下一键安装按钮...

要手动安装，请将以下 JSON 块添加到 VS Code 中的用户设置（JSON）文件中。您可以通过按 Ctrl + Shift + P 并键入 Preferences: Open Settings (JSON) 来完成此操作。

或者，您可以将其添加到工作区中名为 .vscode/mcp.json 的文件中。这将允许您与他人共享配置。

请注意，.vscode/mcp.json 文件中不需要 mcp 键。

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

对于 Docker 安装：

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

与 Zed 一起使用

将此添加到您的 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"]
    }
  }
},

调试

您可以使用 MCP 检查器来调试服务器。对于 uvx 安装：

npx @modelcontextprotocol/inspector uvx mcp-server-git

或者，如果您已将包安装在特定目录中或正在开发它：

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

运行 tail -n 20 -f ~/Library/Logs/Claude/mcp*.log 将显示服务器的日志，并可能帮助您调试任何问题。

开发

如果您正在进行本地开发，有两种方法可以测试您的更改：

1. 运行 MCP 检查器以测试您的更改。请参阅 调试 以获取运行说明。

2. 使用 Claude 桌面应用程序进行测试。将以下内容添加到您的 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"
    ]
  }
}

构建

Docker 构建：

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

许可证

此 MCP 服务器根据 MIT 许可证授权。这意味着您可以自由使用、修改和分发该软件，但需遵守 MIT 许可证的条款和条件。有关更多详细信息，请参阅项目仓库中的 LICENSE 文件。