MCP 服务器

GitHub MCP Server

joon1251ai

开发者工具

访问服务器

README

GitHub MCP 服务器

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

功能

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

工具

create_or_update_file
- 在仓库中创建或更新单个文件
- 输入:
  - owner (string): 仓库所有者 (用户名或组织)
  - repo (string): 仓库名称
  - path (string): 创建/更新文件的路径
  - content (string): 文件内容
  - message (string): 提交消息
  - branch (string): 在哪个分支中创建/更新文件
  - sha (可选 string): 被替换文件的 SHA (用于更新)
- 返回: 文件内容和提交详情
push_files
- 在单个提交中推送多个文件
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - branch (string): 推送到的分支
  - files (array): 要推送的文件，每个文件都包含 path 和 content
  - message (string): 提交消息
- 返回: 更新后的分支引用
search_repositories
- 搜索 GitHub 仓库
- 输入:
  - query (string): 搜索查询
  - page (可选 number): 分页的页码
  - perPage (可选 number): 每页结果数 (最大 100)
- 返回: 仓库搜索结果
create_repository
- 创建一个新的 GitHub 仓库
- 输入:
  - name (string): 仓库名称
  - description (可选 string): 仓库描述
  - private (可选 boolean): 仓库是否应为私有
  - autoInit (可选 boolean): 使用 README 初始化
- 返回: 创建的仓库详情
get_file_contents
- 获取文件或目录的内容
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - path (string): 文件/目录的路径
  - branch (可选 string): 从哪个分支获取内容
- 返回: 文件/目录内容
create_issue
- 创建一个新的 issue
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - title (string): Issue 标题
  - body (可选 string): Issue 描述
  - assignees (可选 string[]): 要分配的用户名
  - labels (可选 string[]): 要添加的标签
  - milestone (可选 number): 里程碑编号
- 返回: 创建的 issue 详情
create_pull_request
- 创建一个新的 pull request
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - title (string): PR 标题
  - body (可选 string): PR 描述
  - head (string): 包含更改的分支
  - base (string): 要合并到的分支
  - draft (可选 boolean): 创建为草稿 PR
  - maintainer_can_modify (可选 boolean): 允许维护者编辑
- 返回: 创建的 pull request 详情
fork_repository
- Fork 一个仓库
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - organization (可选 string): 要 fork 到的组织
- 返回: Fork 的仓库详情
create_branch
- 创建一个新的分支
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - branch (string): 新分支的名称
  - from_branch (可选 string): 源分支 (默认为仓库默认分支)
- 返回: 创建的分支引用
list_issues
- 列出和过滤仓库 issue
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - state (可选 string): 按状态过滤 ('open', 'closed', 'all')
  - labels (可选 string[]): 按标签过滤
  - sort (可选 string): 按 ('created', 'updated', 'comments') 排序
  - direction (可选 string): 排序方向 ('asc', 'desc')
  - since (可选 string): 按日期过滤 (ISO 8601 时间戳)
  - page (可选 number): 页码
  - per_page (可选 number): 每页结果数
- 返回: issue 详情数组
update_issue
- 更新现有的 issue
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - issue_number (number): 要更新的 issue 编号
  - title (可选 string): 新标题
  - body (可选 string): 新描述
  - state (可选 string): 新状态 ('open' 或 'closed')
  - labels (可选 string[]): 新标签
  - assignees (可选 string[]): 新受让人
  - milestone (可选 number): 新里程碑编号
- 返回: 更新后的 issue 详情
add_issue_comment
- 向 issue 添加评论
- 输入:
  - owner (string): 仓库所有者
  - repo (string): 仓库名称
  - issue_number (number): 要评论的 issue 编号
  - body (string): 评论文本
- 返回: 创建的评论详情
search_code
- 搜索 GitHub 仓库中的代码
- 输入:
  - q (string): 使用 GitHub 代码搜索语法的搜索查询
  - sort (可选 string): 排序字段 ('indexed' only)
  - order (可选 string): 排序顺序 ('asc' 或 'desc')
  - per_page (可选 number): 每页结果数 (最大 100)
  - page (可选 number): 页码
- 返回: 带有仓库上下文的代码搜索结果
search_issues
- 搜索 issue 和 pull request
- 输入:
  - q (string): 使用 GitHub issue 搜索语法的搜索查询
  - sort (可选 string): 排序字段 (comments, reactions, created, etc.)
  - order (可选 string): 排序顺序 ('asc' 或 'desc')
  - per_page (可选 number): 每页结果数 (最大 100)
  - page (可选 number): 页码
- 返回: issue 和 pull request 搜索结果
search_users
- 搜索 GitHub 用户
- 输入:
  - q (string): 使用 GitHub 用户搜索语法的搜索查询
  - sort (可选 string): 排序字段 (followers, repositories, joined)
  - order (可选 string): 排序顺序 ('asc' 或 'desc')
  - per_page (可选 number): 每页结果数 (最大 100)
  - page (可选 number): 页码
- 返回: 用户搜索结果
list_commits

获取仓库中某个分支的提交
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- page (可选 string): 页码
- per_page (可选 string): 每页记录数
- sha (可选 string): 分支名称
返回: 提交列表

get_issue

获取仓库中 issue 的内容
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- issue_number (number): 要检索的 issue 编号
返回: Github Issue 对象和详细信息

get_pull_request

获取特定 pull request 的详细信息
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
返回: Pull request 详细信息，包括 diff 和审核状态

list_pull_requests

列出和过滤仓库 pull request
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- state (可选 string): 按状态过滤 ('open', 'closed', 'all')
- head (可选 string): 按 head 用户/组织和分支过滤
- base (可选 string): 按 base 分支过滤
- sort (可选 string): 按 ('created', 'updated', 'popularity', 'long-running') 排序
- direction (可选 string): 排序方向 ('asc', 'desc')
- per_page (可选 number): 每页结果数 (最大 100)
- page (可选 number): 页码
返回: pull request 详情数组

create_pull_request_review

在 pull request 上创建审核
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
- body (string): 审核评论文本
- event (string): 审核操作 ('APPROVE', 'REQUEST_CHANGES', 'COMMENT')
- commit_id (可选 string): 要审核的提交的 SHA
- comments (可选 array): 行特定评论，每个评论包含:
  - path (string): 文件路径
  - position (number): diff 中的行位置
  - body (string): 评论文本
返回: 创建的审核详情

merge_pull_request

合并 pull request
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
- commit_title (可选 string): 合并提交的标题
- commit_message (可选 string): 合并提交的额外详细信息
- merge_method (可选 string): 合并方法 ('merge', 'squash', 'rebase')
返回: 合并结果详情

get_pull_request_files

获取 pull request 中更改的文件列表
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
返回: 更改的文件数组，包含 patch 和状态详情

get_pull_request_status

获取 pull request 的所有状态检查的组合状态
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
返回: 组合状态检查结果和单个检查详情

update_pull_request_branch

使用 base 分支的最新更改更新 pull request 分支 (相当于 GitHub 的 "Update branch" 按钮)
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
- expected_head_sha (可选 string): pull request 的 HEAD ref 的预期 SHA
返回: 分支更新成功消息

get_pull_request_comments

获取 pull request 上的审核评论
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
返回: pull request 审核评论数组，包含评论文本、作者和 diff 中的位置等详细信息

get_pull_request_reviews

获取 pull request 上的审核
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
返回: pull request 审核数组，包含审核状态 (APPROVED, CHANGES_REQUESTED 等)、审核者和审核正文等详细信息

搜索查询语法

代码搜索

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

Issues 搜索

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

Users 搜索

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

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

设置

个人访问令牌

创建一个具有适当权限的 GitHub 个人访问令牌:

转到个人访问令牌 (在 GitHub 设置 > 开发者设置中)
选择您希望此令牌访问的仓库 (Public, All, 或 Select)
创建一个具有 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 文件。