MCP 服务器

GitHub MCP Server

通过自然语言实现全面的 GitHub 操作，包括文件管理、存储库管理、问题跟踪和高级代码搜索。

README

GitHub MCP 服务器

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

功能

自动分支创建: 在创建/更新文件或推送更改时，如果分支不存在，则自动创建分支
全面的错误处理: 针对常见问题的清晰错误消息
Git 历史记录保留: 操作维护正确的 Git 历史记录，而无需强制推送
批量操作: 支持单文件和多文件操作
高级搜索: 支持搜索代码、问题/PR 和用户
项目管理: 完整的 GitHub Projects (classic) 管理工具集，包括创建项目、管理列和处理卡片

工具

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

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

get_issue

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

delete_issue

使用 GraphQL API 从 GitHub 仓库中删除 issue
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- issue_number (number): 要删除的 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 (optional string): 按状态筛选 ('open', 'closed', 'all')
- head (optional string): 按 head 用户/组织和分支筛选
- base (optional string): 按 base 分支筛选
- sort (optional string): 按以下内容排序 ('created', 'updated', 'popularity', 'long-running')
- direction (optional string): 排序方向 ('asc', 'desc')
- per_page (optional number): 每页结果数（最多 100）
- page (optional 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 (optional string): 要审核的提交的 SHA
- comments (optional array): 行特定评论，每个评论都有：
  - path (string): 文件路径
  - position (number): diff 中的行位置
  - body (string): 评论文本
返回: 创建的审核详情

merge_pull_request

合并 pull request
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
- commit_title (optional string): 合并提交的标题
- commit_message (optional string): 合并提交的额外详细信息
- merge_method (optional 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 的“更新分支”按钮）
输入:
- owner (string): 仓库所有者
- repo (string): 仓库名称
- pull_number (number): Pull request 编号
- expected_head_sha (optional 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 等）、审核者和审核正文等详细信息

create_project

在 GitHub 仓库中创建一个新项目
输入:
- owner (string): 仓库所有者（用户名或组织）
- repo (string): 仓库名称
- name (string): 项目名称
- body (optional string): 项目描述
返回: 创建的项目详情

get_project

获取有关特定项目的详细信息
输入:
- owner (string): 仓库所有者（用户名或组织）
- repo (string): 仓库名称
- project_number (number): 项目编号
返回: 项目详情

update_project

更新现有项目的详细信息
输入:
- project_id (number): 项目的唯一标识符
- name (optional string): 项目的新名称
- body (optional string): 项目的新描述
- state (optional string): 项目的状态 ('open' 或 'closed')
返回: 更新的项目详情

list_projects

列出 GitHub 仓库中的所有项目
输入:
- owner (string): 仓库所有者（用户名或组织）
- repo (string): 仓库名称
- state (optional string): 按状态筛选项目 ('open', 'closed', 'all')
- page (optional number): 分页的页码（从 1 开始）
- per_page (optional number): 每页结果数（最多 100）
返回: 项目详情数组

create_project_column

在项目中创建一个新列
输入:
- owner (string): 仓库所有者（用户名或组织）
- repo (string): 仓库名称
- project_number (number): 项目编号
- name (string): 列名称
返回: 创建的列详情

list_project_columns

列出项目中的所有列
输入:
- project_id (number): 项目的唯一标识符
- page (optional number): 分页的页码（从 1 开始）
- per_page (optional number): 每页结果数（最多 100）
返回: 项目列详情数组

update_project_column

更新现有的项目列
输入:
- column_id (number): 列的唯一标识符
- name (string): 列的新名称
返回: 更新的列详情

delete_project_column

删除项目列
输入:
- column_id (number): 列的唯一标识符
返回: 成功消息

add_card_to_column

向项目列添加新卡片
输入:
- owner (string): 仓库所有者（用户名或组织）
- repo (string): 仓库名称
- column_id (string): 要添加卡片的列的 ID
- content_type (string): 卡片的内容类型 ('Issue', 'PullRequest', 'Note')
- content_id (optional number): issue 或 pull request 的 ID（如果 content_type 为 Issue 或 PullRequest，则为必填项）
- note (optional string): 卡片的注释内容（如果 content_type 为 Note，则为必填项）
返回: 创建的卡片详情

list_column_cards

列出项目列中的所有卡片
输入:
- column_id (number): 列的唯一标识符
- archived_state (optional string): 按卡片存档状态筛选 ('all', 'archived', 'not_archived')
- page (optional number): 分页的页码（从 1 开始）
- per_page (optional number): 每页结果数（最多 100）
返回: 卡片详情数组

move_card

将卡片移动到不同的位置或列
输入:
- card_id (number): 卡片的唯一标识符
- position (string): 卡片的位置 ('top', 'bottom', 或 'after:<card_id>')
- column_id (optional number): 要将卡片移动到的列 ID
返回: 成功消息

delete_card

从项目中删除卡片
输入:
- card_id (number): 卡片的唯一标识符
返回: 成功消息

list_organization_projects

列出 GitHub 组织中的所有项目（在组织级别，而不是仓库级别）
输入:
- org (string): 组织名称
- state (optional string): 按状态筛选项目 ('open', 'closed', 'all')
- page (optional number): 分页的页码
- per_page (optional number): 每页结果数（最多 100）
返回: 组织项目详情数组

Projects V2 工具 (GitHub 的新项目体验)

list_organization_projects_v2

使用 GraphQL API 列出 GitHub 组织中的 Projects V2
输入:
- org (string): 组织名称
- first (optional number): 要获取的项目数（最多 100）
- after (optional string): 分页的光标
- orderBy (optional object): 如何对项目进行排序
返回: 带有分页信息的项目数组

get_project_v2

使用 GraphQL API 获取 GitHub Project V2 的详细信息
输入:
- id (string): 项目的节点 ID
返回: 详细的项目信息，包括字段和视图

create_project_v2

使用 GraphQL API 创建新的 GitHub Project V2
输入:
- ownerId (string): 组织或用户的节点 ID
- title (string): 项目标题
- description (optional string): 项目描述
返回: 创建的项目详情

update_project_v2

使用 GraphQL API 更新 GitHub Project V2
输入:
- projectId (string): 项目的节点 ID
- title (optional string): 项目的新标题
- description (optional string): 项目的新描述
- closed (optional boolean): 是否关闭项目
返回: 更新的项目详情

add_item_to_project_v2

使用 GraphQL API 将 issue 或 pull request 添加到 GitHub Project V2
输入:
- projectId (string): 项目的节点 ID
- contentId (string): 要添加的 issue 或 pull request 的节点 ID
返回: 添加的项目详情

list_project_v2_items

使用 GraphQL API 列出 GitHub Project V2 中的项目
输入:
- projectId (string): 项目的节点 ID
- first (optional number): 要获取的项目数（最多 100）
- after (optional string): 分页的光标
- filterBy (optional object): 项目的过滤器
返回: 带有字段值的项目数组

update_project_v2_item_field

使用 GraphQL API 更新 GitHub Project V2 中项目的字段值
输入:
- projectId (string): 项目的节点 ID
- itemId (string): 项目的节点 ID
- fieldId (string): 字段的节点 ID
- value (any): 字段的新值
返回: 更新的项目详情

项目管理说明

弃用警告: GitHub 已宣布 Projects (classic) 将被弃用，转而支持新的 Projects 体验。工具 27-39 适用于经典版本的 Projects，该版本将来可能会被删除。对于新的 GitHub Projects 体验，请改用工具 40-46。

搜索查询语法

代码搜索

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 设置 > 开发者设置中）
选择您希望此令牌有权访问的仓库（公共、全部或选择）
创建一个具有 repo 范围（“完全控制私有仓库”）的令牌
- 或者，如果仅使用公共仓库，则仅选择 public_repo 范围
- 对于使用 Projects V2 工具，请确保也包括 project 范围
复制生成的令牌

与 Claude Desktop 一起使用

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

Docker

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

NPX

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

构建

Docker 构建:

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

许可证

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