git-mcp-v2

🚀 Git MCP 服务器

Git MCP 服务器是一个提供增强型 Git 操作的 Model Context Protocol (MCP) 服务器，它通过标准化接口实现，与 MCP 生态系统集成，能为 AI 助手提供强大的 Git 功能。

🚀 快速开始

Git MCP 服务器使用简单，按照以下步骤即可完成安装和配置。

安装步骤

1. 克隆仓库：

git clone https://github.com/yourusername/git-mcp-v2.git
cd git-mcp-v2

2. 安装依赖项：

npm install

3. 构建项目：

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 个人访问令牌，用于 GitHub 操作

✨ 主要特性

• 核心 Git 操作：支持 init、clone、status、add、commit、push、pull 等核心操作。
• 分支管理：可进行列表、创建、删除、切换等分支管理操作。
• 标签操作：能够对标签进行列表、创建、删除操作。
• 远程管理：支持列表、添加、移除远程仓库。
• stash 操作：可进行列表、保存、弹出 stash 操作。
• 批量操作：按顺序执行多个 Git 操作。
• GitHub 集成：通过个人访问令牌内置的 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 操作

• stash_list：列出 stash
• stash_save：将更改保存到 stash
• stash_pop：应用并删除 stash

批量操作

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

📚 详细文档

开发相关

# 运行测试
npm test

# 带覆盖率运行测试
npm run test:coverage

# 运行代码检查工具
npm run lint

# 格式化代码
npm run format

贡献指南

1. 叉仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打开拉取请求

📄 许可证

本项目采用 MIT 许可证。