GitHub MCP

環境變數（建議）

為了讓您的 GitHub PAT 在不同 MCP 主機間保持安全且可重複使用：

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 Challenge Scopes：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 Challenge Scopes：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 Challenge Scopes：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 Challenge Scopes：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 Challenge Scopes：repo
  • findingNumber：發現的編號。（數字，必填）
  • owner：儲存庫的擁有者。（字串，必填）
  • repo：儲存庫的名稱。（字串，必填）

程式碼安全

• get_code_scanning_alert - 取得程式碼掃描警示

  • OAuth Challenge Scopes：security_events
  • alertNumber：警示的編號。（數字，必填）
  • owner：儲存庫的擁有者。（字串，必填）
  • repo：儲存庫的名稱。（字串，必填）

• list_code_scanning_alerts - 列出程式碼掃描警示

  • OAuth Challenge Scopes：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 Challenge Scopes：read:org
  • org：包含團隊的組織登入名稱（擁有者）。（字串，必填）
  • team_slug：團隊 slug（字串，必填）

• get_teams - 取得團隊

  • OAuth Challenge Scopes：read:org
  • user：要取得團隊的使用者名稱。如果未提供，則使用已驗證的使用者。（字串，選填）

• ui_get - 取得 UI 資料

  • OAuth Challenge Scopes：repo、read:org
  • method：要取得的資料類型（字串，必填）
  • owner：儲存庫擁有者（所有方法必填）（字串，必填）
  • repo：儲存庫名稱（標籤、指派者、里程碑、分支、議題欄位、審閱者必填）（字串，選填）

Copilot

• assign_copilot_to_issue - 指派 Copilot 到議題

  • OAuth Challenge Scopes：repo
  • base_ref：代理程式將開始工作的 Git 引用（例如分支）。如果未指定，預設為儲存庫的預設分支（字串，選填）
  • custom_instructions：可選的自訂指示，用於引導代理程式超越議題主體。使用此選項提供議題描述中未捕獲的額外內容、限制或指導（字串，選填）
  • issue_number：議題編號（數字，必填）
  • owner：儲存庫擁有者（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• request_copilot_review - 請求 Copilot 審閱

  • OAuth Challenge Scopes：repo
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：拉取請求編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）

Dependabot

• get_dependabot_alert - 取得 Dependabot 警報

  • OAuth Challenge Scopes: security_events
  • alertNumber: 警報的編號。（數字，必填）
  • owner: 儲存庫的擁有者。（字串，必填）
  • repo: 儲存庫的名稱。（字串，必填）

• list_dependabot_alerts - 列出 Dependabot 警報

  • OAuth Challenge Scopes: security_events
  • after: 用於分頁的游標。使用前一個回應中的游標。（字串，選用）
  • owner: 儲存庫的擁有者。（字串，必填）
  • perPage: 每頁結果數，用於分頁（最小值 1，最大值 100）（數字，選用）
  • repo: 儲存庫的名稱。（字串，必填）
  • severity: 依嚴重性篩選 Dependabot 警報（字串，選用）
  • state: 依狀態篩選 Dependabot 警報。預設為 open（字串，選用）

Discussions

• discussion_comment_write - 管理討論留言

  • OAuth Challenge Scopes: 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' - 將討論留言標記為答案（僅限 Q&A）。
    • 'unmark_answer' - 取消將討論留言標記為答案（僅限 Q&A）。 （字串，必填）
  • owner: 儲存庫擁有者（'add' 和 'reply' 方法需要）（字串，選用）
  • repo: 儲存庫名稱（'add' 和 'reply' 方法需要）（字串，選用）

• get_discussion - 取得討論

  • OAuth Challenge Scopes: repo
  • discussionNumber: 討論編號（數字，必填）
  • owner: 儲存庫擁有者（字串，必填）
  • repo: 儲存庫名稱（字串，必填）

• get_discussion_comments - 取得討論留言

  • OAuth Challenge Scopes: repo
  • after: 用於分頁的游標。使用前一個回應中的游標。（字串，選用）
  • discussionNumber: 討論編號（數字，必填）
  • includeReplies: 若為 true，每個頂層留言將包含巢狀在其中的回覆（每個留言最多 100 個回覆，這是 GitHub API 的上限）。預設為 false。（布林值，選用）
  • owner: 儲存庫擁有者（字串，必填）
  • perPage: 每頁結果數，用於分頁（最小值 1，最大值 100）（數字，選用）
  • repo: 儲存庫名稱（字串，必填）

• list_discussion_categories - 列出討論類別

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者（字串，必填）
  • repo: 儲存庫名稱。若未提供，將在組織層級查詢討論類別。（字串，選用）

• list_discussions - 列出討論

  • OAuth Challenge Scopes: repo
  • after: 用於分頁的游標。使用前一個回應中的游標。（字串，選用）
  • category: 可選的討論類別 ID 篩選條件。若提供，僅列出具有此類別的討論。（字串，選用）
  • direction: 排序方向。（字串，選用）
  • orderBy: 依欄位排序討論。若提供，也需提供 'direction'。（字串，選用）
  • owner: 儲存庫擁有者（字串，必填）
  • perPage: 每頁結果數，用於分頁（最小值 1，最大值 100）（數字，選用）
  • repo: 儲存庫名稱。若未提供，將在組織層級查詢討論。（字串，選用）

Gists

• create_gist - 建立 Gist

  • OAuth Challenge Scopes: 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 Challenge Scopes: gist
  • content: 檔案的內容（字串，必填）
  • description: Gist 的更新描述（字串，選用）
  • filename: 要更新或建立的檔案名稱（字串，必填）
  • gist_id: 要更新的 Gist ID（字串，必填）

Git

• get_repository_tree - 取得儲存庫樹狀結構
  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者（使用者名稱或組織）（字串，必填）
  • path_filter: 可選的路徑前綴，用於篩選樹狀結構結果（例如 'src/' 僅顯示 src 目錄中的檔案）（字串，選用）
  • recursive: 將此參數設為 true 會傳回樹狀結構所引用的物件或子樹。預設為 false（布林值，選用）
  • repo: 儲存庫名稱（字串，必填）
  • tree_sha: 樹狀結構的 SHA1 值或 ref（分支或標籤）名稱。預設為儲存庫的預設分支（字串，選用）

Governance

• create_repository_ruleset - 建立儲存庫規則集

  • OAuth Challenge Scopes: repo, admin:org, admin:enterprise
  • bypass_actors: 可以繞過此規則集中規則的參與者（物件陣列，選用）
  • conditions: 此規則集適用的條件，例如 {"ref_name": {"include": ["refs/heads/main"], "exclude": []}}（物件，選用）
  • enforcement: 規則集的執行層級。'evaluate' 允許管理員在執行規則前進行測試（字串，必填）
  • enterprise: Enterprise 別名。當層級為 'enterprise' 時需要。（字串，選用）
  • level: 規則集設定的層級：
    • 'repository'：單一儲存庫上的規則集（需要 'owner' 和 'repo'）。
    • 'organization'：涵蓋組織中儲存庫的規則集（需要 'org'）。
    • 'enterprise'：涵蓋整個 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 Challenge Scopes: repo, read:org, read:enterprise
  • enterprise: Enterprise 別名。當層級為 'enterprise' 時需要。（字串，選用）
  • level: 管理自訂屬性的層級：
    • 'repository'：指派給儲存庫的自訂屬性值（需要 'owner' 和 'repo'）。
    • 'organization'：組織的自訂屬性定義（結構描述）（需要 'org'）。
    • 'enterprise'：enterprise 的自訂屬性定義（結構描述）（需要 'enterprise'）。（字串，必填）
  • org: 組織名稱。當層級為 'organization' 時需要。（字串，選用）
  • owner: 儲存庫擁有者。當層級為 'repository' 時需要。（字串，選用）
  • repo: 儲存庫名稱。當層級為 'repository' 時需要。（字串，選用）

• custom_properties_write - 設定自訂屬性

  • OAuth 挑戰範圍：repo、admin:org、admin:enterprise
  • enterprise：企業 slug。當 level 為 'enterprise' 時必填。（字串，選填）
  • level：管理自訂屬性的層級：
    • 'repository'：指派給儲存庫的自訂屬性值（需要 'owner' 和 'repo'）。
    • 'organization'：組織的自訂屬性定義（schema）（需要 'org'）。
    • 'enterprise'：企業的自訂屬性定義（schema）（需要 'enterprise'）。（字串，必填）
  • org：組織名稱。當 level 為 'organization' 時必填。（字串，選填）
  • owner：儲存庫擁有者。當 level 為 'repository' 時必填。（字串，選填）
  • properties：要建立或更新的自訂屬性。在儲存庫層級，每個項目指派一個值（'property_name' 和 'value'）；在組織和企業層級，每個項目定義 schema（'property_name' 和 'value_type'，以及選填的定義欄位）。（物件[]，必填）
  • repo：儲存庫名稱。當 level 為 'repository' 時必填。（字串，選填）

• repository_ruleset_read - 讀取儲存庫規則集

  • OAuth 挑戰範圍：repo、read:org、read:enterprise
  • actor_name：用於篩選規則套件的 GitHub 使用者帳號代碼。由 'list_rule_suites' 方法使用。（字串，選填）
  • branch：分支名稱。'get_rules_for_branch' 方法必填。（字串，選填）
  • enterprise：企業 slug。當 level 為 '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：組織名稱。當 level 為 'organization' 時必填。（字串，選填）
  • owner：儲存庫擁有者。當 level 為 'repository' 時必填。（字串，選填）
  • page：分頁的頁碼（最小值 1）（數字，選填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • ref：用於篩選規則套件的 ref（分支、標籤等）名稱。由 'list_rule_suites' 方法使用。（字串，選填）
  • repo：儲存庫名稱。當 level 為 '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' 方法使用。（字串，選填）

Issues

• add_issue_comment - 新增評論至 issue 或 pull request

  • OAuth 挑戰範圍：repo
  • body：評論內容。除非提供 reaction，否則必填。（字串，選填）
  • comment_id：要回應的 issue 或 pull request 評論的數字 ID。用於對評論的反應；省略則對 issue 或 pull request 本身反應。不能與 body 合併使用。（整數，選填）
  • issue_number：要評論或反應的 issue 或 pull request 編號。（數字，必填）
  • owner：儲存庫擁有者（字串，必填）
  • reaction：要新增的表情符號反應。除非提供 body，否則必填。（字串，選填）
  • repo：儲存庫名稱（字串，必填）

• get_label - 從儲存庫取得特定標籤

  • OAuth 挑戰範圍：repo
  • name：標籤名稱。（字串，必填）
  • owner：儲存庫擁有者（使用者名稱或組織名稱）（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• issue_read - 取得 issue 詳細資料

  • OAuth 挑戰範圍：repo
  • issue_number：issue 的編號（數字，必填）
  • method：對單一 issue 執行的讀取操作。 選項有：
    1. get - 取得 issue 詳細資料。也會傳回盡力而為的階層旗標（has_parent、has_children）；parent 和 sub_issues_summary 是選填的關係摘要，closed_by_pull_requests 摘要列出設定為關閉該 issue 的 pull requests，作為 total_count 加上最多 5 個 references。
    2. get_comments - 取得 issue 評論。
    3. get_sub_issues - 取得 issue 的子 issue（子項目）。
    4. get_parent - 如果此 issue 是另一個 issue 的子 issue，取得父 issue。
    5. get_labels - 取得指派給該 issue 的標籤。 （字串，必填）
  • owner：儲存庫的擁有者（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • repo：儲存庫的名稱（字串，必填）

• issue_write - 建立或更新 issue/pull request

  • OAuth 挑戰範圍：repo
  • MCP 應用程式 UI：ui://github-mcp-server/issue-write
  • assignees：要指派給此 issue 的使用者名稱（字串[]，選填）
  • body：issue 內文內容（字串，選填）
  • duplicate_of：此 issue 重複的 issue 編號。當 state_reason 為 'duplicate' 時必填。（數字，選填）
  • issue_fields：要設定或清除的 issue 欄位值。每個項目需要 'field_name' 和 'value'、'field_option_name' 或 'delete: true' 其中一個。（物件[]，選填）
  • issue_number：要更新的 issue 編號（數字，選填）
  • labels：要套用至此 issue 的標籤（字串[]，選填）
  • method：對單一 issue 執行的寫入操作。 選項有：
    • 'create' - 建立新的 issue。
    • 'update' - 更新現有的 issue。 （字串，必填）
  • milestone：里程碑編號（數字，選填）
  • owner：儲存庫擁有者（字串，必填）
  • parent_issue_number：父 issue 的 issue 編號。僅在 method 為 'create' 時使用，且不能與 issue_fields 合併使用。新 issue 會在相同操作中建立並附加到此父 issue。（數字，選填）
  • parent_owner：父 issue 的儲存庫擁有者。必須與 parent_repo 一起提供。兩者都省略則使用 owner 和 repo。僅在 method 為 'create' 且提供 parent_issue_number 時使用。（字串，選填）
  • parent_repo：父 issue 的儲存庫名稱。必須與 parent_owner 一起提供。兩者都省略則使用 owner 和 repo。僅在 method 為 'create' 且提供 parent_issue_number 時使用。（字串，選填）
  • repo：儲存庫名稱（字串，必填）
  • state：新狀態（字串，選填）
  • state_reason：狀態變更的原因。除非狀態有變更，否則忽略。（字串，選填）
  • title：issue 標題（字串，選填）
  • type：此 issue 的類型。對於更新，傳遞 null 以移除目前的類型。僅在此儲存庫啟用 issue 類型時使用。使用 list_issue_types 取得此儲存庫或其擁有者組織的有效類型值。如果儲存庫不支援 issue 類型，請省略此參數。（字串 | null，選填）

• list_issue_fields - 列出 issue 欄位

  • OAuth 挑戰範圍：repo、read:org
  • owner：儲存庫或組織的帳號擁有者。名稱不區分大小寫。（字串，必填）
  • repo：儲存庫的名稱。提供時，傳回此特定儲存庫的欄位（從其組織繼承）。省略時，直接傳回組織層級的欄位。（字串，選填）

• list_issue_types - 列出可用的 issue 類型

  • OAuth 挑戰範圍：repo、read:org
  • owner：儲存庫或組織的帳號擁有者。（字串，必填）
  • repo：儲存庫的名稱。提供時，傳回此特定儲存庫的 issue 類型。省略時，直接傳回組織層級的 issue 類型。（字串，選填）

• list_issues - 列出 issues

  • OAuth 挑戰範圍：repo
  • after：分頁的游標。使用前一個回應的游標。（字串，選填）
  • direction：排序方向。如果提供，也需要提供 'orderBy'。（字串，選填）
  • field_filters：依自訂 issue 欄位值篩選。每個條目包含 field_name 和 value；伺服器會查詢欄位並將值轉換為其類型（單選選項名稱、文字、數字或 YYYY-MM-DD 日期）。（物件[]，選填）
  • fields：每個 issue 要傳回的欄位子集。如果省略，傳回所有欄位。當您只需要特定欄位時，使用此選項以減少回應大小；特別省略 'body' 和 'field_values' 會移除每個結果中最大的資料。（字串[]，選填）
  • labels：依標籤篩選（字串[]，選填）
  • orderBy：依欄位排序 issues。如果提供，也需要提供 'direction'。（字串，選填）
  • owner：儲存庫擁有者（字串，必填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • repo：儲存庫名稱（字串，必填）
  • since：依日期篩選（ISO 8601 時間戳記）（字串，選填）
  • state：依狀態篩選，未提供時預設傳回開啟和關閉的 issues（字串，選填）

• search_issues - 搜尋議題

  • OAuth Challenge Scopes：repo
  • fields：每個議題結果要回傳的欄位子集。若省略，則回傳所有欄位。當你只需要特定欄位時，可用此選項來減少回應大小；特別是在省略 'body'、'reactions' 和 'labels' 時，可大幅減少每個結果的資料量。（string[]，選用）
  • order：排序方式（string，選用）
  • owner：選用的儲存庫擁有者。若與 repo 一起提供，則只列出此儲存庫的議題。（string，選用）
  • page：分頁的頁碼（最小值 1）（number，選用）
  • perPage：分頁時每頁的結果數（最小值 1，最大值 100）（number，選用）
  • query：搜尋查詢，以自然語言表示。當使用者提供不同的措辭時，請將它們作為一般詞彙包含在內，而不是用 OR 連接。（string，必填）
  • repo：選用的儲存庫名稱。若與 owner 一起提供，則只列出此儲存庫的議題。（string，選用）
  • sort：依類別相符數量的排序欄位，預設為最佳相符（string，選用）

• sub_issue_write - 變更子議題

  • OAuth Challenge Scopes：repo
  • after_id：要優先排序在其後的子議題 ID（需指定 after_id 或 before_id 其中一個）（number，選用）
  • before_id：要優先排序在其前的子議題 ID（需指定 after_id 或 before_id 其中一個）（number，選用）
  • issue_number：父議題的編號（number，必填）
  • method：對單一子議題執行的動作 選項有：
    • 'add' - 在 GitHub 儲存庫中，將子議題新增至父議題。
    • 'remove' - 在 GitHub 儲存庫中，從父議題移除子議題。
    • 'reprioritize' - 在 GitHub 儲存庫中，變更父議題內子議題的順序。使用 'after_id' 或 'before_id' 來指定新位置。 寫入議題階層。若要將子議題移至新的父議題，請使用 add 搭配 replace_parent=true；沒有可寫入的父欄位。 （string，必填）
  • owner：儲存庫擁有者（string，必填）
  • replace_parent：若為 true，則取代子議題目前的父議題。僅可與 'add' 方法一起使用。（boolean，選用）
  • repo：儲存庫名稱（string，必填）
  • sub_issue_id：要新增的子議題 ID。此 ID 與議題編號不同（number，必填）

• update_issue_comment - 更新議題留言

  • OAuth Challenge Scopes：repo
  • body：新的留言內容（string，必填）
  • comment_id：要更新的議題或提取請求對話留言的數值 ID。請勿使用提取請求審查留言 ID。（integer，必填）
  • owner：儲存庫擁有者（string，必填）
  • repo：儲存庫名稱（string，必填）

標籤

• get_label - 從儲存庫取得特定標籤

  • OAuth Challenge Scopes：repo
  • name：標籤名稱。（string，必填）
  • owner：儲存庫擁有者（使用者名稱或組織名稱）（string，必填）
  • repo：儲存庫名稱（string，必填）

• label_write - 儲存庫標籤的寫入操作

  • OAuth Challenge Scopes：repo
  • color：標籤顏色，為 6 字元的十六進位色碼，不含 '#' 前綴（例如 'f29513'）。'create' 時必填，'update' 時選用。（string，選用）
  • description：標籤描述文字。'create' 和 'update' 時選用。（string，選用）
  • method：要執行的操作：'create'、'update' 或 'delete'（string，必填）
  • name：標籤名稱 - 所有操作皆必填（string，必填）
  • new_name：標籤的新名稱（僅在 'update' 方法中用於重新命名）（string，選用）
  • owner：儲存庫擁有者（使用者名稱或組織名稱）（string，必填）
  • repo：儲存庫名稱（string，必填）

• list_label - 從儲存庫列出標籤

  • OAuth Challenge Scopes：repo
  • after：分頁游標。使用前一個回應中的游標。（string，選用）
  • owner：儲存庫擁有者（使用者名稱或組織名稱）- 所有操作皆必填（string，必填）
  • perPage：分頁時每頁的結果數（最小值 1，最大值 100）（number，選用）
  • repo：儲存庫名稱 - 所有操作皆必填（string，必填）

通知

• dismiss_notification - 關閉通知

  • OAuth Challenge Scopes：notifications
  • state：通知的新狀態（read/done）（string，必填）
  • threadID：通知執行緒的 ID（string，必填）

• get_notification_details - 取得通知詳細資料

  • OAuth Challenge Scopes：notifications
  • notificationID：通知的 ID（string，必填）

• list_notifications - 列出通知

  • OAuth Challenge Scopes：notifications
  • before：僅顯示在指定時間（ISO 8601 格式）之前更新的通知（string，選用）
  • filter：篩選通知，除非另有指定，否則使用預設值。已讀通知是指使用者已確認的通知。參與中通知是指使用者直接參與的通知，例如他們留言或建立的議題或提取請求。（string，選用）
  • owner：選用的儲存庫擁有者。若與 repo 一起提供，則只列出此儲存庫的通知。（string，選用）
  • page：分頁的頁碼（最小值 1）（number，選用）
  • perPage：分頁時每頁的結果數（最小值 1，最大值 100）（number，選用）
  • repo：選用的儲存庫名稱。若與 owner 一起提供，則只列出此儲存庫的通知。（string，選用）
  • since：僅顯示在指定時間（ISO 8601 格式）之後更新的通知（string，選用）

• manage_notification_subscription - 管理通知訂閱

  • OAuth Challenge Scopes：notifications
  • action：要執行的動作：ignore、watch 或 delete 通知訂閱。（string，必填）
  • notificationID：通知執行緒的 ID。（string，必填）

• manage_repository_notification_subscription - 管理儲存庫通知訂閱

  • OAuth Challenge Scopes：notifications
  • action：要執行的動作：ignore、watch 或 delete 儲存庫通知訂閱。（string，必填）
  • owner：儲存庫的帳戶擁有者。（string，必填）
  • repo：儲存庫的名稱。（string，必填）

• mark_all_notifications_read - 將所有通知標記為已讀

  • OAuth Challenge Scopes：notifications
  • lastReadAt：描述最後一次檢查通知的時間點（選用）。預設：現在（string，選用）
  • owner：選用的儲存庫擁有者。若與 repo 一起提供，則只將此儲存庫的通知標記為已讀。（string，選用）
  • repo：選用的儲存庫名稱。若與 owner 一起提供，則只將此儲存庫的通知標記為已讀。（string，選用）

組織

• search_orgs - 搜尋組織
  • OAuth Challenge Scopes：read:org
  • order：排序方式（string，選用）
  • page：分頁的頁碼（最小值 1）（number，選用）
  • perPage：分頁時每頁的結果數（最小值 1，最大值 100）（number，選用）
  • query：組織搜尋查詢。範例：'microsoft'、'location:california'、'created:>=2025-01-01'。搜尋會自動限定在 type:org。（string，必填）
  • sort：依類別的排序欄位（string，選用）

專案

• projects_get - 取得 GitHub Projects 資源的詳細資料

  • OAuth Challenge Scopes：read:project
  • field_id：欄位的 ID。'get_project_field' 方法時必填。（number，選用）
  • field_names：取得專案項目時，要包含在回應中的特定欄位名稱清單（例如 ["Status", "Priority"]）。會在伺服器端解析為欄位 ID — 當你只知道人類可讀名稱時，請傳遞此參數而非 'fields'。與 'fields' 互斥 — 請提供其中一個，不要兩者都提供。僅用於 'get_project_item' 方法。（string[]，選用）
  • fields：取得專案項目時，要包含在回應中的特定欄位 ID 清單（例如 ["102589", "985201", "169875"]）。若未提供 'fields' 或 'field_names'，則只會包含標題欄位。與 'field_names' 互斥 — 請提供其中一個，不要兩者都提供。僅用於 'get_project_item' 方法。（string[]，選用）
  • item_id：項目的 ID。'get_project_item' 方法時必填。（number，選用）
  • method：要執行的方法（string，必填）
  • owner：擁有者（使用者或組織登入名稱）。名稱不區分大小寫。（string，選用）
  • owner_type：擁有者類型（user 或 org）。若未提供，將自動偵測。（string，選用）
  • project_number：專案的編號。（number，選用）
  • status_update_id：專案狀態更新的節點 ID。'get_project_status_update' 方法時必填。（string，選用）
  • view_id：專案檢視的節點 ID。'get_project_view' 方法時必填。（string，選用）

• 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：擁有者類型（user 或 org）。若未提供，將自動嘗試兩者。（字串，選用）
  • 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：擁有者類型（user 或 org）。用於 '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：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：依 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 - 取得單一 pull request 的詳細資料

  • OAuth Challenge Scopes: repo
  • after: 用於分頁的游標，僅由 get_review_comments 方法使用。傳入上一頁 PageInfo 的 endCursor 以取得下一頁。(string, optional)
  • method: 指定要從 GitHub 擷取哪些 pull request 資料的動作。 可能的選項：
    1. get - 取得特定 pull request 的詳細資料。
    2. get_diff - 取得 pull request 的 diff。
    3. get_status - 取得 pull request 中 head commit 的合併提交狀態。
    4. get_files - 取得 pull request 中變更的檔案清單。搭配分頁參數以控制回傳結果數量。
    5. get_commits - 取得 pull request 上的 commit 清單。搭配分頁參數以控制回傳結果數量。
    6. get_review_comments - 取得 pull request 上的審查討論串。每個討論串包含在 pull request 審查期間於相同程式碼位置所做的邏輯分組審查評論。回傳討論串中繼資料與評論，其中包含可為 null 的目前與原始行範圍座標（line、start_line、original_line、original_start_line）。當無法取得目前座標時（例如過時評論），會省略目前座標。使用基於游標的分頁（perPage、after）來控制結果。
    7. get_reviews - 取得 pull request 上的審查。當被要求取得審查評論時，請使用 get_review_comments 方法。搭配分頁參數以控制回傳結果數量。
    8. get_comments - 取得 pull request 上的評論。如果使用者沒有特別要求審查評論，請使用此選項。搭配分頁參數以控制回傳結果數量。
    9. get_check_runs - 取得 pull request head commit 的檢查執行。檢查執行是在 PR 上執行的個別 CI/CD 作業與檢查。 (string, required)
  • owner: 儲存庫擁有者 (string, required)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • pullNumber: Pull request 編號 (number, required)
  • repo: 儲存庫名稱 (string, required)

• pull_request_review_write - 對 pull request 審查執行寫入操作（建立、提交、刪除）

  • OAuth Challenge Scopes: repo
  • body: 審查評論文字 (string, optional)
  • commitID: 要審查的 commit 的 SHA (string, optional)
  • event: 要執行的審查動作。(string, optional)
  • method: 要對 pull request 審查執行的寫入操作。(string, required)
  • owner: 儲存庫擁有者 (string, required)
  • pullNumber: Pull request 編號 (number, required)
  • repo: 儲存庫名稱 (string, required)
  • threadId: 審查討論串的節點 ID（例如 PRRT_kwDOxxx）。resolve_thread 和 unresolve_thread 方法需要此參數。使用 pull_request_read 搭配 method get_review_comments 取得討論串 ID。(string, optional)

• search_pull_requests - 搜尋 pull requests

  • OAuth Challenge Scopes: repo
  • fields: 每個 pull request 結果要回傳的欄位子集。如果省略，則回傳所有欄位。當您只需要特定欄位時，使用此選項可減少回應大小；特別是省略 'body'、'reactions' 和 'labels' 可大幅減少每個結果的資料量。(string[], optional)
  • order: 排序順序 (string, optional)
  • owner: 可選的儲存庫擁有者。如果與 repo 一起提供，則僅列出此儲存庫的 pull requests。(string, optional)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • query: 使用 GitHub pull request 搜尋語法的搜尋查詢 (string, required)
  • repo: 可選的儲存庫名稱。如果與 owner 一起提供，則僅列出此儲存庫的 pull requests。(string, optional)
  • sort: 依類別相符數量的排序欄位，預設為最佳相符 (string, optional)

• update_pull_request - 編輯 pull request

  • OAuth Challenge Scopes: repo
  • MCP App UI: ui://github-mcp-server/pr-edit
  • base: 新的基底分支名稱 (string, optional)
  • body: 新的描述 (string, optional)
  • draft: 將 pull request 標記為草稿（true）或準備好進行審查（false）(boolean, optional)
  • maintainer_can_modify: 允許維護者編輯 (boolean, optional)
  • owner: 儲存庫擁有者 (string, required)
  • pullNumber: 要更新的 pull request 編號 (number, required)
  • repo: 儲存庫名稱 (string, required)
  • reviewers: 要請求審查的 GitHub 使用者名稱或 ORG/team-slug 團隊審查者 (string[], optional)
  • state: 新的狀態 (string, optional)
  • title: 新的標題 (string, optional)

• update_pull_request_branch - 更新 pull request 分支

  • OAuth Challenge Scopes: repo
  • expectedHeadSha: pull request HEAD 參照的預期 SHA (string, optional)
  • owner: 儲存庫擁有者 (string, required)
  • pullNumber: Pull request 編號 (number, required)
  • repo: 儲存庫名稱 (string, required)

儲存庫

• create_branch - 建立分支

  • OAuth Challenge Scopes: repo
  • branch: 新分支的名稱 (string, required)
  • from_branch: 來源分支（預設為儲存庫預設分支）(string, optional)
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)

• create_or_update_file - 建立或更新檔案

  • OAuth Challenge Scopes: repo, workflow
  • allow_symlink_write: 設為 true 以更新符號連結本身；內容必須是其新的目標路徑。(boolean, optional)
  • branch: 要在其中建立/更新檔案的分支 (string, required)
  • content: 檔案內容，必須與寫入後的內容完全一致。請勿進行 base64 編碼；此伺服器會在呼叫 REST API 前執行此操作。(string, required)
  • message: 提交訊息 (string, required)
  • owner: 儲存庫擁有者（使用者名稱或組織）(string, required)
  • path: 要建立/更新檔案的路徑 (string, required)
  • repo: 儲存庫名稱 (string, required)
  • sha: 要取代的檔案的 blob SHA。如果檔案已存在，則為必填。使用 get_file_contents 搭配相同的 owner、repo 和 path，並將 ref 設為此工具的 branch 值來取得。(string, optional)

• create_repository - 建立儲存庫

  • OAuth Challenge Scopes: repo
  • autoInit: 使用 README 初始化 (boolean, optional)
  • description: 儲存庫描述 (string, optional)
  • name: 儲存庫名稱 (string, required)
  • organization: 要在其中建立儲存庫的組織（省略則在您的個人帳戶中建立）(string, optional)
  • private: 儲存庫是否應為私人。省略時預設為 true（私人）。(boolean, optional)

• delete_file - 刪除檔案

  • OAuth Challenge Scopes: repo, workflow
  • branch: 要從中刪除檔案的分支 (string, required)
  • message: 提交訊息 (string, required)
  • owner: 儲存庫擁有者（使用者名稱或組織）(string, required)
  • path: 要刪除的檔案路徑 (string, required)
  • repo: 儲存庫名稱 (string, required)

• delete_repository - 刪除儲存庫

  • OAuth Challenge Scopes: delete_repo, repo
  • owner: 儲存庫擁有者（使用者名稱或組織）(string, required)
  • repo: 儲存庫名稱 (string, required)

• fork_repository - 複製儲存庫

  • OAuth Challenge Scopes: repo
  • organization: 要複製到的組織 (string, optional)
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)

• get_commit - 取得 commit 詳細資料

  • OAuth Challenge Scopes: repo
  • detail: 要包含的變更檔案詳細程度。"none" 完全省略統計資料和檔案。"stats"（預設）包含每個檔案的中繼資料：檔名、狀態和程式碼行數統計（新增、刪除、變更），不含修補程式內容。"full_patch" 另外包含每個檔案的統一 diff 內容，且可能非常龐大。(string, optional)
  • owner: 儲存庫擁有者 (string, required)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • repo: 儲存庫名稱 (string, required)
  • sha: Commit SHA、分支名稱或標籤名稱 (string, required)

• get_file_contents - 取得檔案或目錄內容

  • OAuth Challenge Scopes: repo
  • fields: 當路徑為目錄時，每個條目要回傳的欄位子集。如果省略，則回傳所有欄位。當路徑為單一檔案時忽略。當列出目錄且您只需要特定欄位（例如僅 'name' 和 'type'）時，使用此選項可減少回應大小。(string[], optional)
  • owner: 儲存庫擁有者（使用者名稱或組織）(string, required)
  • path: 檔案/目錄路徑 (string, optional)
  • ref: 接受可選的 git 參照，例如 refs/tags/{tag}、refs/heads/{branch} 或 refs/pull/{pr_number}/head (string, optional)
  • repo: 儲存庫名稱 (string, required)
  • sha: 接受可選的 commit SHA。如果指定，將使用它而不是 ref (string, optional)

• get_latest_release - 取得最新版本

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)

• get_release_by_tag - 依標籤名稱取得版本

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)
  • tag: 標籤名稱（例如 'v1.0.0'）(string, required)

• get_tag - 取得標籤詳細資料

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)
  • tag: 標籤名稱 (string, required)

• list_branches - 列出分支

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • repo: 儲存庫名稱 (string, required)

• list_commits - 列出提交

  • OAuth Challenge Scopes：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 Challenge Scopes：repo
  • fields：每個發行版本要傳回的欄位子集。若省略，則傳回所有欄位。當您只需要特定欄位時，可使用此選項來減少回應大小；特別是省略 'body' 可刪除每個發行版本中最大的資料。（字串陣列，選用）
  • owner：儲存庫擁有者（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選用）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選用）
  • repo：儲存庫名稱（字串，必填）

• list_repository_collaborators - 列出儲存庫協作者

  • OAuth Challenge Scopes：repo
  • affiliation：依關聯篩選。可為下列其中之一：'outside'（外部協作者）、'direct'（所有具有權限者，無論組織成員資格）、'all'（所有協作者）。預設值：'all'（字串，選用）
  • owner：儲存庫擁有者（字串，必填）
  • page：分頁的頁碼（預設值 1，最小值 1）（數字，選用）
  • perPage：分頁的每頁結果數（預設值 30，最小值 1，最大值 100）（數字，選用）
  • repo：儲存庫名稱（字串，必填）

• list_tags - 列出標籤

  • OAuth Challenge Scopes：repo
  • owner：儲存庫擁有者（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選用）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選用）
  • repo：儲存庫名稱（字串，必填）

• push_files - 推送檔案至儲存庫

  • OAuth Challenge Scopes：repo、workflow
  • branch：要推送的分支（字串，必填）
  • files：要推送的檔案物件陣列，每個物件包含 path（字串）和 content（字串）（物件陣列，必填）
  • message：提交訊息（字串，必填）
  • owner：儲存庫擁有者（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• search_code - 搜尋程式碼

  • OAuth Challenge Scopes：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 Challenge Scopes：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 Challenge Scopes：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 Challenge Scopes：security_events
  • alertNumber：警示的編號。（數字，必填）
  • owner：儲存庫的擁有者。（字串，必填）
  • repo：儲存庫的名稱。（字串，必填）

• list_secret_scanning_alerts - 列出密碼掃描警示

  • OAuth Challenge Scopes：security_events
  • owner：儲存庫的擁有者。（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選用）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選用）
  • repo：儲存庫的名稱。（字串，必填）
  • resolution：依解決狀態篩選（字串，選用）
  • secret_type：要傳回的密碼類型逗號分隔清單。會傳回所有預設密碼模式。若要傳回通用模式，請在參數中傳入權杖名稱。（字串，選用）
  • state：依狀態篩選（字串，選用）

安全性公告

• get_global_security_advisory - 取得全域安全性公告

  • OAuth Challenge Scopes：security_events
  • ghsaId：GitHub 安全性公告 ID（格式：GHSA-xxxx-xxxx-xxxx）。（字串，必填）

• list_global_security_advisories - 列出全域安全性公告

  • OAuth Challenge Scopes：security_events
  • affects：依受影響的套件或版本篩選公告（例如 "package1,package2@1.0.0"）。（字串，選用）
  • cveId：依 CVE ID 篩選。（字串，選用）
  • cwes：依 Common Weakness Enumeration 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 Challenge Scopes：security_events
  • direction：排序方向。（字串，選用）
  • org：組織登入名稱。（字串，必填）
  • sort：排序欄位。（字串，選用）
  • state：依公告狀態篩選。（字串，選用）

• list_repository_security_advisories - 列出儲存庫安全性公告

  • OAuth Challenge Scopes：security_events
  • direction：排序方向。（字串，選用）
  • owner：儲存庫的擁有者。（字串，必填）
  • repo：儲存庫的名稱。（字串，必填）
  • sort：排序欄位。（字串，選用）
  • state：依公告狀態篩選。（字串，選用）

星星數

• list_starred_repositories - 列出已加星號的儲存庫

  • OAuth Challenge Scopes：repo
  • direction：結果的排序方向。（字串，選用）
  • page：分頁的頁碼（最小值 1）（數字，選用）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選用）
  • sort：結果的排序方式。可為 'created'（儲存庫被加星號的時間）或 'updated'（儲存庫最後被推送的時間）。（字串，選用）
  • username：要列出已加星號儲存庫的使用者名稱。預設為已驗證的使用者。（字串，選用）

• star_repository - 為儲存庫加星號

  • OAuth Challenge Scopes：repo
  • owner：儲存庫擁有者（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• unstar_repository - 取消儲存庫星號

  • OAuth Challenge Scopes：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：使用者關於需要回答問題的輸入。這是最新的原始未編輯使用者訊息。您應始終保持使用者訊息原樣，絕不修改它。（字串，必填）