🚀 MCP Git 工具

MCP Git 是一款功能强大的工具，它能极大简化与 Git 仓库的交互过程。借助它提供的一系列命令，用户可以轻松执行常见的 Git 操作，如提交、拉取、推送、重置等，提升工作效率。

🚀 快速开始

MCP Git 工具旨在简化与 Git 仓库的交互，让你轻松执行常见的 Git 操作。

✨ 主要特性

• git 提交：创建新的提交。
• git 拉取：从远程仓库获取最新更改。
• git 推送：将本地更改推送到远程仓库。
• git 重置：重置到指定的提交或分支。
• git 差异显示：查看文件之间的差异。
• git 添加：将文件添加到暂存区。
• git 恢复：取消对文件的修改。

📦 安装指南

要使用 MCP Git 工具，请按照以下步骤进行安装：

1. 下载工具包。
2. 解压文件并添加到系统路径中。

💻 使用示例

基础用法

作为独立服务器运行

# 克隆仓库
git clone https://github.com/username/repository.git

# 进入仓库目录
cd repository

# 提交更改
git commit -m "提交信息"

# 推送更改
git push origin main

在 MCP 客户端中使用

# 初始化客户端
client = GitClient(path_to_repository)

# 添加文件到暂存区
client.add("file1.txt")

# 提交更改
commit_info = client.commit(message="提交信息")

# 拉取最新更改
pull_result = client.pull()

# 推送更改
push_result = client.push(remote="origin", branch="main")

集成到自定义服务器中

// 初始化 Git 仓库
Git git = Git.init();

// 添加文件
git.add().addFilepattern("file1.txt").call();

// 提交更改
git.commit().setMessage("提交信息").call();

// 拉取最新更改
git.pull().setRemoteName("origin").setBranchName("main").call();

高级用法

本工具在不同场景下的使用已在基础用法中详细展示，若有更复杂的定制需求，可根据工具详细说明中的参数进行灵活调整。

📚 详细文档

git 提交

功能: 创建一个新的提交。
参数:

• repo_path: 仓库路径。
• message: 提交信息。
• all: 是否自动暂存所有修改文件（可选，默认为 false）。

返回值:

{
  "success": true,
  "hash": "abcd1234",
  "message": "feat: 添加新功能"
}

git 拉取

功能: 从远程仓库拉取最新更改。
参数:

• repo_path: 仓库路径。
• remote: 远程名称（可选，默认为 "origin"）。
• branch: 分支名称（可选，默认为当前分支）。

返回值:

{
  "success": true,
  "remote": "origin",
  "output": "更新完成"
}

git 推送

功能: 将本地更改推送到远程仓库。
参数:

• repo_path: 仓库路径。
• remote: 远程名称（可选，默认为 "origin"）。
• branch: 分支名称（可选，默认为当前分支）。
• force: 是否强制推送（可选，默认为 false）。

返回值:

{
  "success": true,
  "remote": "origin",
  "output": "推送到远程仓库成功"
}

git 重置

功能: 将文件或暂存区重置到指定状态。
参数:

• repo_path: 仓库路径。
• path: 要重置的文件或路径（可选，默认为当前目录）。
• hard: 是否执行硬重置（警告：会丢失所有本地更改）（可选，默认为 false）。

返回值:

{
  "success": true,
  "message": "文件已重置"
}

git 差异显示

功能: 显示指定文件的差异。
参数:

• repo_path: 仓库路径。
• file_name: 要查看差异的文件名。

返回值:

{
  "diff": "+ 行1\n- 行2"
}

git 添加

功能: 将文件添加到暂存区。
参数:

• repo_path: 仓库路径。
• file_name: 要添加的文件名。

返回值:

{
  "success": true,
  "message": "文件已添加到暂存区"
}

📄 许可证

MCP Git 工具遵循 MIT 许可证，允许用户自由使用、修改和分发该工具。