GitHub MCP Server

GitHub MCP Server

site icon
2025.04.03 0
TypeScriptGitHub自动化仓库管理代码搜索CI/CD集成开发效率交流协作
GitHub MCP Server 是一个针对GitHub API的中间件服务,提供文件操作、仓库管理、搜索功能等核心能力。它支持自动分支创建、批量操作、高级搜索等功能,并保持Git历史完整性。适用于需要自动化GitHub操作、批量处理仓库内容或构建GitHub相关工具的场景。
View on GitHub

Overview

基本能力

产品定位

GitHub MCP Server 是一个GitHub API的增强中间件,旨在简化复杂的GitHub操作流程,提供更高效的仓库管理和自动化能力。

核心功能

  • 自动分支创建:在文件操作时自动处理分支逻辑
  • 批量操作支持:支持单文件和多文件操作
  • 高级搜索:代码、Issue/PR、用户的多维度搜索
  • Git历史保护:所有操作均保持完整的Git历史记录
  • 全面错误处理:清晰的错误提示机制

适用场景

  1. 自动化GitHub工作流
  2. 批量处理仓库内容
  3. 构建GitHub相关工具
  4. CI/CD流程集成
  5. 代码搜索和分析

工具列表

  1. create_or_update_file - 创建/更新单个文件
  2. push_files - 批量推送文件
  3. search_repositories - 仓库搜索
  4. create_repository - 创建新仓库
  5. get_file_contents - 获取文件内容
  6. create_issue - 创建Issue
  7. create_pull_request - 创建PR
  8. fork_repository - Fork仓库
  9. create_branch - 创建分支
  10. list_issues - 列出Issue
  11. update_issue - 更新Issue
  12. add_issue_comment - 添加Issue评论
  13. search_code - 代码搜索
  14. search_issues - Issue/PR搜索
  15. search_users - 用户搜索
  16. list_commits - 列出提交
  17. get_issue - 获取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评审
  27. list_workflow_runs - 列出工作流运行
  28. get_workflow_run - 获取工作流运行详情
  29. list_workflow_runs_by_workflow_id - 按工作流ID列出运行
  30. get_workflow_run_logs - 获取工作流日志
  31. download_and_unzip - 下载并解压文件

常见问题

  1. 需要GitHub Personal Access Token才能使用
  2. 批量操作时注意API速率限制
  3. 文件操作会自动创建分支
  4. 搜索功能支持GitHub原生查询语法

使用教程

使用依赖

  1. 创建GitHub Personal Access Token:
# 访问 https://github.com/settings/tokens
# 选择repo或public_repo权限

安装教程

Docker方式:

docker build -t mcp/github -f src/github/Dockerfile .

NPX方式:

npx -y @modelcontextprotocol/server-github

调试方式

  1. 设置环境变量:
export GITHUB_PERSONAL_ACCESS_TOKEN="your_token"
  1. 测试基本功能:
# 测试仓库搜索
curl -X POST http://localhost:3000/search_repositories -d '{"query":"mcp"}'

许可证

该项目遵循 MIT 开源许可条款。