README
🚀 Git MCP 服务器
一个实现模型上下文协议 (MCP) 的服务器,为大型语言模型提供全面的 Git 功能,使其能够通过安全且标准化的接口执行版本控制操作。
🚀 快速开始
Git MCP Server 实现了由 Anthropic 创建的 Model Context Protocol (MCP),该协议为大型语言模型和外部系统之间的通信提供了一个标准化接口。借助此服务器,大型语言模型能通过安全且标准化的接口执行版本控制操作。
✨ 主要特性
核心 Git 操作
- 仓库初始化和克隆
- 文件阶段化和提交
- 分支管理
- 远端操作
- 标签处理
- 复制存档
批量操作
- 顺序操作执行
- 原子提交
- 智能默认值
- 错误恢复
安全功能
- 路径验证
- 仓库状态验证
- 嵌入式仓库处理
- 全面错误报告
📦 安装指南
设置步骤
- 克隆存储库
git clone [repository-url] cd mcp-git-server - 安装依赖项
npm install - 启动开发服务器(可选)
npm run dev
📚 详细文档
配置
环境变量
PORT:指定服务运行的端口,默认为 3000。DEBUG:启用调试模式,值设为true。
# 启动时设置环境变量
PORT=3001 DEBUG=true npm start
工具
安装依赖
npm install express mcp-router
最佳实践
- 路径管理:始终使用绝对路径,避免相对路径。
- 错误处理:在每次操作后检查结果,并记录日志或报告错误。
开发
# 构建项目
npm run build
# 监视文件变化
npm run watch
# 运行 MCP 检查工具
npm run inspector
错误处理
服务器提供详细的错误信息:
- 无效的路径或参数
- Git 命令失败
- 仓库状态错误
- 权限问题
贡献
欢迎贡献!请按照以下步骤操作:
- ** Fork 代码库**
- ** 创建功能分支**
- ** 提交更改**
- ** 推送到分支**
- ** 创建 Pull Request**
对于 bug 和功能请求,请创建 issue。
接下来计划
文档中未提及具体内容,暂不展示相关章节。
📄 许可证
Apache License 2.0
Scan to join WeChat group