GitHub MCP Server

GitHub MCP Server

site icon
2025.03.30 0
TypeScript代码管理开发协作自动化工作流开发效率交流协作
GitHub MCP Server 是一个基于 GitHub API 的 MCP 服务,提供文件操作、仓库管理、搜索功能等。它支持自动分支创建、错误处理、Git 历史保留、批量操作和高级搜索等功能,适用于开发团队协作和代码管理。
View on GitHub

Overview

基本能力

产品定位

GitHub MCP Server 是一个基于 GitHub API 的 MCP 服务,旨在简化 GitHub 仓库的管理和操作,提供高效的开发协作工具。

核心功能

  • 自动分支创建:在创建/更新文件或推送更改时自动创建分支
  • 全面的错误处理:提供清晰的错误消息
  • Git 历史保留:操作保持 Git 历史,无需强制推送
  • 批量操作:支持单文件和多文件操作
  • 高级搜索:支持代码、问题/PR 和用户搜索

适用场景

  • 开发团队协作
  • 代码管理
  • 自动化工作流

工具列表

  1. create_or_update_file:创建或更新单个文件
  2. push_files:推送多个文件
  3. search_repositories:搜索 GitHub 仓库
  4. create_repository:创建新仓库
  5. get_file_contents:获取文件/目录内容
  6. create_issue:创建新问题
  7. create_pull_request:创建新 PR
  8. fork_repository:分叉仓库
  9. create_branch:创建新分支
  10. list_issues:列出和过滤问题
  11. update_issue:更新问题
  12. add_issue_comment:添加问题评论
  13. search_code:搜索代码
  14. search_issues:搜索问题和 PR
  15. search_users:搜索用户
  16. list_commits:获取分支提交
  17. get_issue:获取问题内容
  18. get_pull_request:获取 PR 详情
  19. list_pull_requests:列出和过滤 PR
  20. create_pull_request_review:创建 PR 审查
  21. merge_pull_request:合并 PR
  22. get_pull_request_files:获取 PR 更改文件
  23. get_pull_request_status:获取 PR 状态检查
  24. update_pull_request_branch:更新 PR 分支
  25. get_pull_request_comments:获取 PR 评论
  26. get_pull_request_reviews:获取 PR 审查

常见问题解答

  • 如何设置个人访问令牌:在 GitHub 设置中创建具有 repopublic_repo 范围的令牌
  • 如何使用 Docker:通过 Docker 运行服务并设置环境变量
  • 如何使用 NPX:通过 NPX 直接运行服务

使用教程

使用依赖

  1. 创建 GitHub 个人访问令牌:
  2. 访问 Personal access tokens
  3. 选择适当的仓库访问权限
  4. 创建具有 repopublic_repo 范围的令牌

安装教程

Docker 安装

docker build -t mcp/github -f Dockerfile .

NPX 安装

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

调试方式

  1. 确保环境变量 GITHUB_PERSONAL_ACCESS_TOKEN 已正确设置
  2. 使用 docker runnpx 命令启动服务
  3. 检查日志以确认服务正常运行

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。