GitHub MCP 服务器

为 GitHub API 提供 MCP 服务器，支持文件操作、仓库管理、搜索功能等。

任务小组修改

• github pat 现在每个请求都是动态的，不需要通过环境变量包含，但仍然回退到环境变量。
• 名称：mcp-github

功能

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

工具

1. create_or_update_file

   • 在仓库中创建或更新单个文件
   • 输入：
     • owner (字符串)：仓库所有者（用户名或组织）
     • repo (字符串)：仓库名称
     • path (字符串)：创建/更新文件的路径
     • content (字符串)：文件内容
     • message (字符串)：提交信息
     • branch (字符串)：创建/更新文件的分支
     • sha (可选字符串)：被替换文件的 SHA（用于更新）
   • 返回：文件内容和提交详情

2. push_files

   • 在单个提交中推送多个文件
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • branch (字符串)：推送到的分支
     • files (数组)：要推送的文件，每个文件包含 path 和 content
     • message (字符串)：提交信息
   • 返回：更新后的分支引用

3. search_repositories

   • 搜索 GitHub 仓库
   • 输入：
     • query (字符串)：搜索查询
     • page (可选数字)：分页的页码
     • perPage (可选数字)：每页结果数（最多 100）
   • 返回：仓库搜索结果

4. create_repository

   • 创建新的 GitHub 仓库
   • 输入：
     • name (字符串)：仓库名称
     • description (可选字符串)：仓库描述
     • private (可选布尔值)：仓库是否私有
     • autoInit (可选布尔值)：是否初始化 README
   • 返回：创建的仓库详情

5. get_file_contents

   • 获取文件或目录的内容
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • path (字符串)：文件/目录路径
     • branch (可选字符串)：获取内容的分支
   • 返回：文件/目录内容

6. create_issue

   • 创建新问题
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • title (字符串)：问题标题
     • body (可选字符串)：问题描述
     • assignees (可选字符串数组)：分配的用户名
     • labels (可选字符串数组)：添加的标签
     • milestone (可选数字)：里程碑编号
   • 返回：创建的问题详情

7. create_pull_request

   • 创建新的拉取请求
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • title (字符串)：PR 标题
     • body (可选字符串)：PR 描述
     • head (字符串)：包含更改的分支
     • base (字符串)：要合并到的分支
     • draft (可选布尔值)：是否创建为草稿 PR
     • maintainer_can_modify (可选布尔值)：是否允许维护者编辑
   • 返回：创建的拉取请求详情

8. fork_repository

   • 分叉仓库
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • organization (可选字符串)：分叉到的组织
   • 返回：分叉后的仓库详情

9. create_branch

   • 创建新分支
   • 输入：
     • owner (字符串)：仓库所有者
     • repo (字符串)：仓库名称
     • branch (字符串)：新分支名称
     • from_branch (可选字符串)：源分支（默认为仓库默认分支）
   • 返回：创建的分支引用

10. list_issues

    • 列出并过滤仓库问题
    • 输入：
      • owner (字符串)：仓库所有者
      • repo (字符串)：仓库名称
      • state (可选字符串)：按状态过滤（'open', 'closed', 'all'）
      • labels (可选字符串数组)：按标签过滤
      • sort (可选字符串)：按排序（'created', 'updated', 'comments'）
      • direction (可选字符串)：排序方向（'asc', 'desc'）
      • since (可选字符串)：按日期过滤（ISO 8601 时间戳）
      • page (可选数字)：页码
      • per_page (可选数字)：每页结果数
    • 返回：问题详情数组

11. update_issue

    • 更新现有问题
    • 输入：
      • owner (字符串)：仓库所有者
      • repo (字符串)：仓库名称
      • issue_number (数字)：要更新的问题编号
      • title (可选字符串)：新标题
      • body (可选字符串)：新描述
      • state (可选字符串)：新状态（'open' 或 'closed'）
      • labels (可选字符串数组)：新标签
      • assignees (可选字符串数组)：新分配者
      • milestone (可选数字)：新里程碑编号
    • 返回：更新后的问题详情

12. add_issue_comment

    • 向问题添加评论
    • 输入：
      • owner (字符串)：仓库所有者
      • repo (字符串)：仓库名称
      • issue_number (数字)：要评论的问题编号
      • body (字符串)：评论内容
    • 返回：创建的评论详情

13. search_code

    • 在 GitHub 仓库中搜索代码
    • 输入：
      • q (字符串)：使用 GitHub 代码搜索语法的搜索查询
      • sort (可选字符串)：排序字段（仅 'indexed'）
      • order (可选字符串)：排序顺序（'asc' 或 'desc'）
      • per_page (可选数字)：每页结果数（最多 100）
      • page (可选数字)：页码
    • 返回：带有仓库上下文的代码搜索结果

14. search_issues

    • 搜索问题和拉取请求
    • 输入：
      • q (字符串)：使用 GitHub 问题搜索语法的搜索查询
      • sort (可选字符串)：排序字段（评论、反应、创建时间等）
      • order (可选字符串)：排序顺序（'asc' 或 'desc'）
      • per_page (可选数字)：每页结果数（最多 100）
      • page (可选数字)：页码
    • 返回：问题和拉取请求的搜索结果

15. search_users

    • 搜索 GitHub 用户
    • 输入：
      • q (字符串)：使用 GitHub 用户搜索语法的搜索查询
      • sort (可选字符串)：排序字段（关注者、仓库、加入时间）
      • order (可选字符串）：排序顺序（'asc' 或 'desc'）
      • per_page (可选数字）：每页结果数（最多 100）
      • page (可选数字）：页码
    • 返回：用户搜索结果

16. list_commits

• 获取仓库中分支的提交记录
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • page (可选字符串）：页码
  • per_page (可选字符串）：每页记录数
  • sha (可选字符串）：分支名称
• 返回：提交记录列表

17. get_issue

• 获取仓库中问题的内容
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • issue_number (数字）：要获取的问题编号
• 返回：GitHub 问题对象及详情

18. get_pull_request

• 获取特定拉取请求的详情
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • pull_number (数字）：拉取请求编号
• 返回：拉取请求详情，包括差异和审查状态

19. list_pull_requests

• 列出并过滤仓库的拉取请求
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • state (可选字符串）：按状态过滤（'open', 'closed', 'all'）
  • head (可选字符串）：按头部用户/组织和分支过滤
  • base (可选字符串）：按基础分支过滤
  • sort (可选字符串）：按排序（'created', 'updated', 'popularity', 'long-running'）
  • direction (可选字符串）：排序方向（'asc', 'desc'）
  • per_page (可选数字）：每页结果数（最多 100）
  • page (可选数字）：页码
• 返回：拉取请求详情数组

20. create_pull_request_review

• 在拉取请求上创建审查
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • pull_number (数字）：拉取请求编号
  • body (字符串）：审查评论内容
  • event (字符串）：审查操作（'APPROVE', 'REQUEST_CHANGES', 'COMMENT'）
  • commit_id (可选字符串）：要审查的提交 SHA
  • comments (可选数组）：行特定评论，每个包含：
    • path (字符串）：文件路径
    • position (数字）：差异中的行位置
    • body (字符串）：评论内容
• 返回：创建的审查详情

21. merge_pull_request

• 合并拉取请求
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • pull_number (数字）：拉取请求编号
  • commit_title (可选字符串）：合并提交的标题
  • commit_message (可选字符串）：合并提交的额外详细信息
  • merge_method (可选字符串）：合并方法（'merge', 'squash', 'rebase'）
• 返回：合并结果详情

22. get_pull_request_files

• 获取拉取请求中更改的文件列表
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • pull_number (数字）：拉取请求编号
• 返回：更改的文件数组，包括补丁和状态详情

23. get_pull_request_status

• 获取拉取请求的所有状态检查的综合状态
• 输入：
  • owner (字符串）：仓库所有者
  • repo (字符串）：仓库名称
  • pull_number (数字）：拉取请求编号
• 返回：综合状态检查结果及单个检查详情

24. update_pull_request_branch

• 使用基础分支的最新更改更新拉取请求分支（相当于GitHub的“更新分支”按钮）
• 输入：
  • owner（字符串）：仓库所有者
  • repo（字符串）：仓库名称
  • pull_number（数字）：拉取请求编号
  • expected_head_sha（可选字符串）：拉取请求的HEAD引用的预期SHA
• 返回：分支更新成功时的成功消息

25. get_pull_request_comments

• 获取拉取请求的审阅评论
• 输入：
  • owner（字符串）：仓库所有者
  • repo（字符串）：仓库名称
  • pull_number（数字）：拉取请求编号
• 返回：包含拉取请求审阅评论的数组，包括评论文本、作者和差异中的位置等详细信息

26. get_pull_request_reviews

• 获取拉取请求的审阅
• 输入：
  • owner（字符串）：仓库所有者
  • repo（字符串）：仓库名称
  • pull_number（数字）：拉取请求编号
• 返回：包含拉取请求审阅的数组，包括审阅状态（如APPROVED、CHANGES_REQUESTED等）、审阅者和审阅正文等详细信息

搜索查询语法

代码搜索

• language:javascript：按编程语言搜索
• repo:owner/name：在特定仓库中搜索
• path:app/src：在特定路径中搜索
• extension:js：按文件扩展名搜索
• 示例：q: "import express" language:typescript path:src/

问题搜索

• is:issue 或 is:pr：按类型过滤
• is:open 或 is:closed：按状态过滤
• label:bug：按标签搜索
• author:username：按作者搜索
• 示例：q: "memory leak" is:issue is:open label:bug

用户搜索

• type:user 或 type:org：按账户类型过滤
• followers:>1000：按关注者数量过滤
• location:London：按位置搜索
• 示例：q: "fullstack developer" location:London followers:>100

有关详细的搜索语法，请参阅GitHub的搜索文档。

设置

个人访问令牌

创建GitHub个人访问令牌并授予适当的权限：

• 转到个人访问令牌（在GitHub设置 > 开发者设置中）
• 选择您希望此令牌可以访问的仓库（公开、所有或选择）
• 创建具有repo范围（“对私有仓库的完全控制”）的令牌
  • 或者，如果仅处理公开仓库，则仅选择public_repo范围
• 复制生成的令牌

与Claude Desktop一起使用

要与Claude Desktop一起使用，请将以下内容添加到您的claude_desktop_config.json中：

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>"
      }
    }
  }
}

构建

Docker构建：

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

许可证

此MCP服务器遵循MIT许可证。这意味着您可以自由使用、修改和分发该软件，但需遵守MIT许可证的条款和条件。有关更多详细信息，请参阅项目仓库中的LICENSE文件。