Git MCP Server

Git MCP Server

site icon
2025.02.12 5
TypeScriptGit 操作版本控制开发工具开发效率
Git MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,通过标准化接口提供增强的 Git 操作功能。该服务与 MCP 生态系统集成,为 AI 助手提供 Git 功能。
View on GitHub

Overview

基本能力

产品定位

Git MCP Server 是一个为 AI 助手提供 Git 操作功能的 MCP 服务,通过标准化接口简化 Git 操作流程。

核心功能

  • 核心 Git 操作:初始化、克隆、状态检查、添加、提交、推送、拉取
  • 分支管理:列出、创建、删除、切换分支
  • 标签操作:列出、创建、删除标签
  • 远程管理:列出、添加、删除远程仓库
  • 暂存操作:列出、保存、应用暂存
  • 批量操作:按顺序执行多个 Git 操作
  • GitHub 集成:通过个人访问令牌支持 GitHub 操作
  • 路径解析:智能路径处理,支持默认路径配置
  • 错误处理:全面的错误处理机制
  • 仓库缓存:高效的仓库状态管理
  • 性能监控:内置性能跟踪

适用场景

  • AI 助手集成 Git 操作
  • 自动化 Git 工作流
  • 批量执行 Git 命令
  • 与 GitHub 集成的开发环境

工具列表

基本操作

  • init:初始化新的 Git 仓库
  • clone:克隆仓库
  • status:获取仓库状态
  • add:暂存文件
  • commit:创建提交
  • push:推送提交到远程
  • pull:从远程拉取更改

分支操作

  • branch_list:列出所有分支
  • branch_create:创建新分支
  • branch_delete:删除分支
  • checkout:切换分支或恢复工作树文件

标签操作

  • tag_list:列出标签
  • tag_create:创建标签
  • tag_delete:删除标签

远程操作

  • remote_list:列出远程仓库
  • remote_add:添加远程仓库
  • remote_remove:删除远程仓库

暂存操作

  • stash_list:列出暂存
  • stash_save:保存更改到暂存
  • stash_pop:应用并移除暂存

批量操作

  • bulk_action:按顺序执行多个 Git 操作

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 确保已安装 Git

安装教程

  1. 克隆仓库:
git clone https://github.com/yourusername/git-mcp-v2.git
cd git-mcp-v2
  1. 安装依赖:
npm install
  1. 构建项目:
npm run build

配置

在 MCP 配置文件中添加以下内容:

{
  "mcpServers": {
    "git-v2": {
      "command": "node",
      "args": ["path/to/git-mcp-v2/build/index.js"],
      "env": {
        "GIT_DEFAULT_PATH": "/path/to/default/git/directory",
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your-github-pat"
      }
    }
  }
}

环境变量

  • GIT_DEFAULT_PATH:(可选)Git 操作的默认路径
  • GITHUB_PERSONAL_ACCESS_TOKEN:(可选)用于 GitHub 操作的个人访问令牌

调试方式

  1. 运行测试:
npm test
  1. 运行带覆盖率的测试:
npm run test:coverage
  1. 运行代码检查:
npm run lint
  1. 格式化代码:
npm run format

许可证

该项目遵循 MIT 开源许可条款。