Github Mcp Server

Github MCP Server

🔗 在 MCP Market 中查看
🔗 在 MCP Registry 中查看
📦 可在 npm 上获取

一个 Model Context Protocol (MCP) 服务，为 AI 助手和开发者提供 29 项 Git 操作 + 11 种工作流组合。此服务通过标准化接口提供全面的 Git 仓库管理功能，让 AI 模型和开发者能够安全地管理复杂的版本控制工作流。

🚀 快速安装

选项 1：.vscode/mcp.json（推荐）

{
  "mcpServers": {
    "github-mcp-server": {
      "command": "npx",
      "args": ["-y", "@0xshariq/github-mcp-server@latest"]
    }
  }
}

选项 2：用于 CLI

pnpm i -g @0xshariq/github-mcp-server@latest

# Test Commands After Installation
gstatus
gadd
glog 10
gpush

选项 3：符号链接（替代方案——无需包管理器）

# Clone and setup
git clone https://github.com/0xshariq/github-mcp-server.git
cd github-mcp-server
npm install && npm run build

# Create symbolic links (cross-platform)
./setup-symbolic.sh --user          # User installation
# OR
sudo ./setup-symbolic.sh           # System-wide (Linux/macOS)

# Test the installation
gstatus
glist

🛠️ 遇到问题？ 如果安装后命令无法运行，请参阅我们的 完整故障排除指南，了解常见问题的解决方法，包括“找不到命令”错误、路径冲突、PNPM 问题以及符号链接替代方案。

🎯 关于

GitHub MCP Server 为 AI 助手与 Git 仓库搭建桥梁，并提供强大的开发者效率工具。它提供：

• 通过标准化 MCP 接口执行 安全的 Git 操作（29 项操作）
• 完整的版本控制功能，包括高级操作（tag、merge、rebase、cherry-pick、blame、bisect）
• 31 种工作流组合，提升开发者效率
• 高级开发者工具（备份、清理、工作流自动化）
• 错误处理和验证，以避免常见的 Git 错误
• 与 VS Code 和 GitHub Copilot 等 AI 助手直接集成
• 用于终端访问和自动化的 CLI 封装器

🚀 功能概览

此服务通过两大类别提供全面的 Git 仓库管理功能：

📁 基础 Git 操作（17 项操作）

bin/basic/ 中整理了日常必需的 Git 命令；详细文档请参阅 基础操作指南。

• 文件管理：将文件添加到暂存区或从暂存区移除
• 仓库信息：状态、历史记录、差异
• 提交操作：创建提交、推送、拉取
• 分支管理：创建、切换分支
• 远程管理：添加、移除、配置远程仓库
• 储藏操作：临时保存更改
• 重置操作：管理仓库状态

🚀 高级 Git 操作（12 项操作）

bin/advanced/ 中提供复杂工作流和自动化功能；完整文档请参阅 高级工作流指南。

• 工作流组合：完整流程（add→commit→push）、快速提交、同步操作
• 开发工具：智能开发工作流、备份系统
• 高级 Git 功能：标签、合并、变基、挑选提交、blame、bisect
• 维护与安全：仓库清理、优化、备份管理
• 专业工作流：发布管理、热修复流程、团队协作

🛠️ 安装

请参阅 markdown/INSTALLATION.md，了解适用于 Windows、macOS、WSL 和所有平台的详细安装指南。

🏗️ 项目结构与架构

GitHub MCP Server 的组织结构清晰，便于循序渐进地学习：

github-mcp-server/
├── src/
│   ├── index.ts              # MCP server (29 tool registrations, schema definitions)
│   └── github.ts             # Git operations engine (all 29 implementations)
├── bin/
│   ├── basic/                # 📁 17 Essential Git Operations
│   │   ├── README.md         # Comprehensive basic operations guide
│   │   ├── gadd.js           # Add files (git add)
│   │   ├── gcommit.js        # Create commits (git commit)
│   │   ├── gpush.js          # Push changes (git push)
│   │   ├── gpull.js          # Pull changes (git pull)
│   │   ├── gstatus.js        # Repository status (git status)
│   │   ├── gbranch.js        # Branch management (git branch)
│   │   ├── gcheckout.js      # Branch switching (git checkout)
│   │   ├── glog.js           # Commit history (git log)
│   │   ├── gdiff.js          # Show differences (git diff)
│   │   ├── gstash.js         # Stash operations (git stash)
│   │   ├── gpop.js           # Apply stash (git stash pop)
│   │   ├── greset.js         # Reset operations (git reset)
│   │   ├── gclone.js         # Clone repositories (git clone)
│   │   ├── gremote.js        # Remote management (git remote)
│   │   └── ginit.js          # Initialize repository (git init)
│   └── advanced/             # 🚀 13 Advanced Workflows & Automation
│       ├── README.md         # Comprehensive advanced workflows guide
│       ├── gflow.js          # Complete workflow (add→commit→push)
│       ├── gquick.js         # Quick commit workflow
│       ├── gsync.js          # Sync workflow (pull→push)
│       ├── gdev.js           # Development session management
│       ├── gworkflow.js      # Professional workflow combinations
│       ├── gfix.js           # Smart fix and patch workflows
│       ├── gfresh.js         # Fresh start workflows
│       ├── gbackup.js        # Backup and safety operations
│       ├── gclean.js         # Repository cleanup and optimization
│       ├── gsave.js          # Save and preserve workflows
│       ├── glist.js          # Tool discovery and help system
│       ├── grelease.js       # Release management workflows
│       └── common.js         # Shared utilities and helpers
├── markdown/
│   ├── INSTALLATION.md      # Detailed installation guide
│   ├── DEPLOY.md            # Production deployment guide
│   ├── DOCKER.md            # Docker setup and deployment guide
│   └── QUICK_REFERENCES.md  # Copy-paste command reference
├── mcp-cli.js               # Enhanced CLI wrapper (organized by structure)
├── package.json             # Project configuration & npm scripts
├── tsconfig.json            # TypeScript configuration
└── README.md                # This comprehensive guide

📖 文档结构

• bin/basic/README.md - 17 个基础 Git 操作的完整指南
• bin/advanced/README.md - 全面的高级工作流文档
• markdown/INSTALLATION.md - 适用于所有平台的分步安装指南
• markdown/TROUBLESHOOTING.md - 🛠️ 完整的故障排除指南 - 所有常见问题的解决方案
• markdown/MCP_UNIVERSAL_CONFIG.md - 适用于所有大模型客户端的通用 MCP 配置
• markdown/QUICK_REFERENCES.md - 可复制粘贴的命令速查
• markdown/DOCKER.md - Docker 设置、部署和容器化
• markdown/DEPLOY.md - 生产环境部署和托管策略

🔧 技术架构

📡 MCP 服务核心（src/index.ts）

• 29 项工具注册，包含完整的 JSON 架构
• 增强的元数据，支持操作跟踪和性能监控
• 输入验证，使用 Zod 架构确保类型安全
• 错误处理管道，包含超时保护和有意义的提示信息
• 跨平台兼容性，支持环境规范化

⚙️ Git 操作引擎（src/github.ts）

• 全面实现全部 29 项 Git 操作
• 安全功能 - 防止命令注入并清理输入
• 增强的错误处理，针对常见场景提供上下文相关的提示信息
• 性能监控 - 跟踪并记录操作耗时
• 安全检查 - 验证代码库并确认文件存在

🖥️ 增强型 CLI 系统

• 智能组织 - 按基础和高级操作对工具分类
• 目录感知帮助 - 指向相应 README 文件以获取详细指南
• 渐进式学习 - 提供从基础操作到高级操作的清晰路径
• 工具发现 - 增强的 glist 命令支持按类别筛选

🛡️ 错误处理与安全

• 🔍 代码库验证：确保目录是有效的 Git 代码库
• 📁 文件存在性检查：在执行 Git 操作前验证文件是否存在
• ⏱️ 超时保护：操作超时时间为 30 秒
• 🚫 输入清理：防止命令注入
• 📝 详细错误消息：清晰且可执行的错误说明

🛠️ 故障排除

安装遇到问题或命令无法正常工作？我们来帮你！全面的故障排除指南涵盖所有常见问题的解决方案：

🚨 最常见问题与快速修复

问题	快速解决方案
💥 出现 command not found 错误	unset command_not_found_handle
📁 与 PNPM 的路径冲突	从全局目录中移除 /5/
🔗 命令显示帮助信息而非执行	更新包装脚本以传递命令名称
🚫 权限被拒绝	chmod +x ~/.local/share/pnpm/g*

👉 如需详细解决方案、分步修复方法和诊断工具，请参阅我们的完整故障排除指南

🆘 快速诊断

# Test if commands are working
gstatus                    # Should show repository status
env gstatus               # Alternative if above fails
which gstatus             # Should show path to command

# If still having issues, see TROUBLESHOOTING.md for complete solutions

许可证

ISC 许可证

作者

为支持 Model Context Protocol 的 AI 助手而创建。