环境变量（推荐）

为确保您的 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 update github -e GITHUB_PERSONAL_ACCESS_TOKEN=$GITHUB_PAT
   
   # 在配置文件中（若支持）
   "env": {
     "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
   }
   

注意： 环境变量的支持因主机应用和 IDE 而异。某些应用程序（如 Windsurf）要求在配置文件中硬编码令牌。

令牌安全最佳实践

• 最小作用域： 仅授予必要的权限

  • repo —— 仓库操作
  • read:packages —— Docker 镜像访问
  • read:org —— 组织团队访问

• 分开使用令牌： 为不同项目/环境使用不同的 PAT

• 定期轮换： 定期更新令牌

• 绝不提交： 将令牌排除在版本控制之外

• 文件权限： 限制对包含令牌的配置文件的访问权限

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

{
  "inputs": [
    {
      "type": "promptString",
      "id": "github_token",
      "description": "GitHub 个人访问令牌",
      "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}"
      }
    }
  }
}

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: 工作流作业的筛选条件。仅在方法为 'list_workflow_jobs' 时使用（对象，可选）
  • workflow_runs_filter: 工作流运行的筛选条件。仅在方法为 '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: 如果为真，则获取由 run_id 指定的工作流运行中所有失败作业的日志。需要提供 run_id。（布尔值，可选）
  • job_id: 工作流作业的唯一标识符。当要获取单个作业的日志时，此参数为必填项。（数字，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • return_content: 返回实际的日志内容而非 URL。（布尔值，可选）
  • run_id: 工作流运行的唯一标识符。当 failed_only 为真时，此参数为必填项，用于获取该运行中所有失败作业的日志。（数字，可选）
  • tail_lines: 从日志末尾返回的行数（数字，可选）

代码安全

• 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: 仓库的所有者。（字符串，必填）
  • ref: 您想要列出结果的 Git 引用。（字符串，可选）
  • repo: 仓库名称。（字符串，必填）
  • severity: 按严重程度筛选代码扫描告警。（字符串，可选）
  • state: 按状态筛选代码扫描告警。默认为未解决。（字符串，可选）
  • tool_name: 用于代码扫描的工具名称。（字符串，可选）

上下文

• 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: 仓库的名称。（字符串，必填）

• list_dependabot_alerts - 列出 Dependabot 警报

  • 必需的 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo, security_events
  • owner: 仓库的所有者。（字符串，必填）
  • repo: 仓库的名称。（字符串，必填）
  • severity: 按严重程度筛选 Dependabot 警报（字符串，可选）
  • state: 按状态筛选 Dependabot 警报。默认为未解决（字符串，可选）

讨论区

• get_discussion - 获取讨论

  • 必需的 OAuth 范围: repo
  • discussionNumber: 讨论编号（数字，必填）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• get_discussion_comments - 获取讨论评论

  • 必需的 OAuth 范围: repo
  • after: 分页游标。对于 GraphQL API，使用上一页 PageInfo 中的 endCursor。（字符串，可选）
  • discussionNumber: 讨论编号（数字，必填）
  • owner: 仓库所有者（字符串，必填）
  • perPage: 每页返回的结果数，用于分页（最小 1，最大 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）

• list_discussion_categories - 列出讨论类别

  • 必需的 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称。如果未提供，则将在组织级别查询讨论类别。（字符串，可选）

• list_discussions - 列出讨论

  • 必需的 OAuth 范围: repo
  • after: 分页游标。对于 GraphQL API，使用上一页 PageInfo 中的 endCursor。（字符串，可选）
  • 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: 仅显示在此时间之后更新的 Gists（ISO 8601 时间戳）（字符串，可选）
  • username: GitHub 用户名（如果是已认证用户的 Gists，则省略）（字符串，可选）

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

议题

• add_issue_comment - 向议题添加评论

  • 所需 OAuth 范围: repo
  • body: 评论内容（字符串，必填）
  • issue_number: 要评论的议题编号（数字，必填）
  • owner: 仓库所有者（字符串，必填）
  • 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_labels - 获取分配给该议题的标签。 （字符串，必填）
  • owner: 仓库的所有者（字符串，必填）
  • page: 分页的页码（最小为1）（数字，可选）
  • perPage: 每页显示的结果数（最小为1，最大为100）（数字，可选）
  • repo: 仓库名称（字符串，必填）

• issue_write - 创建或更新议题。

  • 所需 OAuth 范围: repo
  • assignees: 要分配给该议题的用户名（字符串数组，可选）
  • body: 议题正文内容（字符串，可选）
  • duplicate_of: 该议题是哪个议题的重复。仅当 state_reason 为 'duplicate' 时使用。（数字，可选）
  • issue_number: 要更新的议题编号（数字，可选）
  • labels: 要应用到该议题的标签（字符串数组，可选）
  • method: 对单个议题执行的写入操作。 选项包括：
    • 'create' - 创建新议题。
    • 'update' - 更新现有议题。 （字符串，必填）
  • milestone: 阶段里程碑编号（数字，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • state: 新状态（字符串，可选）
  • state_reason: 状态变更的原因。除非状态发生改变，否则将被忽略。（字符串，可选）
  • title: 议题标题（字符串，可选）
  • type: 该议题的类型。仅在仓库已配置议题类型时使用。请使用 list_issue_types 工具获取组织的有效类型值。如果仓库不支持议题类型，则省略此参数。（字符串，可选）

• list_issue_types - 列出可用的议题类型

  • 所需 OAuth 范围: read:org
  • 接受的 OAuth 范围: admin:org, read:org, write:org
  • owner: 仓库所属组织的所有者（字符串，必填）

• list_issues - 列出议题

  • 所需 OAuth 范围: repo
  • after: 分页游标。对于 GraphQL API，使用上一页 PageInfo 中的 endCursor。（字符串，可选）
  • direction: 排序方向。如果提供此参数，则也需要提供 'orderBy'。（字符串，可选）
  • 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' - 在 GitHub 仓库中更改父议题内子议题的顺序。使用 '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'）。创建标签时必填，更新标签时可选。（字符串，可选）
  • description: 标签描述文本。创建和更新标签时均可选。（字符串，可选）
  • method: 要执行的操作：'create'、'update' 或 'delete'（字符串，必填）
  • name: 标签名称 - 所有操作均需提供（字符串，必填）
  • new_name: 标签的新名称（仅在使用 'update' 方法重命名时使用）（字符串，可选）
  • owner: 仓库所有者（用户名或组织名称）（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• list_label - 从仓库中列出标签

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（用户名或组织名称）——所有操作均需提供（字符串，必填）
  • repo: 仓库名称——所有操作均需提供（字符串，必填）

通知

• dismiss_notification - 关闭通知

  • 所需 OAuth 范围: notifications
  • state: 通知的新状态（已读/已完成）（字符串，必填）
  • threadID: 通知线程的 ID（字符串，必填）

• get_notification_details - 获取通知详情

  • 所需 OAuth 范围: notifications
  • notificationID: 通知的 ID（字符串，必填）

• list_notifications - 列出通知

  • 所需 OAuth 范围: notifications
  • before: 仅显示在指定时间之前更新的通知（ISO 8601 格式）（字符串，可选）
  • filter: 过滤通知类型，默认为未读。未读通知是指用户尚未查看的通知；参与中的通知则是指用户直接参与其中的通知，例如他们评论或创建的议题或拉取请求。（字符串，可选）
  • owner: 可选的仓库所有者。如果同时提供了仓库名，则只列出该仓库的通知。（字符串，可选）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数量（最小值为 1，最大值为 100）（数字，可选）
  • repo: 可选的仓库名称。如果同时提供了所有者，则只列出该仓库的通知。（字符串，可选）
  • since: 仅显示在指定时间之后更新的通知（ISO 8601 格式）（字符串，可选）

• manage_notification_subscription - 管理通知订阅

  • 所需 OAuth 范围: notifications
  • action: 要执行的操作：忽略、关注或删除通知订阅。（字符串，必填）
  • notificationID: 通知线程的 ID。（字符串，必填）

• manage_repository_notification_subscription - 管理仓库通知订阅

  • 所需 OAuth 范围: notifications
  • action: 要执行的操作：忽略、关注或删除仓库通知订阅。（字符串，必填）
  • owner: 仓库的所有者账户。（字符串，必填）
  • repo: 仓库的名称。（字符串，必填）

• mark_all_notifications_read - 将所有通知标记为已读

  • 所需 OAuth 范围: notifications
  • lastReadAt: 描述上次检查通知的时间点（可选）。默认值为当前时间。（字符串，可选）
  • owner: 可选的仓库所有者。如果同时提供了仓库名，则只将该仓库的通知标记为已读。（字符串，可选）
  • repo: 可选的仓库名称。如果同时提供了所有者，则只将该仓库的通知标记为已读。（字符串，可选）

组织

• search_orgs - 搜索组织
  • 所需 OAuth 范围: read:org
  • 接受的 OAuth 范围: admin:org, read:org, write:org
  • order: 排序方式（字符串，可选）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 分页时每页显示的结果数量（最小值为 1，最大值为 100）（数字，可选）
  • query: 组织搜索查询。示例：“microsoft”、“location:california”、“created:>=2025-01-01”。搜索会自动限定为 type:org 类型。（字符串，必填）
  • sort: 按类别排序字段（字符串，可选）

项目

• projects_get - 获取 GitHub 项目资源的详细信息

  • 所需 OAuth 范围: read:project
  • 接受的 OAuth 范围: project, read:project
  • field_id: 字段的 ID。用于“get_project_field”方法。（数字，可选）
  • fields: 获取项目条目时，在响应中包含的具体字段 ID 列表（例如：[“102589”、“985201”、“169875”]）。如果不提供，则仅包含标题字段。仅适用于“get_project_item”方法。（字符串数组，可选）
  • item_id: 项目的 ID。用于“get_project_item”方法。（数字，可选）
  • method: 要执行的方法（字符串，必填）
  • owner: 所有者（用户或组织登录名）。名称不区分大小写。（字符串，可选）
  • owner_type: 所有者类型（用户或组织）。如果不提供，则会自动检测。（字符串，可选）
  • project_number: 项目的编号。（数字，可选）
  • status_update_id: 项目状态更新的节点 ID。用于“get_project_status_update”方法。（字符串，可选）

• projects_list - 列出 GitHub 项目资源

  • 所需 OAuth 范围: read:project
  • 接受的 OAuth 范围: project, read:project
  • after: 来自上一页 pageInfo.nextCursor 的向前分页光标。（字符串，可选）
  • before: 来自上一页 pageInfo.prevCursor 的向后分页光标（较少见）。（字符串，可选）
  • fields: 列出项目条目时要包含的字段 ID（例如：[“102589”、“985201”]）。重要提示：务必提供此参数才能获取字段值。否则只会返回标题。仅适用于“list_project_items”方法。（字符串数组，可选）
  • method: 要执行的动作（字符串，必填）
  • owner: 所有者（用户或组织登录名）。名称不区分大小写。（字符串，必填）
  • owner_type: 所有者类型（用户或组织）。如果不提供，则会自动尝试两种类型。（字符串，可选）
  • per_page: 每页显示的结果数量（最多 50 个）（数字，可选）
  • project_number: 项目的编号。用于“list_project_fields”、“list_project_items”和“list_project_status_updates”方法。（数字，可选）
  • query: 过滤/查询字符串。对于 list_projects：按标题文本和状态进行过滤（例如：“roadmap is:open”）。对于 list_project_items：使用 GitHub 的项目过滤语法进行高级筛选。（字符串，可选）

• projects_write - 修改 GitHub 项目条目

  • 所需 OAuth 范围: project
  • body: 状态更新的内容（Markdown 格式）。用于 create_project_status_update 方法。（字符串，可选）
  • issue_number: 问题编号（当 item_type 为 issue 时用于 add_project_item 方法）。请提供 issue_number 或 pull_request_number 中的一个。（数字，可选）
  • item_id: 项目条目的 ID。用于 update_project_item 和 delete_project_item 方法时必填。（数字，可选）
  • item_owner: 包含问题或拉取请求的仓库的所有者（用户或组织）。用于 add_project_item 方法时必填。（字符串，可选）
  • item_repo: 包含问题或拉取请求的仓库名称。用于 add_project_item 方法时必填。（字符串，可选）
  • item_type: 条目的类型，可以是 issue 或 pull_request。用于 add_project_item 方法时必填。（字符串，可选）
  • method: 要执行的方法（字符串，必填）
  • owner: 项目的负责人（用户或组织登录名）。名称不区分大小写。（字符串，必填）
  • owner_type: 负责人类型（user 或 org）。如果未提供，则会自动检测。（字符串，可选）
  • project_number: 项目的编号。（数字，必填）
  • pull_request_number: 拉取请求编号（当 item_type 为 pull_request 时用于 add_project_item 方法）。请提供 issue_number 或 pull_request_number 中的一个。（数字，可选）
  • start_date: 状态更新的开始日期，格式为 YYYY-MM-DD。用于 create_project_status_update 方法。（字符串，可选）
  • status: 项目的状态。用于 create_project_status_update 方法。（字符串，可选）
  • target_date: 状态更新的目标日期，格式为 YYYY-MM-DD。用于 create_project_status_update 方法。（字符串，可选）
  • updated_field: 一个对象，包含要更新的项目字段的 ID 和该字段的新值。若要清空字段，将值设为 null。例如：{"id": 123456, "value": "新值"}。用于 update_project_item 方法时必填。（对象，可选）

拉取请求

• add_comment_to_pending_review - 向请求者的最新待处理拉取请求评审添加评论

  • 所需 OAuth 范围: repo
  • body: 评审评论的文字内容（字符串，必填）
  • line: 评论所针对的拉取请求差异中 blob 的行号。对于多行评论，指范围的最后一行。（数字，可选）
  • owner: 仓库所有者（字符串，必填）
  • path: 需要添加评论的文件的相对路径（字符串，必填）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）
  • side: 评论所在的差异侧。LEFT 表示旧版本，RIGHT 表示新版本（字符串，可选）
  • startLine: 对于多行评论，指评论所覆盖范围的第一行。（数字，可选）
  • startSide: 对于多行评论，指评论所覆盖差异范围的起始侧。LEFT 表示旧版本，RIGHT 表示新版本（字符串，可选）
  • subjectType: 评论所针对的层级（字符串，必填）

• add_reply_to_pull_request_comment - 回复拉取请求评论

  • 所需 OAuth 范围: repo
  • body: 回复的文字内容（字符串，必填）
  • commentId: 要回复的评论 ID（数字，必填）
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）

• create_pull_request - 创建新的拉取请求

  • 所需 OAuth 范围: repo
  • base: 要合并到的分支（字符串，必填）
  • body: PR 描述（字符串，可选）
  • draft: 是否创建为草稿 PR（布尔值，可选）
  • head: 包含更改的分支（字符串，必填）
  • maintainer_can_modify: 是否允许维护者编辑（布尔值，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • title: PR 标题（字符串，必填）

• list_pull_requests - 列出拉取请求

  • 所需 OAuth 范围: repo
  • base: 按基础分支筛选（字符串，可选）
  • direction: 排序方向（字符串，可选）
  • head: 按头部用户/组织及分支筛选（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小为 1，最大为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）
  • sort: 按什么排序（字符串，可选）
  • state: 按状态筛选（字符串，可选）

• merge_pull_request - 合并拉取请求

  • 所需 OAuth 范围: repo
  • commit_message: 合并提交的额外说明（字符串，可选）
  • commit_title: 合并提交的标题（字符串，可选）
  • merge_method: 合并方法（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）

• pull_request_read - 获取单个拉取请求的详细信息

  • 所需 OAuth 范围: repo
  • method: 操作，用于指定需要从 GitHub 获取的拉取请求数据。 可能的选项：
    1. get - 获取特定拉取请求的详细信息。
    2. get_diff - 获取拉取请求的差异。
    3. get_status - 获取拉取请求中头部提交的合并提交状态。
    4. get_files - 获取拉取请求中更改的文件列表。结合分页参数控制返回结果的数量。
    5. get_review_comments - 获取拉取请求上的评审线程。每个线程包含在拉取请求评审期间对同一代码位置所做的逻辑分组的评审评论。返回带有元数据（isResolved、isOutdated、isCollapsed）及其相关评论的线程。使用基于游标的分页（perPage、after）来控制结果。
    6. get_reviews - 获取拉取请求上的评审。如果需要评审评论，请使用 get_review_comments 方法。
    7. get_comments - 获取拉取请求上的评论。如果用户不特别需要评审评论，可使用此方法。结合分页参数控制返回结果的数量。
    8. get_check_runs - 获取拉取请求头部提交的检查运行。检查运行是针对该拉取请求运行的各个 CI/CD 作业和检查。 （字符串，必填）
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 分页每页的结果数量（最小值为 1，最大值为 100）（数字，可选）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）

• pull_request_review_write - 对拉取请求评审进行写操作（创建、提交、删除）。

  • 所需 OAuth 范围: repo
  • body: 评审评论文本（字符串，可选）
  • commitID: 要评审的提交的 SHA 值（字符串，可选）
  • event: 要执行的评审操作。（字符串，可选）
  • method: 要对拉取请求评审执行的写操作。（字符串，必填）
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）
  • threadId: 评审线程的节点 ID（例如：PRRT_kwDOxxx）。对于 resolve_thread 和 unresolve_thread 方法是必填项。评审线程 ID 可通过 pull_request_read 方法中的 get_review_comments 获取。（字符串，可选）

• search_pull_requests - 搜索拉取请求。

  • 所需 OAuth 范围: repo
  • order: 排序顺序（字符串，可选）
  • owner: 可选的仓库所有者。如果同时提供了 repo，则仅列出该仓库的拉取请求。（字符串，可选）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 分页每页的结果数量（最小值为 1，最大值为 100）（数字，可选）
  • query: 使用 GitHub 拉取请求搜索语法的搜索查询（字符串，必填）
  • repo: 可选的仓库名称。如果同时提供了 owner，则仅列出该仓库的拉取请求。（字符串，可选）
  • sort: 按匹配类别数量排序的字段，默认为最佳匹配（字符串，可选）

• update_pull_request - 编辑拉取请求。

  • 所需 OAuth 范围: repo
  • base: 新的基础分支名称（字符串，可选）
  • body: 新的描述（字符串，可选）
  • draft: 将拉取请求标记为草稿（true）或准备评审（false）（布尔值，可选）
  • maintainer_can_modify: 允许维护者编辑（布尔值，可选）
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: 要更新的拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）
  • reviewers: 需要请求评审的 GitHub 用户名（字符串数组，可选）
  • state: 新的状态（字符串，可选）
  • title: 新标题（字符串，可选）

• update_pull_request_branch - 更新拉取请求分支。

  • 所需 OAuth 范围: repo
  • expectedHeadSha: 拉取请求 HEAD 引用的预期 SHA 值（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • pullNumber: 拉取请求编号（数字，必填）
  • repo: 仓库名称（字符串，必填）

仓库

• create_branch - 创建分支。

  • 所需 OAuth 范围: repo
  • branch: 新分支的名称（字符串，必填）
  • from_branch: 源分支（默认为仓库默认分支）（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• create_or_update_file - 创建或更新文件。

  • 所需 OAuth 范围: repo
  • branch: 要在其中创建或更新文件的分支（字符串，必填）
  • content: 文件内容（字符串，必填）
  • message: 提交消息（字符串，必填）
  • owner: 仓库所有者（用户名或组织）（字符串，必填）
  • path: 要创建或更新文件的路径（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • sha: 被替换文件的 blob SHA 值。如果文件已存在，则为必填项。（字符串，可选）

• create_repository - 创建仓库。

  • 所需 OAuth 范围: repo
  • autoInit: 是否初始化 README 文件（布尔值，可选）
  • description: 仓库描述（字符串，可选）
  • name: 仓库名称（字符串，必填）
  • organization: 要在其中创建仓库的组织（省略则在个人账户中创建）（字符串，可选）
  • private: 仓库是否应为私有（布尔值，可选）

• delete_file - 删除文件。

  • 所需 OAuth 范围: repo
  • branch: 要从中删除文件的分支（字符串，必填）
  • message: 提交消息（字符串，必填）
  • owner: 仓库所有者（用户名或组织）（字符串，必填）
  • path: 要删除文件的路径（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• fork_repository - 分叉仓库。

  • 所需 OAuth 范围: repo
  • organization: 要分叉到的组织（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• get_commit - 获取提交详情。

  • 所需 OAuth 范围: repo
  • include_diff: 是否在响应中包含文件差异和统计信息。默认为 true。（布尔值，可选）
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 分页每页的结果数量（最小值为 1，最大值为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）
  • sha: 提交 SHA、分支名称或标签名称（字符串，必填）

• get_file_contents - 获取文件或目录内容

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（用户名或组织）（字符串，必填）
  • path: 文件/目录的路径（字符串，可选）
  • ref: 接受可选的 Git 引用，如 refs/tags/{tag}、refs/heads/{branch} 或 refs/pull/{pr_number}/head（字符串，可选）
  • repo: 仓库名称（字符串，必填）
  • sha: 接受可选的提交 SHA。如果指定，则会替代 ref 使用（字符串，可选）

• get_latest_release - 获取最新发布

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• get_release_by_tag - 根据标签名获取发布

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • tag: 标签名（例如 'v1.0.0'）（字符串，必填）

• get_tag - 获取标签详情

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）
  • tag: 标签名（字符串，必填）

• list_branches - 列出分支

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）

• list_commits - 列出提交

  • 所需 OAuth 范围: repo
  • author: 用于按作者用户名或电子邮件地址筛选提交的作者（字符串，可选）
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • path: 只返回包含该文件路径的提交（字符串，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）
  • sha: 提交 SHA、分支或标签名，用于列出其下的提交。如果不提供，则使用仓库的默认分支。如果提供了提交 SHA，则会列出直到该 SHA 的所有提交。（字符串，可选）
  • since: 只返回此日期之后的提交（ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ 或 YYYY-MM-DD）（字符串，可选）
  • until: 只返回此日期之前的提交（ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ 或 YYYY-MM-DD）（字符串，可选）

• list_releases - 列出发布

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）

• list_tags - 列出标签

  • 所需 OAuth 范围: repo
  • owner: 仓库所有者（字符串，必填）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • repo: 仓库名称（字符串，必填）

• push_files - 将文件推送到仓库

  • 所需 OAuth 范围: repo
  • branch: 要推送的分支（字符串，必填）
  • files: 要推送的文件对象数组，每个对象包含路径（字符串）和内容（字符串）（对象数组，必填）
  • message: 提交信息（字符串，必填）
  • owner: 仓库所有者（字符串，必填）
  • repo: 仓库名称（字符串，必填）

• search_code - 搜索代码

  • 所需 OAuth 范围: repo
  • order: 结果的排序方式（字符串，可选）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • query: 使用 GitHub 强大的代码搜索语法进行查询。示例：content:Skill language:Java org:github、NOT is:archived language:Python OR language:go、repo:github/github-mcp-server。支持精确匹配、语言过滤、路径过滤等。（字符串，必填）
  • sort: 排序字段（仅限 'indexed'）（字符串，可选）

• search_repositories - 搜索仓库

  • 所需 OAuth 范围: repo
  • minimal_output: 返回精简的仓库信息（默认为 true）。当设置为 false 时，将返回完整的 GitHub API 仓库对象。（布尔值，可选）
  • order: 排序方式（字符串，可选）
  • page: 分页的页码（最小值为 1）（数字，可选）
  • perPage: 每页显示的结果数（最小值为 1，最大值为 100）（数字，可选）
  • query: 仓库搜索查询。示例：machine learning in:name stars:>1000 language:python、topic:react、user:facebook。支持高级搜索语法以实现精准过滤。（字符串，必填）
  • sort: 按字段对仓库进行排序，默认为最佳匹配（字符串，可选）

秘密保护

• get_secret_scanning_alert - 获取秘密扫描告警

  • 所需 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo、security_events
  • alertNumber: 告警的编号。（数字，必填）
  • owner: 仓库的所有者。（字符串，必填）
  • repo: 仓库的名称。（字符串，必填）

• list_secret_scanning_alerts - 列出秘密扫描告警

  • 所需 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo、security_events
  • owner: 仓库的所有者。（字符串，必填）
  • repo: 仓库的名称。（字符串，必填）
  • resolution: 按解决状态过滤（字符串，可选）
  • secret_type: 以逗号分隔的要返回的秘密类型列表。默认会返回所有预设的秘密模式。若要返回通用模式，请在参数中传入相应的令牌名称。（字符串，可选）
  • state: 按状态过滤（字符串，可选）

安全公告

• get_global_security_advisory - 获取全球安全公告

  • 所需 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo、security_events
  • ghsaId: GitHub 安全公告 ID（格式：GHSA-xxxx-xxxx-xxxx）。（字符串，必填）

• list_global_security_advisories - 列出全局安全公告

  • 必需的 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo, security_events
  • affects: 按受影响的包或版本筛选公告（例如：“package1,package2@1.0.0”）。（字符串，可选）
  • cveId: 按 CVE ID 筛选。（字符串，可选）
  • cwes: 按通用漏洞枚举 ID 筛选（例如：[“79”, “284”, “22”]）。（字符串数组，可选）
  • ecosystem: 按软件包生态系统筛选。（字符串，可选）
  • ghsaId: 按 GitHub 安全公告 ID 筛选（格式：GHSA-xxxx-xxxx-xxxx）。（字符串，可选）
  • isWithdrawn: 是否仅返回已撤销的公告。（布尔值，可选）
  • modified: 按发布或更新日期或日期范围筛选（ISO 8601 格式的日期或范围）。（字符串，可选）
  • published: 按发布日期或日期范围筛选（ISO 8601 格式的日期或范围）。（字符串，可选）
  • severity: 按严重性筛选。（字符串，可选）
  • type: 公告类型。（字符串，可选）
  • updated: 按更新日期或日期范围筛选（ISO 8601 格式的日期或范围）。（字符串，可选）

• list_org_repository_security_advisories - 列出组织仓库的安全公告

  • 必需的 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo, security_events
  • direction: 排序方向。（字符串，可选）
  • org: 组织登录名。（字符串，必填）
  • sort: 排序字段。（字符串，可选）
  • state: 按公告状态筛选。（字符串，可选）

• list_repository_security_advisories - 列出仓库的安全公告

  • 必需的 OAuth 范围: security_events
  • 接受的 OAuth 范围: repo, security_events
  • direction: 排序方向。（字符串，可选）
  • owner: 仓库所有者。（字符串，必填）
  • repo: 仓库名称。（字符串，必填）
  • sort: 排序字段。（字符串，可选）
  • state: 按公告状态筛选。（字符串，可选）

星标用户

• list_starred_repositories - 列出被星标的仓库

  • 必需的 OAuth 范围: repo
  • direction: 按照哪个方向排序结果。（字符串，可选）
  • page: 分页的页码（最小为 1）。（数字，可选）
  • perPage: 分页时每页显示的结果数量（最小为 1，最大为 100）。（数字，可选）
  • sort: 如何对结果进行排序。可以是‘created’（仓库被星标的时间）或‘updated’（仓库最近一次推送的时间）。（字符串，可选）
  • username: 要列出被星标仓库的用户名。默认为已认证的用户。（字符串，可选）

• star_repository - 星标仓库

  • 必需的 OAuth 范围: repo
  • owner: 仓库所有者。（字符串，必填）
  • repo: 仓库名称。（字符串，必填）

• unstar_repository - 取消星标仓库

  • 必需的 OAuth 范围: repo
  • owner: 仓库所有者。（字符串，必填）
  • repo: 仓库名称。（字符串，必填）

用户

• search_users - 搜索用户
  • 必需的 OAuth 范围: repo
  • order: 排序顺序。（字符串，可选）
  • page: 分页的页码（最小为 1）。（数字，可选）
  • perPage: 分页时每页显示的结果数量（最小为 1，最大为 100）。（数字，可选）
  • query: 用户搜索查询。示例：“john smith”、“location:seattle”、“followers:>100”。搜索会自动限定为 type:user。（字符串，必填）
  • sort: 按关注者数量、仓库数量或加入 GitHub 的时间对用户进行排序。（字符串，可选）

• create_pull_request_with_copilot - 使用 GitHub Copilot 编码助手执行任务
  • owner: 仓库所有者。你可以先猜测所有者，但在继续之前请与用户确认。（字符串，必填）
  • repo: 仓库名称。你可以先猜测仓库名称，但在继续之前请与用户确认。（字符串，必填）
  • problem_statement: 要执行的任务的详细描述（例如：“实现一个做 X 的功能”，“修复 bug Y”等）。（字符串，必填）
  • title: 将要创建的拉取请求的标题。（字符串，必填）
  • base_ref: 代理将开始工作的 Git 引用（例如分支）。如果未指定，则默认为仓库的默认分支。（字符串，可选）

• get_copilot_space - 获取 Copilot Space

  • owner: 该空间的所有者。（字符串，必填）
  • name: 该空间的名称。（字符串，必填）

• list_copilot_spaces - 列出 Copilot Spaces

• github_support_docs_search - 检索与回答 GitHub 产品和支持问题相关的文档。支持主题包括：GitHub Actions 工作流、身份验证、GitHub 支持咨询、拉取请求实践、仓库维护、GitHub Pages、GitHub Packages、GitHub Discussions、Copilot Spaces。
  • query: 用户关于需要解答的问题的输入。这是最新的原始未编辑的用户消息。你应始终保留用户消息原样，绝不要对其进行修改。（字符串，必填）