使用说明
项目简介
Git MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 提供标准化的 Git 版本控制功能接口。它允许 LLM 安全地执行各种 Git 操作,例如仓库初始化、克隆、提交、推送等,从而使 LLM 能够更好地理解和操作代码仓库。
主要功能点
- 核心 Git 操作: 支持仓库初始化、克隆、状态查看、文件暂存、提交、分支管理、远程操作、标签管理和存储管理等常用的 Git 功能。
- 批量操作: 支持顺序执行多个 Git 操作,例如一次性暂存、提交和推送多个更改,提高操作效率。
- 安全特性: 具备路径验证、仓库状态验证和全面的错误报告机制,确保 LLM 通过服务器进行 Git 操作的安全性和可靠性。
安装步骤
- 克隆仓库: 在您的本地计算机上克隆 Git MCP Server 仓库:
git clone https://github.com/MCP-Mirror/cyanheads_git-mcp-server.git - 进入项目目录: 导航到克隆下来的项目目录:
cd cyanheads_git-mcp-server - 安装依赖: 使用 npm 安装项目所需的依赖包:
npm install - 构建项目: 编译 TypeScript 代码以生成可执行的 JavaScript 文件:
npm run build
服务器配置
要将 Git MCP Server 与 MCP 客户端连接,您需要在 MCP 客户端的服务器配置中添加 Git 服务器的启动信息。以下是一个配置示例,您需要根据实际情况进行调整:
{ "mcpServers": { "git": { "command": "node", "args": ["/path/to/git-mcp-server/build/index.js"] } } }
- 'server name': 'git' (用户自定义,用于在客户端中标识此服务器)
- 'command': 'node' (运行 Node.js 应用程序的命令)
- 'args': '["/path/to/git-mcp-server/build/index.js"]' (启动 Git MCP Server 的参数,指向 'index.js' 文件的绝对路径,请将 '/path/to/git-mcp-server' 替换为您本地仓库的实际路径)
注意: 'args' 中的路径必须是 Git MCP Server 'build/index.js' 文件的绝对路径。
基本使用方法
配置完成后,您的 MCP 客户端应该能够检测到 Git MCP Server。您可以通过客户端提供的界面或命令来调用 Git 服务器提供的各项功能。
Git MCP Server 提供了丰富的工具 (Tools),例如:
- 'init': 初始化一个新的 Git 仓库。
- 'clone': 克隆远程 Git 仓库到本地。
- 'status': 获取当前 Git 仓库的状态。
- 'add': 暂存文件更改。
- 'commit': 提交更改到 Git 仓库。
- 'push': 将本地提交推送到远程仓库。
- 以及分支、标签、远程仓库和存储管理等相关工具。
具体工具的名称、参数和使用方法,请参考仓库的 'README.md' 文件中 "Tools" 章节的详细说明。您可以通过 MCP 客户端提供的工具调用机制来使用这些 Git 功能,从而实现 LLM 对代码仓库的自动化管理和操作。
信息
分类
开发者工具