GitHub MCP Server

GitHub MCP Server

site icon
2025.04.04 0
TypeScriptGitHub API代码管理协作工具开发效率
GitHub MCP Server 是一个用于GitHub API的中间件服务,提供文件操作、仓库管理、搜索功能等核心能力。它支持自动分支创建、批量操作、高级搜索等功能,适用于开发团队进行代码管理和协作。
View on GitHub

Overview

基本能力

产品定位

GitHub MCP Server 是一个中间件服务,旨在简化与GitHub API的交互,提供更高效的文件操作、仓库管理和搜索功能。

核心功能

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

适用场景

  • 开发团队进行代码管理和协作
  • 自动化GitHub仓库操作
  • 批量处理GitHub文件
  • 高级代码和问题搜索

工具列表

  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:创建拉取请求
  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个人访问令牌才能使用
  • 支持Docker和NPX两种安装方式
  • 提供详细的搜索语法指南

使用教程

使用依赖

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

安装教程

Docker方式

{
  "mcpServers": {
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "mcp/github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

NPX方式

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

调试方式

  1. 构建Docker镜像:
docker build -t mcp/github -f src/github/Dockerfile .
  1. 运行服务并检查日志输出
  2. 使用提供的工具进行功能测试

许可证

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