GitHub MCP

环境变量（推荐）

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

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

   export GITHUB_PAT=your_token_here
   

   或创建 .env 文件：

   GITHUB_PAT=your_token_here
   

2. 保护您的 .env 文件

   # Add to .gitignore to prevent accidental commits
   echo ".env" >> .gitignore
   

3. 在配置中引用令牌

   # CLI usage
   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
   
   # In config files (where supported)
   "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 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}"
      }
    }
  }
}

Actions

• actions_get - 获取GitHub Actions资源（工作流、工作流运行、作业和工件）的详细信息

  • OAuth挑战范围：repo
  • method：要执行的方法（字符串，必填）
  • owner：仓库所有者（字符串，必填）
  • repo：仓库名称（字符串，必填）
  • resource_id：资源的唯一标识符。这将根据提供的“方法”而变化，因此请确保提供正确的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：资源的唯一标识符。这将根据提供的“方法”而变化，因此请确保提供正确的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：为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：按状态过滤代码扫描警报。默认为打开（字符串，可选）
  • tool_name：用于代码扫描的工具名称。（字符串，可选）

上下文

• get_me - 获取我的用户资料

  • MCP应用界面：ui://github-mcp-server/get-me
  • 无需参数

• get_team_members - 获取团队成员

  • OAuth挑战范围：read:org
  • org：包含团队的组织登录名（所有者）。（字符串，必填）
  • team_slug：团队slug（字符串，必填）

• get_teams - 获取团队

  • OAuth挑战范围：read:org
  • user：要获取团队的用户名。如果未提供，则使用已认证用户。（字符串，可选）

• ui_get - 获取UI数据

  • OAuth挑战范围：repo、read:org
  • method：要获取的数据类型（字符串，必填）
  • owner：仓库所有者（所有方法必填）（字符串，必填）
  • repo：仓库名称（标签、分配者、里程碑、分支、问题字段、审查者必填）（字符串，可选）

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

Governance

• create_repository_ruleset - 创建仓库规则集

  • OAuth 挑战范围：repo、admin:org、admin:enterprise
  • bypass_actors：可以绕过此规则集中规则的操作者（对象数组，可选）
  • conditions：此规则集适用的条件，例如 {"ref_name": {"include": ["refs/heads/main"], "exclude": []}}（对象，可选）
  • enforcement：规则集的执行级别。'evaluate' 允许管理员在强制执行前测试规则（字符串，必填）
  • enterprise：企业标识。当级别为 'enterprise' 时必填。（字符串，可选）
  • level：规则集配置的级别：
    • 'repository'：单个仓库上的规则集（需要 'owner' 和 'repo'）。
    • 'organization'：覆盖组织中仓库的规则集（需要 'org'）。
    • 'enterprise'：覆盖企业中仓库的规则集（需要 'enterprise'）。（字符串，必填）
  • name：规则集的名称（字符串，必填）
  • org：组织名称。当级别为 'organization' 时必填。（字符串，可选）
  • owner：仓库所有者。当级别为 'repository' 时必填。（字符串，可选）
  • repo：仓库名称。当级别为 'repository' 时必填。（字符串，可选）
  • rules：规则集内的规则数组。每条规则都是一个对象，包含 'type'（例如，'creation'、'deletion'、'non_fast_forward'、'required_signatures'、'pull_request'、'required_status_checks'），对于需要配置的规则，还包含 'parameters' 对象（对象数组，必填）
  • target：规则集的目标。默认为 'branch'。'repository' 仅对 'organization' 和 'enterprise' 级别的规则集有效。（字符串，可选）

• custom_properties_read - 读取自定义属性

  • OAuth 挑战范围：repo、read:org、read:enterprise
  • enterprise：企业标识。当级别为 'enterprise' 时必填。（字符串，可选）
  • level：自定义属性管理的级别：
    • 'repository'：分配给仓库的自定义属性值（需要 'owner' 和 'repo'）。
    • 'organization'：组织的自定义属性定义（模式）（需要 'org'）。
    • 'enterprise'：企业的自定义属性定义（模式）（需要 'enterprise'）。（字符串，必填）
  • org：组织名称。当级别为 'organization' 时必填。（字符串，可选）
  • owner：仓库所有者。当级别为 'repository' 时必填。（字符串，可选）
  • repo：仓库名称。当级别为 'repository' 时必填。（字符串，可选）

• custom_properties_write - 设置自定义属性

  • OAuth 挑战范围：repo、admin:org、admin:enterprise
  • enterprise：企业 slug。当级别为“enterprise”时必填。（字符串，可选）
  • level：管理自定义属性的级别：
    • “repository”：分配给仓库的自定义属性值（需要“owner”和“repo”）。
    • “organization”：组织的自定义属性定义（模式）（需要“org”）。
    • “enterprise”：企业的自定义属性定义（模式）（需要“enterprise”）。（字符串，必填）
  • org：组织名称。当级别为“organization”时必填。（字符串，可选）
  • owner：仓库所有者。当级别为“repository”时必填。（字符串，可选）
  • properties：要创建或更新的自定义属性。在仓库级别，每个项目分配一个值（“property_name”和“value”）；在组织和企业级别，每个项目定义模式（“property_name”和“value_type”，以及可选的定义字段）。（对象数组，必填）
  • repo：仓库名称。当级别为“repository”时必填。（字符串，可选）

• repository_ruleset_read - 读取仓库规则集

  • OAuth 挑战范围：repo、read:org、read:enterprise
  • actor_name：用于过滤规则套件的 GitHub 用户账户句柄。由“list_rule_suites”方法使用。（字符串，可选）
  • branch：分支名称。“get_rules_for_branch”方法必填。（字符串，可选）
  • enterprise：企业 slug。当级别为“enterprise”时必填。（字符串，可选）
  • evaluate_status：按规则集评估模式过滤规则套件。由“list_rule_suites”方法使用。（字符串，可选）
  • includes_parents：包括在更高级别配置且同样适用的规则集。默认为 true。由仓库级别的“get”和“list”方法使用。（布尔值，可选）
  • level：配置规则集的级别：
    • “repository”：单个仓库上的规则集（需要“owner”和“repo”）。
    • “organization”：覆盖组织中仓库的规则集（需要“org”）。
    • “enterprise”：覆盖整个企业仓库的规则集（需要“enterprise”）。（字符串，必填）
  • method：要执行的操作：
    • “get”：按 ID 获取特定规则集（需要“ruleset_id”）。支持所有级别。
    • “list”：列出所有规则集。支持所有级别。
    • “get_rules_for_branch”：获取适用于分支的所有规则（需要“branch”）。仅限仓库级别。
    • “list_rule_suites”：列出规则套件，即对推送的规则评估。仅限仓库和组织级别。
    • “get_rule_suite”：按 ID 获取特定规则套件（需要“rule_suite_id”）。仅限仓库和组织级别。（字符串，必填）
  • org：组织名称。当级别为“organization”时必填。（字符串，可选）
  • owner：仓库所有者。当级别为“repository”时必填。（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • ref：用于过滤规则套件的引用名称（分支、标签等）。由“list_rule_suites”方法使用。（字符串，可选）
  • repo：仓库名称。当级别为“repository”时必填。（字符串，可选）
  • repository_name：用于过滤规则套件的仓库名称。由组织级别的“list_rule_suites”方法使用。（字符串，可选）
  • rule_suite_id：规则套件 ID。“get_rule_suite”方法必填。（数字，可选）
  • rule_suite_result：要过滤的规则套件结果。由“list_rule_suites”方法使用。（字符串，可选）
  • ruleset_id：规则集 ID。“get”方法必填。（数字，可选）
  • time_period：按时间段过滤规则套件。由“list_rule_suites”方法使用。（字符串，可选）

问题

• 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 - 获取问题详情。还返回尽力而为的层级标志（has_parent、has_children）；parent 和 sub_issues_summary 是可选的关联摘要，closed_by_pull_requests 总结了配置为关闭该问题的拉取请求，作为 total_count 以及最多 5 个 references。
    2. get_comments - 获取问题评论。
    3. get_sub_issues - 获取问题的子问题（子项）。
    4. get_parent - 获取父问题（如果此问题是另一个问题的子问题）。
    5. get_labels - 获取分配给问题的标签。 （字符串，必填）
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）

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

  • OAuth 挑战范围：repo
  • MCP 应用界面：ui://github-mcp-server/issue-write
  • 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：仓库所有者（字符串，必填）
  • parent_issue_number：父问题的问题编号。仅在 method 为“create”时使用，且不能与 issue_fields 结合使用。新问题将在同一操作中创建并附加到此父问题。（数字，可选）
  • parent_owner：父问题的仓库所有者。必须与 parent_repo 一起提供。两者都省略则使用 owner 和 repo。仅在 method 为“create”且提供了 parent_issue_number 时使用。（字符串，可选）
  • parent_repo：父问题的仓库名称。必须与 parent_owner 一起提供。两者都省略则使用 owner 和 repo。仅在 method 为“create”且提供了 parent_issue_number 时使用。（字符串，可选）
  • repo：仓库名称（字符串，必填）
  • state：新状态（字符串，可选）
  • state_reason：状态更改的原因。除非状态发生更改，否则忽略。（字符串，可选）
  • title：问题标题（字符串，可选）
  • type：此问题的类型。对于更新，传递 null 以移除当前类型。仅当此仓库启用了问题类型时使用。使用 list_issue_types 获取此仓库或其所有者组织的有效类型值。如果仓库不支持问题类型，请省略此参数。（字符串或 null，可选）

• list_issue_fields - 列出问题字段

  • OAuth 挑战范围：repo、read:org
  • owner：仓库或组织的账户所有者。名称不区分大小写。（字符串，必填）
  • repo：仓库名称。提供时，返回此特定仓库的字段（从其组织继承）。省略时，直接返回组织级字段。（字符串，可选）

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

  • OAuth 挑战范围：repo、read:org
  • owner：仓库或组织的账户所有者。（字符串，必填）
  • repo：仓库名称。提供时，返回此特定仓库的问题类型。省略时，直接返回组织级问题类型。（字符串，可选）

• list_issues - 列出问题

  • OAuth 挑战范围：repo
  • after：分页游标。使用上一个响应中的游标。（字符串，可选）
  • direction：排序方向。如果提供，则还需要提供“orderBy”。（字符串，可选）
  • field_filters：按自定义问题字段值过滤。每个条目包含一个 field_name 和一个 value；服务器查找该字段并将值强制转换为其类型（单选选项名称、文本、数字或 YYYY-MM-DD 日期）。（对象数组，可选）
  • fields：为每个问题返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，使用此选项可减小响应大小；特别是省略“body”和“field_values”会删除每个结果中最大的数据。（字符串数组，可选）
  • labels：按标签过滤（字符串数组，可选）
  • orderBy：按字段对问题排序。如果提供，则还需要提供“direction”。（字符串，可选）
  • owner：仓库所有者（字符串，必填）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）
  • since：按日期过滤（ISO 8601 时间戳）（字符串，可选）
  • state：按状态过滤，未提供时默认返回打开和关闭的问题（字符串，可选）

• search_issues - 搜索问题

  • OAuth 挑战范围：repo
  • fields：每个问题结果要返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，使用此选项可减小响应大小；特别是省略“body”、“reactions”和“labels”会减少每个结果中最大的数据。（字符串数组，可选）
  • order：排序顺序（字符串，可选）
  • owner：可选的仓库所有者。如果与仓库名称一起提供，则仅列出此仓库的问题。（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：每页结果数（最小 1，最大 100）（数字，可选）
  • query：搜索查询，使用自然语言。当用户给出替代措辞时，将其作为普通词语包含，而不是用 OR 连接。（字符串，必填）
  • repo：可选的仓库名称。如果与所有者一起提供，则仅列出此仓库的问题。（字符串，可选）
  • 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' 指定新位置。 写入问题层级。要将子问题移动到新的父问题，请使用 add 配合 replace_parent=true；没有可写的父字段。 （字符串，必填）
  • owner：仓库所有者（字符串，必填）
  • replace_parent：为 true 时，替换子问题当前的父问题。仅与 'add' 方法一起使用。（布尔值，可选）
  • repo：仓库名称（字符串，必填）
  • sub_issue_id：要添加的子问题的 ID。ID 与问题编号不同（数字，必填）

• update_issue_comment - 更新问题评论

  • OAuth 挑战范围：repo
  • body：新的评论内容（字符串，必填）
  • comment_id：要更新的问题或拉取请求对话评论的数字 ID。不要使用拉取请求审查评论 ID。（整数，必填）
  • owner：仓库所有者（字符串，必填）
  • repo：仓库名称（字符串，必填）

标签

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

• list_label - 列出仓库中的标签

  • OAuth 挑战范围：repo
  • after：分页游标。使用上一个响应中的游标。（字符串，可选）
  • owner：仓库所有者（用户名或组织名称）- 所有操作必填（字符串，必填）
  • perPage：每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称 - 所有操作必填（字符串，必填）

通知

• dismiss_notification - 关闭通知

  • OAuth 挑战范围：notifications
  • state：通知的新状态（read/done）（字符串，必填）
  • 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
  • order：排序顺序（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：每页结果数（最小 1，最大 100）（数字，可选）
  • query：组织搜索查询。示例：'microsoft'、'location:california'、'created:>=2025-01-01'。搜索自动限定为 type:org。（字符串，必填）
  • sort：按类别排序的字段（字符串，可选）

项目

• projects_get - 获取 GitHub Projects 资源的详情

  • OAuth 挑战范围：read:project
  • field_id：字段的 ID。'get_project_field' 方法必填。（数字，可选）
  • field_names：获取项目项时要在响应中包含的特定字段名称列表（例如 ["Status", "Priority"]）。在服务器端解析为字段 ID — 当您只知道人类可读名称时，请传递此参数而不是 'fields'。与 'fields' 互斥 — 只提供其中一个，不要同时提供。仅用于 'get_project_item' 方法。（字符串数组，可选）
  • fields：获取项目项时要在响应中包含的特定字段 ID 列表（例如 ["102589", "985201", "169875"]）。如果既未提供 'fields' 也未提供 'field_names'，则仅包含标题字段。与 'field_names' 互斥 — 只提供其中一个，不要同时提供。仅用于 'get_project_item' 方法。（字符串数组，可选）
  • item_id：项目的 ID。'get_project_item' 方法必填。（数字，可选）
  • method：要执行的方法（字符串，必填）
  • owner：所有者（用户或组织登录名）。名称不区分大小写。（字符串，可选）
  • owner_type：所有者类型（用户或组织）。如果未提供，将自动检测。（字符串，可选）
  • project_number：项目的编号。（数字，可选）
  • status_update_id：项目状态更新的节点 ID。'get_project_status_update' 方法必填。（字符串，可选）
  • view_id：项目视图的节点 ID。'get_project_view' 方法必填。（字符串，可选）

• projects_list - 列出 GitHub Projects 资源

  • OAuth 挑战范围：read:project
  • after：来自上一页 pageInfo.nextCursor 的向前分页游标。（字符串，可选）
  • before：来自上一页 pageInfo.prevCursor 的向后分页游标（罕见）。（字符串，可选）
  • field_names：列出项目项时要包含的字段名称（例如 ["Status", "Priority"]）。在服务端解析为字段 ID——当您只知道人类可读名称时，请传递此参数而不是 'fields'。无法解析的名称会返回结构化错误。与 'fields' 互斥——只提供其中一个，不要同时提供。仅用于 'list_project_items' 方法。（字符串数组，可选）
  • fields：列出项目项时要包含的字段 ID（例如 ["102589", "985201"]）。关键：始终提供以获取字段值。没有此参数（也没有 'field_names'）时，仅返回标题。与 'field_names' 互斥——只提供其中一个，不要同时提供。仅用于 'list_project_items' 方法。（字符串数组，可选）
  • method：要执行的操作（字符串，必填）
  • owner：所有者（用户或组织登录名）。名称不区分大小写。（字符串，必填）
  • owner_type：所有者类型（用户或组织）。如果未提供，将自动尝试两者。（字符串，可选）
  • perPage：每页结果数（最多 50）（数字，可选）
  • project_number：项目编号。'list_project_fields'、'list_project_items'、'list_project_views' 和 'list_project_status_updates' 方法必填。（数字，可选）
  • query：筛选/查询字符串。对于 list_projects：按标题文本和状态筛选（例如 "roadmap is:open"）。对于 list_project_items：使用 GitHub 的项目筛选语法进行高级筛选。（字符串，可选）

• projects_write - 管理 GitHub Projects

  • OAuth 挑战范围：project
  • body：状态更新的正文（markdown）。用于 'create_project_status_update' 方法。（字符串，可选）
  • field_name：迭代字段的名称（例如 'Sprint'）。'create_iteration_field' 方法必填。（字符串，可选）
  • filter：已保存的视图筛选器；更新时省略以保留，或传递 null 以清除。（字符串 | null，可选）
  • issue_number：问题编号。当 item_type 为 'issue' 时，'add_project_item' 必填。'update_project_item' 也接受此参数以按问题编号解析项目项（与 item_owner 和 item_repo 结合使用）。（数字，可选）
  • item_id：项目项 ID。'delete_project_item' 必填。对于 'update_project_item'，提供 item_id，或（item_owner + item_repo + issue_number）以按问题解析项目项。（数字，可选）
  • item_owner：包含问题或拉取请求的仓库的所有者（用户或组织）。'add_project_item' 方法必填。'update_project_item' 按问题编号解析项目项时也接受此参数。（字符串，可选）
  • item_repo：包含问题或拉取请求的仓库名称。'add_project_item' 方法必填。'update_project_item' 按问题编号解析项目项时也接受此参数。（字符串，可选）
  • item_type：项目项的类型，issue 或 pull_request。'add_project_item' 方法必填。（字符串，可选）
  • items：要使用顶级 'updated_field' 更新的项目项。'update_project_items' 必填；优先使用它而不是在循环中调用 'update_project_item'。每个条目必须精确匹配一种引用变体：'node_id'、数字 'item_id' 或 'item_owner' + 'item_repo' + 'issue_number'。限制：每次调用最多 50 个项目项。（对象数组，可选）
  • iteration_duration：字段迭代的持续时间（天）（例如 7 表示每周，14 表示每两周）。'create_iteration_field' 方法必填。（数字，可选）
  • iterations：'create_iteration_field' 方法的自定义迭代。仅当您需要不同持续时间、间隔或特定标题的迭代时才设置此参数。否则请省略：GitHub 会自动创建三个从 'start_date' 开始、持续 'iteration_duration' 天的迭代，这在大多数情况下是正确的选择。（对象数组，可选）
  • layout：视图布局；创建视图时必填。（字符串，可选）
  • method：要执行的方法（字符串，必填）
  • name：视图名称；创建视图时必填。（字符串，可选）
  • owner：项目所有者（用户或组织登录名）。名称不区分大小写。（字符串，必填）
  • owner_type：所有者类型（用户或组织）。'create_project' 方法必填。如果其他方法未提供，将自动检测。（字符串，可选）
  • project_number：项目编号。除 'create_project' 外的所有方法必填。（数字，可选）
  • pull_request_number：拉取请求编号（当 item_type 为 'pull_request' 时用于 'add_project_item' 方法）。提供 issue_number 或 pull_request_number 之一。（数字，可选）
  • start_date：开始日期，格式为 YYYY-MM-DD。用于 'create_project_status_update' 和 'create_iteration_field' 方法。（字符串，可选）
  • status：项目状态。用于 'create_project_status_update' 方法。（字符串，可选）
  • target_date：状态更新的目标日期，格式为 YYYY-MM-DD。用于 'create_project_status_update' 方法。（字符串，可选）
  • title：项目标题。'create_project' 方法必填。（字符串，可选）
  • updated_field：要应用的字段/值，使用 {"id": 123, "value": ...} 或 {"name": "Status", "value": ...}；null 清除字段。'update_project_item' 和 'update_project_items' 必填，其中一个顶级字段/值应用于批次中的每个项目项。对于 'update_project_item' 的 SINGLE_SELECT 字段，名称形式接受选项名称；ID 形式期望选项 ID。（对象，可选）
  • view_id：用于更新或删除的项目视图节点 ID；必须属于 owner/project_number。（字符串，可选）
  • visible_field_names：创建时显示或更新时替换的有序项目字段名称；更新时省略以保留，或传递 [] 以重置。与 visible_fields 互斥。Roadmap 仅接受 []。（字符串数组，可选）
  • visible_fields：创建时显示或更新时替换的有序项目字段数据库 ID；更新时省略以保留，或传递 [] 以重置。与 visible_field_names 互斥。Roadmap 仅接受 []。（字符串数组，可选）

拉取请求

• 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：回复的文本。除非提供了 reaction，否则必填。（字符串，可选）
  • commentId：要回复或反应的拉取请求审查评论的数字 ID。使用 #discussion_r... 锚点中的数字，而不是 GraphQL 线程节点 ID（PRRT_...）。（数字，必填）
  • owner：仓库所有者（字符串，必填）
  • pullNumber：拉取请求编号。提供 body 时必填。（数字，可选）
  • reaction：要添加的表情符号反应。除非提供了 body，否则必填。（字符串，可选）
  • repo：仓库名称（字符串，必填）

• create_pull_request - 打开新的拉取请求

  • OAuth 挑战范围：repo
  • MCP 应用界面：ui://github-mcp-server/pr-write
  • base：要合并到的分支（字符串，必填）
  • body：PR 描述（字符串，可选）
  • draft：创建为草稿 PR（布尔值，可选）
  • head：包含更改的分支（字符串，必填）
  • maintainer_can_modify：允许维护者编辑（布尔值，可选）
  • owner：仓库所有者（字符串，必填）
  • repo：仓库名称（字符串，必填）
  • reviewers：要请求审查的 GitHub 用户名或 ORG/team-slug 团队审查者（字符串数组，可选）
  • title：PR 标题（字符串，必填）

• list_pull_requests - 列出拉取请求

  • OAuth 挑战范围：repo
  • base：按基础分支筛选（字符串，可选）
  • direction：排序方向（字符串，可选）
  • fields：为每个拉取请求返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时使用此参数以减少响应大小；特别是省略 'body' 会删除每个结果中最大的数据。（字符串数组，可选）
  • head：按头部用户/组织和分支筛选（字符串，可选）
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）
  • sort：排序依据（字符串，可选）
  • state：按状态筛选（字符串，可选）

• merge_pull_request - 合并拉取请求

  • OAuth 挑战范围：repo
  • commit_message：合并提交的额外详细信息（字符串，可选）
  • commit_title：合并提交的标题（字符串，可选）
  • expectedHeadSha：拉取请求 HEAD 引用的预期 SHA（字符串，可选）
  • merge_method：合并方法（字符串，可选）
  • owner：仓库所有者（字符串，必填）
  • pullNumber：拉取请求编号（数字，必填）
  • repo：仓库名称（字符串，必填）

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

  • OAuth 挑战范围：repo
  • after：分页游标，仅由 get_review_comments 方法使用。传递上一页 PageInfo 中的 endCursor 以获取下一页。（字符串，可选）
  • method：指定需要从 GitHub 检索哪些拉取请求数据的操作。 可能选项：
    1. get - 获取特定拉取请求的详细信息。
    2. get_diff - 获取拉取请求的差异。
    3. get_status - 获取拉取请求中头部提交的组合提交状态。
    4. get_files - 获取拉取请求中更改的文件列表。使用分页参数控制返回结果数量。
    5. get_commits - 获取拉取请求上的提交列表。使用分页参数控制返回结果数量。
    6. get_review_comments - 获取拉取请求上的审查线程。每个线程包含在拉取请求审查期间对同一代码位置所做的逻辑分组的审查评论。返回线程元数据和评论，包含可空的当前和原始行范围坐标（line、start_line、original_line、original_start_line）。当前坐标在不可用时省略，例如过时评论。使用基于游标的分页（perPage、after）控制结果。
    7. get_reviews - 获取拉取请求上的审查。当被要求获取审查评论时，使用 get_review_comments 方法。使用分页参数控制返回结果数量。
    8. get_comments - 获取拉取请求上的评论。如果用户不特别要求审查评论，请使用此选项。使用分页参数控制返回结果数量。
    9. get_check_runs - 获取拉取请求头部提交的检查运行。检查运行是在 PR 上运行的各个 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 方法需要。通过 pull_request_read 使用 get_review_comments 方法获取线程 ID。（字符串，可选）

• search_pull_requests - 搜索拉取请求

  • OAuth 挑战范围：repo
  • fields：每个拉取请求结果要返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，使用此选项可减小响应大小；特别是省略 'body'、'reactions' 和 'labels' 会丢弃每个结果中最大的数据。（字符串[]，可选）
  • order：排序顺序（字符串，可选）
  • owner：可选的仓库所有者。如果与仓库一起提供，则仅列出此仓库的拉取请求。（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • query：使用 GitHub 拉取请求搜索语法的搜索查询（字符串，必填）
  • repo：可选的仓库名称。如果与所有者一起提供，则仅列出此仓库的拉取请求。（字符串，可选）
  • sort：按类别匹配数排序的字段，默认为最佳匹配（字符串，可选）

• update_pull_request - 编辑拉取请求

  • OAuth 挑战范围：repo
  • MCP 应用界面：ui://github-mcp-server/pr-edit
  • base：新的基础分支名称（字符串，可选）
  • body：新描述（字符串，可选）
  • draft：将拉取请求标记为草稿（true）或准备审查（false）（布尔值，可选）
  • maintainer_can_modify：允许维护者编辑（布尔值，可选）
  • owner：仓库所有者（字符串，必填）
  • pullNumber：要更新的拉取请求编号（数字，必填）
  • repo：仓库名称（字符串，必填）
  • reviewers：请求审查的 GitHub 用户名或 ORG/团队别名团队审查者（字符串[]，可选）
  • 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、workflow
  • allow_symlink_write：设置为 true 以更新符号链接本身；内容必须是其新目标路径。（布尔值，可选）
  • branch：要创建/更新文件的分支（字符串，必填）
  • content：文件内容，应完全按照写入后的样子。不要进行 base64 编码；此服务器在调用 REST API 之前会进行编码。（字符串，必填）
  • message：提交消息（字符串，必填）
  • owner：仓库所有者（用户名或组织）（字符串，必填）
  • path：要创建/更新文件的路径（字符串，必填）
  • repo：仓库名称（字符串，必填）
  • sha：要替换的文件的 blob SHA。如果文件已存在，则为必填。使用相同的所有者、仓库和路径，并将 ref 设置为此工具的分支值，通过 get_file_contents 获取。（字符串，可选）

• create_repository - 创建仓库

  • OAuth 挑战范围：repo
  • autoInit：使用 README 初始化（布尔值，可选）
  • description：仓库描述（字符串，可选）
  • name：仓库名称（字符串，必填）
  • organization：要在其中创建仓库的组织（省略则在您的个人账户中创建）（字符串，可选）
  • private：仓库是否应为私有。省略时默认为 true（私有）。（布尔值，可选）

• delete_file - 删除文件

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

• delete_repository - 删除仓库

  • OAuth 挑战范围：delete_repo、repo
  • owner：仓库所有者（用户名或组织）（字符串，必填）
  • repo：仓库名称（字符串，必填）

• fork_repository - 分叉仓库

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

• get_commit - 获取提交详细信息

  • OAuth 挑战范围：repo
  • detail：更改文件的详细信息级别。"none" 完全省略统计信息和文件。"stats"（默认）包括每个文件的元数据：文件名、状态和代码行数（添加、删除、更改），不包含补丁内容。"full_patch" 额外包括每个文件的统一差异内容，可能非常大。（字符串，可选）
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）
  • sha：提交 SHA、分支名称或标签名称（字符串，必填）

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

  • OAuth 挑战范围：repo
  • fields：当路径是目录时，每个条目要返回的字段子集。如果省略，则返回所有字段。当路径是单个文件时忽略。列出目录时，如果您只需要特定字段（例如仅 'name' 和 'type'），使用此选项可减小响应大小。（字符串[]，可选）
  • 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：用于筛选提交的作者用户名或电子邮件地址（字符串，可选）
  • fields：要为每个提交返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，可使用此选项来减小响应大小，例如仅使用“sha”和“html_url”。（字符串数组，可选）
  • 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
  • fields：要为每个发布返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，可使用此选项来减小响应大小；特别是省略“body”会删除每个发布中最大的数据。（字符串数组，可选）
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）

• list_repository_collaborators - 列出仓库协作者

  • OAuth 挑战范围：repo
  • affiliation：按关联关系筛选。可以是以下之一：“outside”（外部协作者）、“direct”（所有具有权限的人员，无论组织成员身份如何）、“all”（所有协作者）。默认值：“all”（字符串，可选）
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（默认 1，最小 1）（数字，可选）
  • perPage：分页每页结果数（默认 30，最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）

• list_tags - 列出标签

  • OAuth 挑战范围：repo
  • owner：仓库所有者（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库名称（字符串，必填）

• push_files - 推送文件到仓库

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

• search_code - 搜索代码

  • OAuth 挑战范围：repo
  • fields：要为每个代码搜索结果返回的字段子集。如果省略，则返回所有字段。当您只需要特定字段时，可使用此选项来减小响应大小；特别是省略“repository”和“text_matches”会删除每个结果中最大的数据。（字符串数组，可选）
  • order：结果的排序顺序（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • query：搜索查询（GitHub 代码搜索 REST）。术语之间隐式使用 AND；支持 OR、NOT 和 "quoted phrase" 进行精确匹配。限定符：repo:owner/repo、org:、user:、language:、path:dir（前缀匹配）、filename:exact.ext、extension:、in:file、in:path、size:、is:archived、is:fork。最大 256 个字符。示例：WithContext language:go org:github；"package main" repo:o/r；func extension:go path:cmd repo:o/r；NOT TODO language:go repo:o/r。（字符串，必填）
  • sort：排序字段（仅“indexed”）（字符串，可选）

• search_commits - 搜索提交

  • OAuth 挑战范围：repo
  • order：排序顺序（字符串，可选）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • query：提交搜索查询（GitHub 提交搜索 REST）。仅搜索默认分支上的提交消息。使用 repo:owner/repo、org: 或 user: 限定搜索范围（没有范围限定符的查询会匹配整个 GitHub，通常不是您想要的）。其他限定符：author:、committer:、author-name:、committer-name:、author-email:、committer-email:、author-date:、committer-date:（支持 >、<、>=、<= 和 YYYY-MM-DD..YYYY-MM-DD 范围）、merge:true|false、hash:、tree:、parent:、is:public。示例：repo:owner/repo fix panic；org:github author:defunkt committer-date:>=2024-01-01；"refactor cache" repo:o/r；hash:abc1234 repo:o/r。（字符串，必填）
  • sort：按作者或提交者日期排序（默认为最佳匹配）（字符串，可选）

• search_repositories - 搜索仓库

  • OAuth 挑战范围：repo
  • minimal_output：返回最简仓库信息（默认：true）。当为 false 时，现代客户端会收到额外的精选仓库详细信息，而非完整的 GitHub API 对象。旧版客户端保留完整的 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
  • alertNumber：警报编号。（数字，必填）
  • owner：仓库的所有者。（字符串，必填）
  • repo：仓库的名称。（字符串，必填）

• list_secret_scanning_alerts - 列出密钥扫描警报

  • OAuth 挑战范围：security_events
  • owner：仓库的所有者。（字符串，必填）
  • page：分页页码（最小 1）（数字，可选）
  • perPage：分页每页结果数（最小 1，最大 100）（数字，可选）
  • repo：仓库的名称。（字符串，必填）
  • resolution：按解决状态筛选（字符串，可选）
  • secret_type：要返回的密钥类型的逗号分隔列表。返回所有默认密钥模式。要返回通用模式，请在参数中传递令牌名称。（字符串，可选）
  • state：按状态筛选（字符串，可选）

安全公告

• get_global_security_advisory - 获取全局安全公告

  • OAuth 挑战范围：security_events
  • ghsaId：GitHub 安全公告 ID（格式：GHSA-xxxx-xxxx-xxxx）。（字符串，必填）

• list_global_security_advisories - 列出全局安全公告

  • OAuth 挑战范围：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
  • direction：排序方向。（字符串，可选）
  • org：组织登录名。（字符串，必填）
  • sort：排序字段。（字符串，可选）
  • state：按公告状态筛选。（字符串，可选）

• list_repository_security_advisories - 列出仓库安全公告

  • OAuth 挑战范围：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：仓库名称（字符串，必填）

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

• 身份验证说明

  • 细粒度 PAT 不会被经典 PAT 范围过滤隐藏，因此即使令牌无法使用这些工具，它们仍可能显示。
  • 对于组织拥有的 spaces，细粒度 PAT 必须安装在所属组织上，并包含 organization_copilot_spaces: read。
  • 如果组织拥有的 space 包含基于仓库的资源，则令牌还必须有权访问每个引用的仓库，否则该 space 可能被视为未找到。

• get_copilot_space - 获取 Copilot Space

  • owner：space 的所有者。（字符串，必填）
  • name：space 的名称。（字符串，必填）

• list_copilot_spaces - 列出 Copilot Spaces

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