ghcr.io/github/github-mcp-server:2.0

GitHub MCP Server

GitHub MCP Server 可将 AI 工具直接对接至 GitHub 平台，让 AI 代理、助手与聊天机器人无需额外开发，仅通过自然语言交互即可完成读取仓库与代码文件、管理议题与 PR、代码分析、自动化工作流等操作。

使用场景

• 仓库管理：浏览、查询代码，搜索文件，分析提交记录，任意访问你有权限的仓库，掌握项目整体结构。
• 议题与 PR 自动化：创建、更新、管理议题与拉取请求，借助 AI 完成 Bug 分类、代码变更评审、项目看板维护等工作。
• CI/CD 与工作流智能分析：监控 GitHub Actions 工作流运行状态，分析构建失败原因，管理版本发布，获取开发流水线的运行洞察。
• 代码分析：查看安全检测结果、审查 Dependabot 警报、理解代码模式，获取代码库的全面分析结论。
• 团队协作：访问团队讨论内容、管理通知、分析团队活动，为团队优化流程、提升协作效率。

本工具专为希望将 AI 工具对接 GitHub 上下文与能力的开发者打造，支持从简单自然语言查询到复杂多步骤代理工作流的全场景需求。

---

远程 GitHub MCP Server

前置条件

1. 兼容的支持远程服务器的 MCP 主机（VS Code 1.101+、Claude Desktop、Cursor、Windsurf 等）
2. 已启用所有适用的https://github.com/github/github-mcp-server/blob/main/docs/policies-and-governance.md

在 VS Code 中安装

如需快速安装，可使用上方提供的一键安装按钮。完成安装流程后，切换 Copilot Chat 文本输入框旁的代理模式开关，服务器就会自动启动。请确保你使用的是 https://code.visualstudio.com/updates/v1_101 或https://code.visualstudio.com/updates，以支持远程 MCP 和 OAuth 功能。

你也可以选择手动配置 VS Code：从下方示例中选取对应 JSON 代码块，添加至你的主机配置中即可：

使用 OAuth 认证

VS Code（1.101 及以上版本）

{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/"
}
}
}

使用 GitHub PAT 认证

{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
}
},
"inputs": [
{
"type": "promptString",
"id": "github_mcp_pat",
"description": "GitHub Personal Access Token",
"password": true
}
]
}

在其他 MCP 主机中安装

• Copilot CLI — GitHub Copilot CLI 安装指南
• 其他 IDE 中的 GitHub Copilot — JetBrains、Visual Studio、Eclipse 和 Xcode 环境下配置 GitHub Copilot 的安装说明
• Claude 应用 — Claude Desktop 和 Claude Code CLI 安装指南
• Codex — OpenAI Codex 安装指南
• Cursor — Cursor IDE 安装指南
• OpenCode — OpenCode 终端代理安装指南
• Windsurf — Windsurf IDE 安装指南
• Zed — Zed 编辑器安装指南
• Rovo Dev CLI — Rovo Dev CLI 安装指南

[!NOTE] 每款 MCP 主机应用都需要单独配置 GitHub App 或 OAuth App，才能支持通过 OAuth 完成远程访问。所有支持远程 MCP 服务器的主机应用，都可以通过 PAT 认证对接远程 GitHub 服务器。不同主机的配置细节和支持程度存在差异，请参考对应主机应用的官方文档获取更多信息。

配置

工具集配置

关于远程服务器配置、工具集、请求头及高级用法的完整说明，请参阅远程服务器文档。该文档提供了在 VS Code 及其他 MCP 主机中连接、自定义、安装远程 GitHub MCP Server 的全部说明和示例。 如果未指定任何工具集，系统将使用默认工具集。

内测模式

抢先体验新功能！ 远程服务器提供内测版本，可提前访问新特性与实验性工具。

通过 URL 路径启用

{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/insiders"
}
}
}

通过请求头启用

{
"servers": {
"github": {
"type": "http",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"X-MCP-Insiders": "true"
}
}
}
}

更多详情与示例请查看远程服务器文档，完整可使用的内测功能清单请参考内测特性文档。

GitHub Enterprise 适配

支持数据驻留的 GitHub Enterprise Cloud（ghe.com）

GitHub Enterprise Cloud 同样可以使用该远程服务器。 以使用 GitHub PAT 令牌、域名为 https://octocorp.ghe.com 的企业实例为例：

{
...
"github-octocorp": {
"type": "http",
"url": "https://copilot-api.octocorp.ghe.com/mcp",
"headers": {
"Authorization": "Bearer ${input:github_mcp_pat}"
}
},
...
}

[!NOTE] 如果你在 VS Code 中配合 GitHub Copilot 对 GitHub Enterprise 使用 OAuth 认证，还需要调整 VS Code 设置指向你的 GitHub Enterprise 实例，具体操作请参考https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/configure-personal-settings/authenticate-to-ghecom。

GitHub Enterprise Server

GitHub Enterprise Server 不支持远程服务器托管，请前往本地服务器配置章节，参考 GitHub Enterprise Server 与支持数据驻留的 Enterprise Cloud（ghe.com） 相关说明。

---

本地 GitHub MCP Server

前置条件

1. 如需在容器中运行服务器，你需要提前安装 https://www.docker.com/。
2. Docker 安装完成后，请确保 Docker 处于运行状态。本服务的 Docker 镜像地址为 ghcr.io/github/github-mcp-server，该镜像为公开镜像；如果拉取镜像时报错，大概率是本地令牌已过期，执行 docker logout ghcr.io 即可解决。
3. 认证配置说明：在 github.com 站点使用时，你无需提前创建任何凭证 — 上方提供的一键安装按钮会在首次使用时通过 OAuth 流程完成登录（该流程基于浏览器，获得的令牌仅保存在内存中）。Docker 相关安装按钮会固定发布回调端口 127.0.0.1:8085，确保容器内的登录回调可以正常访问。如需了解该流程的运行原理、无界面/设备码 fallback 方案，以及自行提供 OAuth 或 GitHub App 凭证的操作（该操作是 GitHub Enterprise Server 和 ghe.com 环境的必填项），请参阅本地服务器 OAuth 登录说明。

如果你更偏好使用令牌，仍可通过设置环境变量 GITHUB_PERSONAL_ACCESS_TOKEN 搭配 https://github.com/settings/personal-access-tokens/new 完成认证，该环境变量的优先级高于 OAuth。由于该 MCP 服务器会调用大量 GitHub API，请仅为你的 AI 工具授予你认为安全的权限范围（如需了解访问令牌的更多信息，请参考https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens）。

---

安全管理 Personal Access Token

环境变量（推荐方案）

为保障你的 GitHub PAT 安全，同时使其可在不同 MCP 主机间复用，请遵循以下步骤：

1. 将 PAT 存入环境变量

export GITHUB_PAT=your_token_here

也可以创建 .env 文件存储令牌：

GITHUB_PAT=your_token_here

2. 保护你的 .env 文件

# 将 .env 加入 .gitignore 以避免被意外提交到版本库
    echo ".env"
>> .gitignore

3. 在配置中引用令牌

# 命令行使用示例
    claude mcp add github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT -- docker run -i --rm -e GITHUB_PERSONAL_ACCESS_TOKEN ghcr.io/github/github-mcp-server

在支持该语法的配置文件中：

"env": {
      "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
    }

[!NOTE] 环境变量的支持情况因宿主应用和 IDE 而异，部分应用（例如 Windsurf）要求将令牌硬编码写入配置文件。

---

令牌安全最佳实践

• 遵循最小权限原则：仅授予必要的权限范围
  • repo：仓库操作权限
  • read:packages：Docker 镜像访问权限
  • read:org：组织与团队信息访问权限
• 令牌隔离：为不同项目、不同环境创建独立的 PAT
• 定期轮换：周期性更新令牌，避免长期使用同一令牌
• 禁止提交令牌：绝对不要将令牌存入任何版本控制系统
• 收紧文件权限：限制持有令牌的配置文件的访问范围

chmod 600 ~/.your-app/config.json

---

适配 GitHub Enterprise Server 与带数据驻留功能的 GitHub Enterprise Cloud（ghe.com）

你可以通过 --gh-host 标志或 GITHUB_HOST 环境变量，为 GitHub Enterprise Server 或带数据驻留功能的 GitHub Enterprise Cloud 指定访问主机名：

• 对于 GitHub Enterprise Server，主机名需要以 https:// URI 方案作为前缀。系统强制要求使用 HTTPS：所有非 HTTPS 主机都会被拒绝，以避免凭证在明文链路中传输（唯一例外是本地开发场景下的回环主机，例如 http://localhost）。
• 对于带数据驻留功能的 GitHub Enterprise Cloud，请使用 https://你的子域名.ghe.com 作为主机名。

"github": {
  "command": "docker",
  "args": [
    "run",
    "-i",
    "--rm",
    "-e",
    "GITHUB_PERSONAL_ACCESS_TOKEN",
    "-e",
    "GITHUB_HOST",
    "ghcr.io/github/github-mcp-server"
  ],
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
    "GITHUB_HOST": "https:// 你的子域名.ghe.com"
  }
}

---

安装部署

在 VS Code 的 GitHub Copilot 中安装

你可以使用页面上方的一键安装按钮快速完成安装。完成流程后，打开 Copilot 聊天输入框旁的 Agent 模式，MCP 服务器就会自动启动。

如需了解 VS Code Agent 模式下 MCP 服务器工具的更多使用方式，请参考 https://code.visualstudio.com/docs/copilot/chat/mcp-servers。

---

在其他 IDE（JetBrains、Visual Studio、Eclipse 等）的 GitHub Copilot 中安装

将以下 JSON 配置块添加到对应 IDE 的 MCP 设置中即可完成配置。

使用 OAuth 登录（无需创建或存储令牌）： 对于 github.com 场景，官方镜像已内置应用凭证，你无需自行提供任何密钥：首次使用时会唤起浏览器完成登录，生成的令牌仅保存在内存中。在 Docker 环境下，你需要将固定的回调端口发布到回环地址，才能让容器内的登录回调被正常访问：

{
  "mcp": {
    "servers": {
      "github": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-p",
          "127.0.0.1:8085:8085",
          "-e",
          "GITHUB_OAUTH_CALLBACK_PORT",
          "ghcr.io/github/github-mcp-server"
        ],
        "env": {
          "GITHUB_OAUTH_CALLBACK_PORT": "8085"
        }
      }
    }
  }
}

如需了解无需固定端口的原生二进制运行流程、无头/设备码降级方案、GitHub Enterprise Server / ghe.com 适配，以及自定义 OAuth 或 GitHub App 的相关内容，请查阅 本地服务器 OAuth 登录。

对于非交互式 stdio 部署场景，请参考 GitHub App 认证。

或者使用 Personal Access Token 完成认证： 改用设置 GITHUB_PERSONAL_ACCESS_TOKEN 环境变量即可，它的优先级会高于 OAuth 配置：

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "github_token",
        "description": "GitHub Personal Access Token",
        "password": true
      }
    ],
    "servers": {
      "github": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "GITHUB_PERSONAL_ACCESS_TOKEN",
          "ghcr.io/github/github-mcp-server"
        ],
        "env": {
          "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
        }
      }
    }
  }
}

你还可以将类似配置（无需外层的 mcp 键）写入工作区下的 .vscode/mcp.json 文件，该配置可以被其他支持相同格式的宿主应用共享使用。

以下是不包含外层 MCP 键的示例 JSON 配置：

{
  "inputs": [
    {
      "type": "promptString",
      "id": "github_token",
      "description": "GitHub Personal Access Token",
      "password": true
    }
  ],
  "servers": {
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "ghcr.io/github/github-mcp-server"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
      }
    }
  }
}

---

在其他 MCP 宿主中安装

对于其他 MCP 宿主应用，请参考对应的专属安装指南：

• Copilot CLI：GitHub Copilot CLI 安装指南
• 其他 IDE 的 GitHub Copilot：JetBrains、Visual Studio、Eclipse、Xcode 平台的 GitHub Copilot 安装说明
• Claude Code & Claude Desktop：Claude Code 和 Claude Desktop 安装指南
• Cursor：Cursor IDE 安装指南
• Google Gemini CLI：Google Gemini CLI 安装指南
• OpenCode：OpenCode 终端代理安装指南
• Windsurf：Windsurf IDE 安装指南
• Zed：Zed 编辑器安装指南

如需了解所有安装选项的完整概览，请查阅 安装指南索引。

[!NOTE] 任何支持本地 MCP 服务器的宿主应用程序都应当能够访问本地 GitHub MCP 服务器。但不同宿主应用的集成配置流程、语法和稳定性会存在差异。尽管很多宿主应用可能采用与上文示例类似的格式，但无法对此作出保证。请查阅你所使用的宿主应用的官方文档，获取正确的 MCP 配置语法与搭建流程。

从源码构建

如果你的环境中没有 Docker，可使用 go build 在 cmd/github-mcp-server 目录下构建二进制文件，后续运行时执行 github-mcp-server stdio 命令，并将 GITHUB_PERSONAL_ACCESS_TOKEN 环境变量设置为你的个人访问令牌。若需指定构建产物的输出位置，可使用 -o 标志。你需要将宿主服务器配置为直接调用构建得到的可执行文件作为其 command 启动项。

STDIO API 请求会将自身标识为 github-mcp-server/ ，并在可用时将上游 MCP 客户端的名称和版本放在括号内保留。客户端元数据中的控制字符、引号、反斜杠和括号会被转义，以确保对应的 HTTP 头部合法；常规名称、版本号、空格和可打印 Unicode 字符则会直接保留。正式发布版本的构建产物会保留对应的发布版本号。未指定版本的源码构建产物、以及默认 Docker 构建产物在包含版本控制元数据时会使用 vcs- 前缀标识。Docker 发布工作流会保留标签版本（包括预发布版本），同时允许分支构建、拉取请求构建和每日构建使用其关联的源码修订版本。-dirty 标记仅会在修订版本和修改状态都来自内嵌 VCS 元数据时附加，绝不会作用于合法的、显式传入的 main.commit 参数值。该标识属于 VCS 构建标识符，并非正式发布版本号。

在 Git 检出目录中执行 go build -o github-mcp-server ./cmd/github-mcp-server 即可完成完整包的构建，并自动内嵌对应的 VCS 修订版本。对于没有 VCS 元数据的构建场景，你可以通过 -ldflags '-X main.version= ' 参数传入实际的发布版本号，或通过 -ldflags '-X main.commit= ' 参数传入完整的源码修订版本号。系统会按照以下优先级顺序选取有效元数据：显式传入的发布版本号、显式传入的源码修订版本、内嵌 VCS 修订版本、最后是已安装主模块的版本号。显式传入的合法修订版本始终具有最高优先级，即便构建上下文过滤操作修改了内嵌 VCS 元数据也不受影响。如果当前候选元数据无效或格式错误，系统会自动降级尝试下一个可用来源。如果所有来源都无法获取有效元数据，STDIO 模式仍会正常启动，使用开发版本标签 dev，并在标准错误流输出一条警告，同时保证标准输出流完全可供 MCP 协议使用。当需要按版本进行溯源时，请务必传入真实的发布版本号或修订版本元数据。

配置示例如下：

{
  "mcp": {
    "servers": {
      "github": {
        "command": "/path/to/github-mcp-server",
        "args": ["stdio"],
        "env": {
          "GITHUB_PERSONAL_ACCESS_TOKEN": " "
        }
      }
    }
  }
}

工具配置

GitHub MCP 服务器支持通过 --toolsets 标志启用或禁用特定功能分组，你可以借此控制向 AI 工具开放的 GitHub API 能力范围。仅启用你实际需要的工具集能够帮助大模型更好地做出工具调用选择，同时缩减上下文占用的空间。

工具集的覆盖范围并不限于工具本身：相关联的 MCP 资源和提示词在适用场景下也会随对应工具集一同启用。

如果未指定任何工具集，服务器将使用默认工具集。

想查看更多示例？你可以查阅服务器配置指南，获取最小部署配置、只读模式、工具与工具集组合使用等常见场景的配置方案。

指定工具集

如需指定希望向大模型开放的工具集，可通过以下两种方式传入白名单：

1. 通过命令行参数配置：

github-mcp-server --toolsets repos,issues,pull_requests,actions,code_security

2. 通过环境变量配置：

GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-server

如果同时传入了环境变量 GITHUB_TOOLSETS 和命令行参数，环境变量的优先级更高。

指定独立工具

你还可以通过 --tools 标志直接配置特定的单个工具。该参数既可以独立使用，也可以与工具集组合，实现更细粒度的能力管控。

1. 通过命令行参数配置：

github-mcp-server --tools get_file_contents,issue_read,create_pull_request

2. 通过环境变量配置：

GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" ./github-mcp-server

3. 与工具集组合使用（叠加生效）：

github-mcp-server --toolsets repos,issues --tools get_gist

上述配置会注册 repos 和 issues 两个工具集下的所有工具，同时额外注册 get_gist 工具。

[!IMPORTANT]

• 工具和工具集支持同时使用
• 只读模式优先级最高：如果设置了 --read-only 参数，所有写入类工具都会被跳过，即便你通过 --tools 显式指定了这些工具也不会生效
• 工具名称必须完全匹配（例如需使用 get_file_contents，而非 getFileContents）。无效的工具名称会导致服务器启动失败并输出错误信息
• 当工具被重命名时，旧名称会作为别名保留以保证向后兼容性，详情请参考工具重命名说明

在 Docker 中使用工具集

使用 Docker 部署时，你可以通过环境变量传入工具集配置：

docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN= \
-e GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" \
ghcr.io/github/github-mcp-server

在 Docker 中使用独立工具

使用 Docker 部署时，你也可以通过环境变量传入指定的独立工具，同时支持将工具与工具集组合使用：

# 仅使用独立工具
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN= \
-e GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" \
ghcr.io/github/github-mcp-server

# 独立工具与工具集组合（叠加生效）
docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN= \
-e GITHUB_TOOLSETS="repos,issues" \
-e GITHUB_TOOLS="get_gist" \
ghcr.io/github/github-mcp-server

特殊工具集

"all" 工具集

传入特殊工具集 all 即可启用所有可用工具集，该配置会覆盖其他所有相关配置项：

./github-mcp-server --toolsets all

也可以通过环境变量配置：

GITHUB_TOOLSETS="all" ./github-mcp-server

"default" 工具集

如果你没有指定任何工具集，服务器将自动使用内置的 default 默认工具集作为配置。

默认配置包含以下工具集：

• context
• repos
• issues
• pull_requests
• users

如需保留默认配置的同时额外启用其他工具集，可按如下方式配置：

GITHUB_TOOLSETS="default,stargazers" ./github-mcp-server

预览体验模式

本地 GitHub MCP 服务器提供了预览体验版本，可提前访问新功能和实验性工具。

1. 通过命令行参数启用：

./github-mcp-server --insiders

2. 通过环境变量启用：

GITHUB_INSIDERS=true ./github-mcp-server

使用 Docker 部署时启用该模式：

docker run -i --rm \
-e GITHUB_PERSONAL_ACCESS_TOKEN= \
-e GITHUB_INSIDERS=true \
ghcr.io/github/github-mcp-server

可用工具集

以下是可用的工具集：

远程 GitHub MCP Server 中的额外工具集

工具

当协商的 MCP 协议版本为受支持的 2026-07-28 或更高版本时，仓库工具会暴露输出 schema 与类型化的 structuredContent。旧版客户端、协议版本未知的客户端，以及未指定版本的客户端，将收到不含输出 schema 或结构化输出的原有内容。不会仅因为版本号排序晚于 2026-07-28 就将未知版本视为受支持版本。

对于 get_file_contents，目录结果（包括字段投影）为结构化数组。文件下载与仅元数据响应会使用 content 数组，其元素为类型化文本、嵌入式资源或资源链接块，可保留状态消息、文本、base64 二进制内容、空文件和下载链接。标星、删除这类仅涉及文本操作的仓库变更也会返回结构化 message；分叉操作的响应会区分仓库引用与进行中提示消息。仓库删除仍需遵循原有确认流程，之后才会返回完成结果。

结构化仓库结果使用精简 DTO 而非原始 REST 对象。发布信息查询与发布列表共享同一精简发布结构；Git 引用会保留 ref、对象类型和 SHA；带注释的标签会保留标签、消息、标记人、目标信息；删除提交会保留 SHA、消息、作者、树 SHA、父提交 SHA，以及可用的面向用户 html_url。目录条目会保留文件元数据和实用的 HTML/下载链接，但会省略 API 与超媒体路由 URL，即便在投影中请求了这些字段也是如此。旧版与未知协议版本会逐字节保留原始文本；现代的纯文本 JSON 响应会将同一精简 DTO 序列化为 structuredContent。非文本资源块与工具错误会保留原有内容行为。结构化投影使用与旧版格式化器相同的经过清理和过滤的源数据。

对于 get_repository_tree、list_gists、get_gist、create_gist 和 update_gist，Gist 结果会保留文件名、内容、大小、语言/类型信息、时间戳、可见性与精简所有者资料，同时省略 API/节点和 Git 传输 URL。树条目会省略可推导的 API URL。创建/更新 Gist 的结果包含 Gist ID 和 HTML URL。现代 JSON 文本与结构化内容会序列化同一精简结果。旧版或未知协议版本会逐字节保留旧版文本，不含输出 schema 或结构化内容。

在协商使用受支持协议版本 2026-07-28 或更高版本时，议题元数据（list_issue_types、list_issue_fields）、评论（add_issue_comment、update_issue_comment）、依赖项（issue_dependency_read、issue_dependency_write）和重复项检测（find_duplicate）工具会提供类型化的 outputSchema 和 structuredContent。旧版或未知协议版本会保留原有文本响应，不包含这些字段。工具错误不会返回结构化内容。依赖项与重复项检测工具仍受现有功能开关管控。

对于协商使用受支持协议版本 2026-07-28 或更高版本的场景，整合后的 Actions 工具（actions_list、actions_get、actions_run_trigger）会返回带有 method 判别式和对应方法专属类型化字段的结构化对象；JSON 文本包含同一精简投影。工作流、作业与工件投影会省略 API/超媒体 URL，同时保留浏览器链接及实用标识符、状态、时间戳与使用时长信息。运行使用情况列表会按确定的名称顺序列出计费运行环境。旧版与未知协议的文本响应保持不变；get_job_logs 会保留其类型化内容、URL 或失败作业集合的多种返回形式。

Actions

• actions_get - 获取 GitHub Actions 资源（工作流、工作流运行、作业与工件）的详情

• OAuth 质询作用域：repo

• method：要执行的方法（字符串，必填）

• owner：仓库所有者（字符串，必填）

• repo：仓库名称（字符串，必填）

• resource_id：资源的唯一标识符。该值随所用的 method 变化，请确保提供正确的 ID：

  • get_workflow 方法请提供工作流 ID 或工作流文件名（例如 ci.yaml）
  • get_workflow_run、get_workflow_run_usage 和 get_workflow_run_logs_url 方法请提供工作流运行 ID
  • download_workflow_run_artifact 方法请提供工件 ID
  • get_workflow_job 方法请提供作业 ID （字符串，必填）

• actions_list - 列出仓库中的 GitHub Actions 工作流

  • OAuth 质询作用域: repo
  • method: 要执行的操作（字符串，必填）
  • owner: 仓库所有者（字符串，必填）
  • page: 分页页码（默认值：1）（数值，可选）
  • perPage: 单页分页结果数（默认值：30，最大值：100）（数值，可选）
  • repo: 仓库名称（字符串，必填）
  • resource_id: 资源的唯一标识符。该值随传入的 method 动态变化，请确保传入正确的 ID：
    • 调用 list_workflows 方法时请勿传入任何资源 ID
    • 调用 list_workflow_runs 方法时可传入工作流 ID 或工作流文件名（例如 ci.yaml），留空将列出该仓库下所有工作流运行记录
    • 调用 list_workflow_jobs 和 list_workflow_run_artifacts 方法时必须传入工作流运行 ID （字符串，可选）
  • workflow_jobs_filter: 工作流作业过滤器，仅在 method 为 list_workflow_jobs 时生效（对象，可选）
  • workflow_runs_filter: 工作流运行记录过滤器，仅在 method 为 list_workflow_runs 时生效（对象，可选）

• actions_run_trigger - 触发 GitHub Actions 工作流操作

  • OAuth 质询作用域: repo
  • inputs: 工作流可接收的输入参数，仅在 run_workflow 方法中使用（对象，可选）
  • method: 要执行的方法（字符串，必填）
  • owner: 仓库所有者（字符串，必填）
  • ref: 工作流对应的 Git 引用，可以是分支名或标签名，run_workflow 方法必填该参数（字符串，可选）
  • repo: 仓库名称（字符串，必填）
  • run_id: 工作流运行记录的 ID，除 run_workflow 之外的所有方法必填该参数（数值，可选）
  • workflow_id: 工作流 ID（数值型）或工作流文件名（例如 main.yml、ci.yaml），run_workflow 方法必填该参数（字符串，可选）

• get_job_logs - 获取 GitHub Actions 工作流作业日志

  • OAuth 质询作用域: repo
  • failed_only: 设为 true 时，将获取 run_id 指定的工作流运行记录中所有失败作业的日志，此时必须传入 run_id（布尔值，可选）
  • job_id: 工作流作业的唯一标识符，获取单个作业日志时必填该参数（数值，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • return_content: 返回实际日志内容而非日志下载 URL（布尔值，可选）
  • run_id: 工作流运行记录的唯一标识符，当 failed_only 设为 true 以获取该运行记录下所有失败作业日志时必填该参数（数值，可选）
  • tail_lines: 从日志末尾返回的行数（数值，可选）

代码质量

• get_code_quality_finding - 获取代码质量检测结果
  • OAuth 质询作用域: repo
  • findingNumber: 检测结果的编号（数值，必填）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

代码安全

• get_code_scanning_alert - 获取代码扫描告警

  • OAuth 质询作用域: security_events
  • alertNumber: 告警的编号（数值，必填）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• list_code_scanning_alerts - 列出代码扫描告警

  • OAuth 质询作用域: security_events
  • owner: 仓库所有者（字符串，必填）
  • page: 分页页码（最小值为 1）（数值，可选）
  • perPage: 单页分页结果数（最小值为 1，最大值为 100）（数值，可选）
  • ref: 你希望列出结果对应的 Git 引用（字符串，可选）
  • repo: 仓库名称（字符串，必填）
  • severity: 按严重程度过滤代码扫描告警（字符串，可选）
  • state: 按状态过滤代码扫描告警，默认值为 open（字符串，可选）
  • tool_name: 用于代码扫描的工具名称（字符串，可选）

上下文

• get_me - 获取当前用户的个人资料

  • MCP App UI: ui://github-mcp-server/get-me 无需传入任何参数

• get_team_members - 获取团队成员列表

  • OAuth 质询作用域: read:org
  • org: 包含目标团队的组织登录名（所有者）（字符串，必填）
  • team_slug: 团队的识别别名（字符串，必填）

• get_teams - 获取团队列表

  • OAuth 质询作用域: read:org
  • user: 待获取所属团队的用户名，未传入时默认使用当前已认证用户（字符串，可选）

• ui_get - 获取 UI 数据

  • OAuth 质询作用域: repo, read:org
  • method: 待获取数据的类型（字符串，必填）
  • owner: 仓库所有者，所有方法均必填该参数（字符串，必填）
  • repo: 仓库名称，获取标签、负责人、里程碑、分支、Issue 字段、评审人数据时必填该参数（字符串，可选）

Copilot

• assign_copilot_to_issue - 将 Copilot 分配给指定 Issue

  • OAuth 质询作用域: repo
  • base_ref: 代理启动工作的起始 Git 引用（例如分支），未指定时默认使用仓库的默认分支（字符串，可选）
  • custom_instructions: 可选的自定义指令，用于为代理提供 Issue 正文之外的额外引导，可补充 Issue 描述中未覆盖的上下文、约束或指导规则（字符串，可选）
  • issue_number: Issue 编号（数值，必填）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• request_copilot_review - 请求 Copilot 进行评审

  • OAuth 质询作用域: repo
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: Pull Request 编号（数值，必填）
  • repo: 仓库名称（字符串，必填）

Copilot Issue 意图

• assign_copilot_to_issue_with_intent - 基于指定意图将 Copilot 分配给 Issue
  • OAuth 质询作用域: repo
  • base_ref: 代理启动工作的起始 Git 引用（例如分支），未指定时默认使用仓库的默认分支；当 is_suggestion 为 true 时该参数将被忽略（字符串，可选）
  • confidence: 你对本次选择的置信度，可取值说明：HIGH 代表明确信号或用户明确请求，MEDIUM 代表存在一定模糊性的合理推断，LOW 代表基于有限信息的最佳推测（字符串，必填）
  • custom_instructions: 可选的自定义指令，用于为代理提供 Issue 正文之外的额外引导；当 is_suggestion 为 true 时该参数将被忽略（字符串，可选）
  • is_suggestion: 设为 true 时，仅记录待确认的 Copilot 分配意图，不会直接启动代理；后续审批通过后再补充启动上下文，此时 base_ref 和 custom_instructions 都会被忽略（布尔值，必填）
  • issue_number: Issue 编号（数值，必填）
  • owner: 仓库所有者（字符串，必填）
  • rationale: 用一句简明的语句说明该 Issue 中促使你选择 Copilot 的具体依据，请给出明确的可验证信号，例如「范围明确且包含清晰验收标准的任务」（字符串，必填）
  • repo: 仓库名称（字符串，必填）

Dependabot

• get_dependabot_alert - 获取 Dependabot 警报

• OAuth 挑战作用域: security_events

• alertNumber: 警报编号。（数字，必填）

• owner: 仓库所有者。（字符串，必填）

• repo: 仓库名称。（字符串，必填）

• list_dependabot_alerts - 列出 Dependabot 警报

• OAuth 挑战作用域: security_events

• after: 分页游标。使用上一次响应返回的游标。（字符串，可选）

• owner: 仓库所有者。（字符串，必填）

• perPage: 分页单页返回结果数（最小值 1，最大值 100）（数字，可选）

• repo: 仓库名称。（字符串，必填）

• severity: 按严重程度筛选 Dependabot 警报（字符串，可选）

• state: 按状态筛选 Dependabot 警报。默认值为 open（字符串，可选）

Discussions（讨论区）

• discussion_comment_write - 管理讨论区评论

• OAuth 挑战作用域: repo

• body: 评论内容（add、reply 和 update 方法必填）（字符串，可选）

• commentNodeID: 讨论区评论的 Node ID（reply、update、delete、mark_answer 和 unmark_answer 方法必填）。用于 reply 时，该值为要回复的顶层评论；GitHub Discussions 仅支持一级嵌套。（字符串，可选）

• discussionNumber: 讨论编号（add 和 reply 方法必填）（数字，可选）

• method: 针对讨论区评论执行的写入操作，可选值为：

  • add - 为讨论添加一条新的顶层评论
  • reply - 回复讨论区的一条顶层评论（GitHub Discussions 仅支持一级嵌套）
  • update - 更新一条已有的讨论区评论
  • delete - 删除一条讨论区评论
  • mark_answer - 将讨论区评论标记为答案（仅适用于问答类讨论）
  • unmark_answer - 取消将讨论区评论标记为答案（仅适用于问答类讨论） （字符串，必填）

• owner: 仓库所有者（add 和 reply 方法必填）（字符串，可选）

• repo: 仓库名称（add 和 reply 方法必填）（字符串，可选）

• get_discussion - 获取讨论详情

• OAuth 挑战作用域: repo

• discussionNumber: 讨论编号（数字，必填）

• owner: 仓库所有者（字符串，必填）

• repo: 仓库名称（字符串，必填）

• get_discussion_comments - 获取讨论评论

• OAuth 挑战作用域: repo

• after: 分页游标。使用上一次响应返回的游标。（字符串，可选）

• discussionNumber: 讨论编号（数字，必填）

• includeReplies: 设为 true 时，每条顶层评论将嵌套包含其下的回复（单条评论最多返回 100 条回复，该值为 GitHub API 的上限）。默认值为 false。（布尔值，可选）

• owner: 仓库所有者（字符串，必填）

• perPage: 分页单页返回结果数（最小值 1，最大值 100）（数字，可选）

• repo: 仓库名称（字符串，必填）

• list_discussion_categories - 列出讨论分类

• OAuth 挑战作用域: repo

• owner: 仓库所有者（字符串，必填）

• repo: 仓库名称。如果不提供，将在组织级别查询讨论分类。（字符串，可选）

• list_discussions - 列出讨论

• OAuth 挑战作用域: repo

• after: 分页游标。使用上一次响应返回的游标。（字符串，可选）

• category: 可选筛选条件，按讨论分类 ID 过滤。提供该参数后，仅会列出属于该分类的讨论。（字符串，可选）

• direction: 排序方向。（字符串，可选）

• orderBy: 按指定字段对讨论排序。提供该参数时，还必须提供 direction 参数。（字符串，可选）

• owner: 仓库所有者（字符串，必填）

• perPage: 分页单页返回结果数（最小值 1，最大值 100）（数字，可选）

• repo: 仓库名称。如果不提供，将在组织级别查询讨论。（字符串，可选）

Gists（代码片段）

• create_gist - 创建 Gist

• OAuth 挑战作用域: gist

• content: 用于创建简单单文件 Gist 的内容（字符串，必填）

• description: Gist 描述（字符串，可选）

• filename: 用于创建简单单文件 Gist 的文件名（字符串，必填）

• public: Gist 是否公开（布尔值，可选）

• get_gist - 获取 Gist 内容

• gist_id: Gist 的 ID（字符串，必填）

• list_gists - 列出 Gist

• page: 分页页码（最小值 1）（数字，可选）

• perPage: 分页单页返回结果数（最小值 1，最大值 100）（数字，可选）

• since: 仅返回在此时间之后更新的 Gist（ISO 8601 时间戳）（字符串，可选）

• username: GitHub 用户名（省略则返回当前已认证用户的 Gist）（字符串，可选）

• update_gist - 更新 Gist

• OAuth 挑战作用域: gist

• content: 文件内容（字符串，必填）

• description: 更新后的 Gist 描述（字符串，可选）

• filename: 要更新或创建的文件名（字符串，必填）

• gist_id: 要更新的 Gist 的 ID（字符串，必填）

Git

• get_repository_tree - 获取仓库目录树
• OAuth 挑战作用域: repo
• owner: 仓库所有者（用户名或组织名）（字符串，必填）
• path_filter: 可选路径前缀，用于过滤目录树结果（例如使用 src/ 仅显示 src 目录下的文件）（字符串，可选）
• recursive: 将该参数设为 true 可返回该目录树引用的所有对象或子目录树。默认值为 false（布尔值，可选）
• repo: 仓库名称（字符串，必填）
• tree_sha: 目录树的 SHA1 值或引用（分支或标签）名称。默认值为仓库的默认分支（字符串，可选）

Governance（治理）