ghcr.io/github/github-mcp-server:skill-discovery-v3

GitHub MCP Server

GitHub MCP Server 将AI工具直接连接到GitHub平台。这使AI代理、助手和聊天机器人能够读取仓库和代码文件、管理issues和PRs、分析代码并自动化工作流。所有这些都通过自然语言交互实现。

使用场景

• 仓库管理：浏览和查询代码、搜索文件、分析提交，并了解您有权访问的任何仓库的项目结构。
• Issue与PR自动化：创建、更新和管理issues及拉取请求。让AI帮助分类错误、审查代码变更并维护项目看板。
• 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%E6%88%96https://code.visualstudio.com/updates%E4%BB%A5%E6%94%AF%E6%8C%81%E8%BF%9C%E7%A8%8BMCP%E5%92%8COAuth%E3%80%82

或者，要手动配置VS Code，请从以下示例中选择合适的JSON块并添加到您的主机配置中：

使用OAuth | 使用GitHub PAT
VS Code（1.101或更高版本）

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

{
"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的全面说明和示例。

未指定工具集时，将使用默认工具集。

预览版模式

[!NOTE] 抢先体验新功能！远程服务器提供预览版，可提前使用新功能和实验性工具。

使用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也可以使用远程服务器。

https://octocorp.ghe.com使用GitHub PAT令牌的示例：

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

[!NOTE] 使用VS Code和GitHub Copilot通过OAuth连接GitHub Enterprise时，还需要将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/%E3%80%82
2. 安装Docker后，还需要确保Docker正在运行。Docker镜像位于ghcr.io/github/github-mcp-server。该镜像是公开的；如果拉取时出现错误，可能是令牌已过期，需要执行docker logout ghcr.io。
3. 身份验证。在github.com上，您无需预先创建任何内容——上方的一键按钮会在首次使用时通过OAuth登录（基于浏览器的流程；令牌仅保存在内存中）。Docker按钮会发布固定的回调端口（127.0.0.1:8085），以便容器的登录回调可访问。有关其工作原理、无头/设备代码回退以及使用您自己的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%EF%BC%89%E3%80%82

安全处理个人访问令牌 (PAT)

环境变量（推荐）

为确保您的 GitHub PAT 安全且可在不同 MCP 主机间复用：

1. 将 PAT 存储在环境变量中

export GITHUB_PAT=your_token_here

或创建 .env 文件：

GITHUB_PAT=your_token_here

2. 保护您的 .env 文件

# 添加到 .gitignore 以防止意外提交
echo ".env"
>> .gitignore

3. 在配置中引用令牌

# CLI 使用方式
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 和具有数据驻留功能的 Enterprise Cloud (ghe.com)

标志 --gh-host 和环境变量 GITHUB_HOST 可用于为 GitHub Enterprise Server 或具有数据驻留功能的 GitHub Enterprise Cloud 设置主机名。

• 对于 GitHub Enterprise Server，请在主机名前添加 https:// URI 方案前缀，否则默认使用 http://，而 GitHub Enterprise Server 不支持该方案。
• 对于具有数据驻留功能的 GitHub Enterprise Cloud，请使用 https://YOURSUBDOMAIN.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:// "
}
}

安装

在 VS Code 中的 GitHub Copilot 中安装

如需快速安装，请使用上方的一键安装按钮之一。完成该流程后，切换代理模式（位于 Copilot 聊天文本输入框旁），服务器将启动。

有关在 VS Code 中使用 MCP 服务器工具的更多信息，请参阅 https://code.visualstudio.com/docs/copilot/chat/mcp-servers%E3%80%82

在其他 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 应用的信息，请参阅 本地服务器 OAuth 登录。

或使用个人访问令牌进行身份验证。 改为设置 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 安装指南
• GitHub Copilot in other IDEs - 适用于 JetBrains、Visual Studio、Eclipse 和 Xcode 的 GitHub Copilot 安装指南
• Claude Code & Claude Desktop - Claude Code 和 Claude Desktop 安装指南
• Cursor - Cursor IDE 安装指南
• Google *** CLI - Google *** CLI 安装指南
• OpenCode - OpenCode 终端代理安装指南
• Windsurf - Windsurf IDE 安装指南
• Zed - Zed 编辑器安装指南

有关所有安装选项的完整概述，请参阅我们的 安装指南索引。

[!NOTE] 任何支持本地 MCP 服务器的主机应用都应能访问本地 GitHub MCP 服务器。但是，集成的具体配置流程、语法和稳定性会因主机应用而异。虽然许多应用可能遵循与上述示例类似的格式，但这并不能保证。请参阅您的主机应用文档，了解正确的 MCP 配置语法和设置流程。

从源代码构建

工具配置

GitHub MCP Server 支持通过 --toolsets 标志启用或禁用特定功能组。这使您能够控制 AI 工具可使用的 GitHub API 功能。仅启用所需的工具集有助于 LLM 进行工具选择并减少上下文大小。

工具集不仅限于工具。相关的 MCP 资源和提示也会在适用时包含在内。

未指定工具集时，将使用 默认工具集。

寻找示例？ 请参阅 服务器配置指南，了解最小化设置、只读模式以及工具与工具集组合等常见方案。

指定工具集

要指定 LLM 可用的工具集，您可以通过两种方式传递允许列表：

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 Server 提供内测版本，可提前使用新功能和实验性工具。

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 中的其他工具集

工具

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）（数字，可选）

• per_page：每页结果数（默认：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：从日志末尾返回的行数（数字，可选）

Code Quality

• get_code_quality_finding - 获取代码质量问题
• 所需 OAuth 作用域：repo
• findingNumber：问题编号。（数字，必填）
• owner：仓库所有者。（字符串，必填）
• repo：仓库名称。（字符串，必填）

Code Security

• get_code_scanning_alert - 获取代码扫描警报

• 所需 OAuth 作用域：security_events

• 接受的 OAuth 作用域：repo、security_events

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

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

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

• list_code_scanning_alerts - 列出代码扫描警报

• 所需 OAuth 作用域：security_events

• 接受的 OAuth 作用域：repo、security_events

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

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

• perPage：每页结果数（最小值 1，最大值 100）（数字，可选）

• ref：要列出结果的 Git 引用。（字符串，可选）

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

• severity：按严重性筛选代码扫描警报（字符串，可选）

• state：按状态筛选代码扫描警报。默认为 open（字符串，可选）

• tool_name：用于代码扫描的工具名称。（字符串，可选）

Context

• get_me - 获取我的用户资料

• 无参数要求

• get_team_members - 获取团队成员

• 所需 OAuth 作用域：read:org

• 接受的 OAuth 作用域：admin:org、read:org、write:org

• org：包含团队的组织登录名（所有者）。（字符串，必填）

• team_slug：团队标识符（字符串，必填）

• get_teams - 获取团队

• 所需 OAuth 作用域：read:org

• 接受的 OAuth 作用域：admin:org、read:org、write:org

• user：要获取团队的用户名。如果未提供，则使用已认证用户。（字符串，可选）

Copilot

• assign_copilot_to_issue - 将 Copilot 分配给议题

• 所需 OAuth 作用域：repo

• base_ref：代理开始工作的 Git 引用（例如分支）。如果未指定，默认为仓库的默认分支（字符串，可选）

• custom_instructions：可选的自定义指令，用于在议题正文之外指导代理。使用此参数提供未在议题描述中捕获的额外上下文、约束或指导（字符串，可选）

• issue_number：议题编号（数字，必填）

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

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

• request_copilot_review - 请求 Copilot 审核

• 所需 OAuth 作用域：repo

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

• pullNumber：拉取请求编号（数字，必填）

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

Dependabot

• get_dependabot_alert - 获取 Dependabot 警报
• 所需 OAuth 作用域：security_events
• 接受的 OAuth 作用域：repo、security_events
• alertNumber：警报编号。（数字，必填）
• owner：仓库所有者。（字符串，必填）
• repo：仓库名称。（字符串，必填）

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 - 列出 Gists

• 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 值或引用（分支或标签）名称。默认为仓库的默认分支（字符串，可选）

Issues

• add_issue_comment - 向议题或拉取请求添加评论

• 所需 OAuth 作用域：repo

• body：评论内容。除非提供 reaction，否则为必填项。（字符串，可选）

• comment_id：要添加反应的议题或拉取请求评论的数字 ID。用于对评论添加反应；省略则对议题或拉取请求本身添加反应。不能与 body 同时使用。（数字，可选）

• issue_number：要评论或添加反应的议题或拉取请求编号。（数字，必填）

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

• reaction：要添加的表情反应。除非提供 body，否则为必填项。（字符串，可选）

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

• get_label - 从仓库获取特定标签

• 所需 OAuth 作用域：repo

• name：标签名称。（字符串，必填）

• owner：仓库所有者（用户名或组织名称）（字符串，必填）

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

• issue_read - 获取议题详情

• 所需OAuth作用域：repo

• issue_number：议题编号（数字，必填）

• method：对单个议题执行的读取操作。
  选项包括：

  1. get - 获取特定议题的详情。
  2. get_comments - 获取议题评论。
  3. get_sub_issues - 获取议题的子议题（子项）。
  4. get_parent - 如果此议题是另一个议题的子议题，则获取其父议题。
  5. get_labels - 获取分配给议题的标签。
     （字符串，必填）

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

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

• perPage：分页每页结果数（最小值1，最大值100）（数字，可选）

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

• issue_write - 创建或更新议题/拉取请求

• 所需OAuth作用域：repo

• assignees：要分配给此议题的用户名（字符串数组，可选）

• body：议题正文内容（字符串，可选）

• duplicate_of：此议题所重复的议题编号。仅在state_reason为'duplicate'时使用。（数字，可选）

• issue_fields：要设置或清除的议题字段值。每个项需包含'field_name'以及'value'、'field_option_name'或'delete: true'中的恰好一项。（对象数组，可选）

• issue_number：要更新的议题编号（数字，可选）

• labels：要应用于此议题的标签（字符串数组，可选）

• method：对单个议题执行的写入操作。
  选项包括：

  • 'create' - 创建新议题。
  • 'update' - 更新现有议题。
    （字符串，必填）

• milestone：里程碑编号（数字，可选）

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

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

• state：新状态（字符串，可选）

• state_reason：状态变更原因。仅在状态变更时生效。（字符串，可选）

• title：议题标题（字符串，可选）

• type：此议题的类型。仅在仓库启用议题类型时使用。使用list_issue_types工具获取此仓库或其所属组织的有效类型值。如果仓库不支持议题类型，请省略此参数。（字符串，可选）

• list_issue_fields - 列出议题字段

• 所需OAuth作用域（任一）：repo、read:org

• 接受的OAuth作用域：admin:org、read:org、repo、write:org

• owner：仓库或组织的账户所有者。名称不区分大小写。（字符串，必填）

• repo：仓库名称。提供时，返回此特定仓库的字段（继承自其组织）。省略时，直接返回组织级别的字段。（字符串，可选）

• list_issue_types - 列出可用议题类型

• 所需OAuth作用域（任一）：repo、read:org

• 接受的OAuth作用域：admin:org、read:org、repo、write:org

• owner：仓库或组织的账户所有者。（字符串，必填）

• repo：仓库名称。提供时，返回此特定仓库的议题类型。省略时，直接返回组织级别的议题类型。（字符串，可选）

• list_issues - 列出议题

• 所需OAuth作用域：repo

• after：分页游标。使用上一个响应中的游标。（字符串，可选）

• direction：排序方向。如果提供，还需提供'orderBy'。（字符串，可选）

• field_filters：按自定义议题字段值筛选。每个条目包含field_name和value；服务器会查找字段并将值强制转换为其类型（单选选项名称、文本、数字或YYYY-MM-DD日期）。（对象数组，可选）

• labels：按标签筛选（字符串数组，可选）

• orderBy：按字段对议题排序。如果提供，还需提供'direction'。（字符串，可选）

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

• perPage：分页每页结果数（最小值1，最大值100）（数字，可选）

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

• since：按日期筛选（ISO 8601时间戳）（字符串，可选）

• state：按状态筛选，未提供时默认返回开放和已关闭的议题（字符串，可选）

• search_issues - 搜索议题

• 所需OAuth作用域：repo

• order：排序顺序（字符串，可选）

• owner：可选仓库所有者。如果与repo一起提供，仅列出此仓库的议题。（字符串，可选）

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

• perPage：分页每页结果数（最小值1，最大值100）（数字，可选）

• query：使用GitHub议题搜索语法的搜索查询（字符串，必填）

• repo：可选仓库名称。如果与owner一起提供，仅列出此仓库的议题。（字符串，可选）

• sort：按匹配类别数量排序字段，默认为最佳匹配（字符串，可选）

• sub_issue_write - 更改子议题

• 所需OAuth作用域：repo

• after_id：要排在其后的子议题ID（应指定after_id或before_id中的一个）（数字，可选）

• before_id：要排在其前的子议题ID（应指定after_id或before_id中的一个）（数字，可选）

• issue_number：父议题编号（数字，必填）

• method：对单个子议题执行的操作
  选项包括：

  • 'add' - 向GitHub仓库的父议题添加子议题。
  • 'remove' - 从GitHub仓库的父议题中移除子议题。
  • 'reprioritize' - 更改父议题中子议题的顺序。使用'after_id'或'before_id'指定新位置。
    （字符串，必填）

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

• replace_parent：为true时，替换子议题当前的父议题。仅与'add'方法一起使用。（布尔值，可选）

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

• sub_issue_id：要添加的子议题ID。ID与议题编号不同（数字，必填）

标签

• get_label - 从仓库获取特定标签

• 所需OAuth作用域：repo

• name：标签名称。（字符串，必填）

• owner：仓库所有者（用户名或组织名称）（字符串，必填）

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

• label_write - 对仓库标签执行写入操作

• 所需OAuth作用域：repo

• color：标签颜色，为6位十六进制代码，不带'#'前缀（例如'f29513'）。'create'操作必填，'update'操作可选。（字符串，可选）

• description：标签描述文本。'create'和'update'操作可选。（字符串，可选）

• method：要执行的操作：'create'、'update'或'delete'（字符串，必填）

• name：标签名称 - 所有操作都必填（字符串，必填）

• new_name：标签的新名称（仅用于'update'方法重命名）（字符串，可选）

• owner：仓库所有者（用户名或组织名称）（字符串，必填）

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