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. 在設定中引用 token

   # 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）需要在設定檔中硬編碼 token。

Token 安全最佳實務

• 最小權限範圍：僅授予必要的權限

  • repo - 儲存庫操作
  • read:packages - Docker 映像檔存取
  • read:org - 組織團隊存取

• 分開的 token：為不同的專案/環境使用不同的 PAT

• 定期輪換：定期更新 token

• 絕不提交：將 token 排除在版本控制之外

• 檔案權限：限制包含 token 的設定檔的存取權限

  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：資源的唯一識別碼。這會根據提供的「方法」而有所不同，因此請確保提供正確的 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）（數字，選填）
  • per_page：分頁的每頁結果數（預設：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 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: 發現的編號。(number, required)
  • owner: 儲存庫的擁有者。(string, required)
  • repo: 儲存庫的名稱。(string, required)

程式碼安全

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

  • OAuth Challenge Scopes: security_events
  • alertNumber: 警示的編號。(number, required)
  • owner: 儲存庫的擁有者。(string, required)
  • repo: 儲存庫的名稱。(string, required)

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

  • OAuth Challenge Scopes: security_events
  • owner: 儲存庫的擁有者。(string, required)
  • page: 分頁的頁碼 (最小值 1) (number, optional)
  • perPage: 分頁的每頁結果數 (最小值 1，最大值 100) (number, optional)
  • ref: 您要列出的結果的 Git 參考。(string, optional)
  • repo: 儲存庫的名稱。(string, required)
  • severity: 依嚴重性篩選程式碼掃描警示 (string, optional)
  • state: 依狀態篩選程式碼掃描警示。預設為 open (string, optional)
  • tool_name: 用於程式碼掃描的工具名稱。(string, optional)

內容

• get_me - 取得我的使用者設定檔

  • 無需參數

• get_team_members - 取得團隊成員

  • OAuth Challenge Scopes: read:org
  • org: 包含團隊的組織登入名稱 (擁有者)。(string, required)
  • team_slug: 團隊 slug (string, required)

• get_teams - 取得團隊

  • OAuth Challenge Scopes: read:org
  • user: 要取得團隊的使用者名稱。如果未提供，則使用已驗證的使用者。(string, optional)

Copilot

• assign_copilot_to_issue - 指派 Copilot 到議題

  • OAuth Challenge Scopes: repo
  • base_ref: 代理程式開始工作的 Git 參考 (例如分支)。如果未指定，預設為儲存庫的預設分支 (string, optional)
  • custom_instructions: 可選的自訂指示，用於引導代理程式超越議題內容。使用此欄位提供議題描述中未捕捉到的額外內容、限制或指導 (string, optional)
  • issue_number: 議題編號 (number, required)
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)

• request_copilot_review - 請求 Copilot 審查

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • pullNumber: 拉取請求編號 (number, required)
  • repo: 儲存庫名稱 (string, required)

Copilot 議題意圖

• assign_copilot_to_issue_with_intent - 指派 Copilot 到議題並帶有意圖
  • OAuth Challenge Scopes: repo
  • base_ref: 代理程式開始工作的 Git 參考 (例如分支)。如果未指定，預設為儲存庫的預設分支。當 is_suggestion 為 true 時忽略 (string, optional)
  • confidence: 您對這個選擇的信心程度。'HIGH' 表示明確訊號或明確的使用者請求，'MEDIUM' 表示有合理推論但存在一些模糊性，'LOW' 表示在有限訊號下的最佳猜測。(string, required)
  • custom_instructions: 可選的自訂指示，用於引導代理程式超越議題內容。當 is_suggestion 為 true 時忽略 (string, optional)
  • is_suggestion: 如果為 true，則記錄待處理的 Copilot 指派意圖，而不是啟動代理程式。之後的核准會提供啟動內容；在此情況下，base_ref 和 custom_instructions 會被忽略。(boolean, required)
  • issue_number: 議題編號 (number, required)
  • owner: 儲存庫擁有者 (string, required)
  • rationale: 一句簡潔的句子，說明議題中具體是什麼導致選擇 Copilot。陳述具體訊號 (例如「範圍明確且具有清晰驗收標準的任務」)。(string, required)
  • repo: 儲存庫名稱 (string, required)

Dependabot

• get_dependabot_alert - 取得 Dependabot 警示

  • OAuth Challenge Scopes: security_events
  • alertNumber: 警示的編號。(number, required)
  • owner: 儲存庫的擁有者。(string, required)
  • repo: 儲存庫的名稱。(string, required)

• list_dependabot_alerts - 列出 Dependabot 警示

  • OAuth Challenge Scopes: security_events
  • after: 分頁的游標。使用前一個回應中的游標。(string, optional)
  • owner: 儲存庫的擁有者。(string, required)
  • perPage: 分頁的每頁結果數 (最小值 1，最大值 100) (number, optional)
  • repo: 儲存庫的名稱。(string, required)
  • severity: 依嚴重性篩選 Dependabot 警示 (string, optional)
  • state: 依狀態篩選 Dependabot 警示。預設為 open (string, optional)

討論

• discussion_comment_write - 管理討論留言

  • OAuth Challenge Scopes: repo
  • body: 留言內容 (「add」、「reply」和「update」方法需要) (string, optional)
  • commentNodeID: 討論留言的 Node ID (「reply」、「update」、「delete」、「mark_answer」和「unmark_answer」方法需要)。對於「reply」，這是回覆的頂層留言；GitHub Discussions 僅支援一層巢狀。(string, optional)
  • discussionNumber: 討論編號 (「add」和「reply」方法需要) (number, optional)
  • method: 對討論留言執行的寫入操作。 選項包括：
    • 'add' - 在討論中新增頂層留言。
    • 'reply' - 回覆頂層討論留言 (GitHub Discussions 僅支援一層巢狀)。
    • 'update' - 更新現有的討論留言。
    • 'delete' - 刪除討論留言。
    • 'mark_answer' - 將討論留言標記為答案 (僅限 Q&A)。
    • 'unmark_answer' - 取消將討論留言標記為答案 (僅限 Q&A)。 (string, required)
  • owner: 儲存庫擁有者 (「add」和「reply」方法需要) (string, optional)
  • repo: 儲存庫名稱 (「add」和「reply」方法需要) (string, optional)

• get_discussion - 取得討論

  • OAuth Challenge Scopes: repo
  • discussionNumber: 討論編號 (number, required)
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱 (string, required)

• get_discussion_comments - 取得討論留言

  • OAuth Challenge Scopes: repo
  • after: 分頁的游標。使用前一個回應中的游標。(string, optional)
  • discussionNumber: 討論編號 (number, required)
  • includeReplies: 當為 true 時，每個頂層留言將包含巢狀在其中的回覆 (每個留言最多 100 個回覆，這是 GitHub API 的上限)。預設為 false。(boolean, optional)
  • owner: 儲存庫擁有者 (string, required)
  • perPage: 分頁的每頁結果數 (最小值 1，最大值 100) (number, optional)
  • repo: 儲存庫名稱 (string, required)

• list_discussion_categories - 列出討論類別

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者 (string, required)
  • repo: 儲存庫名稱。如果未提供，將在組織層級查詢討論類別。(string, optional)

• list_discussions - 列出討論

  • OAuth Challenge Scopes: repo
  • after: 分頁的游標。使用前一個回應中的游標。(string, optional)
  • category: 可選的討論類別 ID 篩選。如果提供，只會列出具有此類別的討論。(string, optional)
  • direction: 排序方向。(string, optional)
  • orderBy: 依欄位排序討論。如果提供，也需要提供「direction」。(string, optional)
  • owner: 儲存庫擁有者 (string, required)
  • perPage: 分頁的每頁結果數 (最小值 1，最大值 100) (number, optional)
  • repo: 儲存庫名稱。如果未提供，將在組織層級查詢討論。(string, optional)

Gists

• create_gist - 建立 Gist

  • OAuth Challenge Scopes: gist
  • content: 簡單單一檔案 gist 建立的內容 (string, required)
  • description: gist 的描述 (string, optional)
  • filename: 簡單單一檔案 gist 建立的檔案名稱 (string, required)
  • public: gist 是否為公開 (boolean, optional)

• get_gist - 取得 Gist 內容

  • gist_id: gist 的 ID (string, required)

• list_gists - 列出 Gists

  • page: 分頁的頁碼 (最小值 1) (number, optional)
  • perPage: 分頁的每頁結果數 (最小值 1，最大值 100) (number, optional)
  • since: 僅列出在此時間之後更新的 gists (ISO 8601 時間戳) (string, optional)
  • username: GitHub 使用者名稱 (省略以取得已驗證使用者的 gists) (string, optional)

• update_gist - 更新 Gist

  • OAuth Challenge Scopes: gist
  • content: 檔案的內容 (string, required)
  • description: gist 的更新描述 (string, optional)
  • filename: 要更新或建立的檔案名稱 (string, required)
  • gist_id: 要更新的 gist 的 ID (string, required)

Issues

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

  • OAuth Challenge Scopes: repo
  • body: 評論內容。除非提供 reaction，否則為必填。(string, optional)
  • comment_id: 要回應的 issue 或 pull request 評論的數值 ID。用於對評論加入反應；若省略則對 issue 或 pull request 本身加入反應。不可與 body 同時使用。(integer, optional)
  • issue_number: 要評論或回應的 issue 或 pull request 編號。(number, required)
  • owner: 儲存庫擁有者 (string, required)
  • reaction: 要加入的表情符號反應。除非提供 body，否則為必填。(string, optional)
  • repo: 儲存庫名稱 (string, required)

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

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

• issue_read - 取得 issue 詳細資訊

  • OAuth Challenge Scopes: repo
  • issue_number: issue 的編號 (number, required)
  • 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 的子議題（子項目）。
    4. get_parent - 若此 issue 是另一個 issue 的子議題，取得其父議題。
    5. get_labels - 取得指派給該 issue 的標籤。 (string, required)
  • owner: 儲存庫的擁有者 (string, required)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • repo: 儲存庫的名稱 (string, required)

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

  • OAuth Challenge Scopes: repo
  • assignees: 要指派給此 issue 的使用者名稱 (string[], optional)
  • body: issue 內文內容 (string, optional)
  • duplicate_of: 此 issue 重複的 issue 編號。當 state_reason 為 'duplicate' 時為必填。(number, optional)
  • issue_fields: 要設定或清除的 issue 欄位值。每個項目需要 'field_name' 以及 'value'、'field_option_name' 或 'delete: true' 其中一個。(object[], optional)
  • issue_number: 要更新的 issue 編號 (number, optional)
  • labels: 要套用至此 issue 的標籤 (string[], optional)
  • method: 對單一 issue 執行的寫入操作。 選項有：
    • 'create' - 建立新的 issue。
    • 'update' - 更新現有的 issue。 (string, required)
  • milestone: 里程碑編號 (number, optional)
  • owner: 儲存庫擁有者 (string, required)
  • parent_issue_number: 父議題的 issue 編號。僅在 method 為 'create' 時使用，且不可與 issue_fields 同時使用。新 issue 會在相同操作中建立並附加到此父議題。(number, optional)
  • parent_owner: 父議題的儲存庫擁有者。必須與 parent_repo 一起提供。若兩者皆省略則使用 owner 和 repo。僅在 method 為 'create' 且提供 parent_issue_number 時使用。(string, optional)
  • parent_repo: 父議題的儲存庫名稱。必須與 parent_owner 一起提供。若兩者皆省略則使用 owner 和 repo。僅在 method 為 'create' 且提供 parent_issue_number 時使用。(string, optional)
  • repo: 儲存庫名稱 (string, required)
  • state: 新狀態 (string, optional)
  • state_reason: 狀態變更的原因。除非狀態有變更，否則忽略。(string, optional)
  • title: issue 標題 (string, optional)
  • type: 此 issue 的類型。對於更新，傳入 null 以移除目前的類型。僅在此儲存庫啟用 issue 類型時使用。使用 list_issue_types 取得此儲存庫或其擁有組織的有效類型值。若儲存庫不支援 issue 類型，請省略此參數。(string | null, optional)

• list_issue_fields - 列出 issue 欄位

  • OAuth Challenge Scopes: repo, read:org
  • owner: 儲存庫或組織的帳戶擁有者。名稱不區分大小寫。(string, required)
  • repo: 儲存庫的名稱。提供時，傳回此特定儲存庫的欄位（繼承自其組織）。省略時，直接傳回組織層級的欄位。(string, optional)

• list_issue_types - 列出可用的 issue 類型

  • OAuth Challenge Scopes: repo, read:org
  • owner: 儲存庫或組織的帳戶擁有者。(string, required)
  • repo: 儲存庫的名稱。提供時，傳回此特定儲存庫的 issue 類型。省略時，直接傳回組織層級的 issue 類型。(string, optional)

• list_issues - 列出 issues

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

• search_issues - 搜尋 issues

  • OAuth Challenge Scopes: repo
  • fields: 每個 issue 結果要傳回的欄位子集。若省略，則傳回所有欄位。當您只需要特定欄位時，使用此選項可減少回應大小；特別地，省略 'body'、'reactions' 和 'labels' 會移除每個結果中最大的資料。(string[], optional)
  • order: 排序順序 (string, optional)
  • owner: 選用的儲存庫擁有者。若與 repo 一起提供，僅列出此儲存庫的 issues。(string, optional)
  • page: 分頁的頁碼（最小值 1）(number, optional)
  • perPage: 分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • query: 搜尋查詢，以自然語言表示。當使用者提供替代措辭時，將它們作為純文字詞語包含，而不是用 OR 連接。(string, required)
  • repo: 選用的儲存庫名稱。若與 owner 一起提供，僅列出此儲存庫的 issues。(string, optional)
  • sort: 依類別匹配數量的排序欄位，預設為最佳匹配 (string, optional)

• sub_issue_write - 變更子議題

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

Labels

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

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

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

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

• list_label - 從儲存庫列出標籤

  • OAuth Challenge Scopes: repo
  • owner: 儲存庫擁有者（使用者名稱或組織名稱）- 所有操作皆為必填 (string, required)
  • repo: 儲存庫名稱 - 所有操作皆為必填 (string, required)

Notifications

• get_notification_details - 取得通知詳細資訊

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

• list_notifications - 列出通知

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

• manage_notification_subscription - 管理通知訂閱

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

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

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

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

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

組織

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

專案

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

  • OAuth Challenge Scopes：read:project
  • field_id：欄位的 ID。'get_project_field' 方法需要。（數字，選填）
  • 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' 方法需要。（數字，選填）
  • method：要執行的方法（字串，必填）
  • owner：擁有者（使用者或組織登入名稱）。名稱不區分大小寫。（字串，選填）
  • owner_type：擁有者類型（user 或 org）。若未提供，將自動偵測。（字串，選填）
  • project_number：專案的編號。（數字，選填）
  • status_update_id：專案狀態更新的節點 ID。'get_project_status_update' 方法需要。（字串，選填）
  • view_id：專案檢視的節點 ID。'get_project_view' 方法需要。（字串，選填）

• projects_list - 列出 GitHub Projects 資源

  • OAuth Challenge Scopes：read:project
  • after：來自先前 pageInfo.nextCursor 的向前分頁游標。（字串，選填）
  • before：來自先前 pageInfo.prevCursor 的向後分頁游標（罕見）。（字串，選填）
  • field_names：列出專案項目時要包含的欄位名稱（例如 ["Status", "Priority"]）。會在伺服器端解析為欄位 ID——當您只知道人類可讀的名稱時，請傳遞此參數而非 'fields'。無法解析的名稱會回傳結構化錯誤。與 'fields' 互斥——請僅提供其中一個，不要同時提供。僅用於 'list_project_items' 方法。（string[]，選填）
  • fields：列出專案項目時要包含的欄位 ID（例如 ["102589", "985201"]）。重要：務必提供以取得欄位值。若未提供此參數（且未提供 'field_names'），僅會回傳標題。與 'field_names' 互斥——請僅提供其中一個，不要同時提供。僅用於 'list_project_items' 方法。（string[]，選填）
  • method：要執行的動作（字串，必填）
  • owner：擁有者（使用者或組織登入名稱）。名稱不區分大小寫。（字串，必填）
  • owner_type：擁有者類型（user 或 org）。若未提供，將自動嘗試兩者。（字串，選填）
  • per_page：每頁結果數（最大值 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 Challenge Scopes：project
  • body：狀態更新的內容（markdown）。用於 'create_project_status_update' 方法。（字串，選填）
  • field_name：迭代欄位的名稱（例如 'Sprint'）。'create_iteration_field' 方法需要。（字串，選填）
  • filter：已儲存檢視的篩選條件；更新時省略以保留，或傳遞 null 以清除。（string | 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 個項目。（object[]，選填）
  • iteration_duration：欄位迭代的持續天數（例如每週 7 天，每兩週 14 天）。'create_iteration_field' 方法需要。（數字，選填）
  • iterations：'create_iteration_field' 方法的自訂迭代。僅在需要具有不同持續時間、間隔或特定標題的迭代時設定此參數。否則請省略：GitHub 會自動從 'start_date' 開始建立三個持續 'iteration_duration' 天的迭代，這在大多數情況下是正確的選擇。（object[]，選填）
  • 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。（object，選填）
  • view_id：用於更新或刪除的專案檢視節點 ID；必須屬於 owner/project_number。（字串，選填）
  • visible_field_names：建立時顯示或更新時取代的有序專案欄位名稱；更新時省略以保留，或傳遞 [] 以重設。與 visible_fields 互斥。Roadmap 僅接受 []。（string[]，選填）
  • visible_fields：建立時顯示或更新時取代的有序專案欄位資料庫 ID；更新時省略以保留，或傳遞 [] 以重設。與 visible_field_names 互斥。Roadmap 僅接受 []。（string[]，選填）

Pull Requests

• add_comment_to_pending_review - 在請求者最新的待處理 Pull Request 審查中新增審查評論

  • OAuth Challenge Scopes：repo
  • body：審查評論的文字內容（字串，必填）
  • line：評論所套用的 Pull Request diff 中 blob 的行號。對於多行評論，為範圍的最後一行（數字，選填）
  • owner：儲存庫擁有者（字串，必填）
  • path：需要評論的檔案的相對路徑（字串，必填）
  • pullNumber：Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）
  • side：要評論的 diff 側邊。LEFT 表示先前的狀態，RIGHT 表示新的狀態（字串，選填）
  • startLine：對於多行評論，為評論所套用的範圍的第一行（數字，選填）
  • startSide：對於多行評論，為評論所套用的 diff 起始側邊。LEFT 表示先前的狀態，RIGHT 表示新的狀態（字串，選填）
  • subjectType：評論目標的層級（字串，必填）

• add_reply_to_pull_request_comment - 回覆 Pull Request 評論

  • OAuth Challenge Scopes：repo
  • body：回覆的文字內容。除非提供了 reaction，否則為必填。（字串，選填）
  • commentId：要回覆或回應的 Pull Request 審查評論的數字 ID。請使用 #discussion_r... 錨點中的數字，而非 GraphQL thread node ID（PRRT_...）。（數字，必填）
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：Pull Request 編號。當提供了 body 時為必填。（數字，選填）
  • reaction：要新增的表情符號反應。除非提供了 body，否則為必填。（字串，選填）
  • repo：儲存庫名稱（字串，必填）

• create_pull_request - 開啟新的 Pull Request

  • OAuth Challenge Scopes：repo
  • base：要合併進去的分支（字串，必填）
  • body：PR 描述（字串，選填）
  • draft：建立為草稿 PR（布林值，選填）
  • head：包含變更的分支（字串，必填）
  • maintainer_can_modify：允許維護者編輯（布林值，選填）
  • owner：儲存庫擁有者（字串，必填）
  • repo：儲存庫名稱（字串，必填）
  • reviewers：要請求審查的 GitHub 使用者名稱或 ORG/team-slug 團隊審查者（字串陣列，選填）
  • title：PR 標題（字串，必填）

• list_pull_requests - 列出 Pull Requests

  • OAuth Challenge Scopes：repo
  • base：依基礎分支篩選（字串，選填）
  • direction：排序方向（字串，選填）
  • fields：每個 Pull Request 要回傳的欄位子集。如果省略，則回傳所有欄位。當您只需要特定欄位時，使用此選項可減少回應大小；特別是在省略 'body' 時，可移除每個結果中最大的資料。（字串陣列，選填）
  • head：依 head 使用者/組織和分支篩選（字串，選填）
  • owner：儲存庫擁有者（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • repo：儲存庫名稱（字串，必填）
  • sort：排序依據（字串，選填）
  • state：依狀態篩選（字串，選填）

• merge_pull_request - 合併 Pull Request

  • OAuth Challenge Scopes：repo
  • commit_message：合併提交的額外詳細資訊（字串，選填）
  • commit_title：合併提交的標題（字串，選填）
  • merge_method：合併方法（字串，選填）
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）

• pull_request_read - 取得單一 Pull Request 的詳細資訊

  • OAuth Challenge Scopes：repo
  • after：分頁游標，僅由 get_review_comments 方法使用。傳入上一頁 PageInfo 的 endCursor 以取得下一頁。（字串，選填）
  • method：指定要從 GitHub 取得哪些 Pull Request 資料的動作。 可能的選項：
    1. get - 取得特定 Pull Request 的詳細資訊。
    2. get_diff - 取得 Pull Request 的 diff。
    3. get_status - 取得 Pull Request 中 head 提交的合併提交狀態。
    4. get_files - 取得 Pull Request 中變更的檔案清單。搭配分頁參數使用以控制回傳的結果數量。
    5. get_commits - 取得 Pull Request 上的提交清單。搭配分頁參數使用以控制回傳的結果數量。
    6. get_review_comments - 取得 Pull Request 上的審查討論串。每個討論串包含在 Pull Request 審查期間於相同程式碼位置所做的邏輯分組審查評論。回傳討論串及其相關評論的中繼資料（isResolved、isOutdated、isCollapsed）。使用基於游標的分頁（perPage、after）來控制結果。
    7. get_reviews - 取得 Pull Request 上的審查。當被要求審查評論時，請使用 get_review_comments 方法。搭配分頁參數使用以控制回傳的結果數量。
    8. get_comments - 取得 Pull Request 上的評論。如果使用者沒有特別要求審查評論，請使用此選項。搭配分頁參數使用以控制回傳的結果數量。
    9. get_check_runs - 取得 Pull Request head 提交的檢查執行。檢查執行是在 PR 上執行的個別 CI/CD 作業和檢查。 （字串，必填）
  • owner：儲存庫擁有者（字串，必填）
  • page：分頁的頁碼（最小值 1）（數字，選填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • pullNumber：Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）

• pull_request_review_write - 對 Pull Request 審查的寫入操作（建立、提交、刪除）

  • OAuth Challenge Scopes：repo
  • body：審查評論文字（字串，選填）
  • commitID：要審查的提交 SHA（字串，選填）
  • event：要執行的審查動作。（字串，選填）
  • method：要對 Pull Request 審查執行的寫入操作。（字串，必填）
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）
  • threadId：審查討論串的節點 ID（例如 PRRT_kwDOxxx）。resolve_thread 和 unresolve_thread 方法為必填。從 pull_request_read 使用 get_review_comments 方法取得討論串 ID。（字串，選填）

• search_pull_requests - 搜尋 Pull Requests

  • OAuth Challenge Scopes：repo
  • fields：每個 Pull Request 搜尋結果要回傳的欄位子集。如果省略，則回傳所有欄位。當您只需要特定欄位時，使用此選項可減少回應大小；特別是在省略 'body'、'reactions' 和 'labels' 時，可移除每個結果中最大的資料。（字串陣列，選填）
  • order：排序順序（字串，選填）
  • owner：選填的儲存庫擁有者。如果與 repo 一起提供，則只列出此儲存庫的 Pull Requests。（字串，選填）
  • page：分頁的頁碼（最小值 1）（數字，選填）
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）（數字，選填）
  • query：使用 GitHub Pull Request 搜尋語法的搜尋查詢（字串，必填）
  • repo：選填的儲存庫名稱。如果與 owner 一起提供，則只列出此儲存庫的 Pull Requests。（字串，選填）
  • sort：依類別相符數量的排序欄位，預設為最佳相符（字串，選填）

• update_pull_request - 編輯 Pull Request

  • OAuth Challenge Scopes：repo
  • base：新的基礎分支名稱（字串，選填）
  • body：新的描述（字串，選填）
  • draft：將 Pull Request 標記為草稿（true）或準備好審查（false）（布林值，選填）
  • maintainer_can_modify：允許維護者編輯（布林值，選填）
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：要更新的 Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）
  • reviewers：要請求審查的 GitHub 使用者名稱或 ORG/team-slug 團隊審查者（字串陣列，選填）
  • state：新的狀態（字串，選填）
  • title：新的標題（字串，選填）

• update_pull_request_branch - 更新 Pull Request 分支

  • OAuth Challenge Scopes：repo
  • expectedHeadSha：Pull Request HEAD 參照的預期 SHA（字串，選填）
  • owner：儲存庫擁有者（字串，必填）
  • pullNumber：Pull Request 編號（數字，必填）
  • repo：儲存庫名稱（字串，必填）

Repositories

• create_branch - 建立分支

  • OAuth Challenge Scopes：repo
  • branch：新分支的名稱（字串，必填）
  • from_branch：來源分支（預設為儲存庫預設分支）（字串，選填）
  • owner：儲存庫擁有者（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• create_or_update_file - 建立或更新檔案

  • OAuth Challenge Scopes：repo、workflow
  • allow_symlink_write：設為 true 以更新符號連結本身；內容必須是其新的目標路徑。（布林值，選填）
  • branch：要建立/更新檔案的分支（字串，必填）
  • content：檔案的內容，必須與寫入後的內容完全一致。請勿對其進行 base64 編碼；此伺服器會在呼叫 REST API 之前進行編碼。（字串，必填）
  • message：提交訊息（字串，必填）
  • owner：儲存庫擁有者（使用者名稱或組織）（字串，必填）
  • path：要建立/更新檔案的路徑（字串，必填）
  • repo：儲存庫名稱（字串，必填）
  • sha：要取代的檔案的 blob SHA。如果檔案已存在，則為必填。（字串，選填）

• create_repository - 建立儲存庫

  • OAuth Challenge Scopes：repo
  • autoInit：以 README 初始化（布林值，選填）
  • description：儲存庫描述（字串，選填）
  • name：儲存庫名稱（字串，必填）
  • organization：要在其中建立儲存庫的組織（省略則在您的個人帳戶中建立）（字串，選填）
  • private：儲存庫是否應為私人。省略時預設為 true（私人）。（布林值，選填）

• delete_file - 刪除檔案

  • OAuth Challenge Scopes：repo、workflow
  • branch：要從中刪除檔案的分支（字串，必填）
  • message：提交訊息（字串，必填）
  • owner：儲存庫擁有者（使用者名稱或組織）（字串，必填）
  • path：要刪除的檔案路徑（字串，必填）
  • repo：儲存庫名稱（字串，必填）

• 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 - 取得提交詳細資訊

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

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

  • OAuth Challenge Scopes：repo
  • fields：當路徑為目錄時，每個條目要傳回的欄位子集。如果省略，則傳回所有欄位。當路徑為單一檔案時忽略此參數。在列出目錄且只需要特定欄位（例如僅 'name' 和 'type'）時，使用此參數可減少回應大小。(string[], optional)
  • owner：儲存庫擁有者（使用者名稱或組織）(string, required)
  • path：檔案/目錄的路徑 (string, optional)
  • ref：接受可選的 git refs，例如 refs/tags/{tag}、refs/heads/{branch} 或 refs/pull/{pr_number}/head (string, optional)
  • repo：儲存庫名稱 (string, required)
  • sha：接受可選的提交 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：用於篩選提交的作者使用者名稱或電子郵件地址 (string, optional)
  • fields：每個提交要傳回的欄位子集。如果省略，則傳回所有欄位。在只需要特定欄位（例如僅 'sha' 和 'html_url'）時，使用此參數可減少回應大小。(string[], optional)
  • owner：儲存庫擁有者 (string, required)
  • page：分頁的頁碼（最小值 1）(number, optional)
  • path：僅傳回包含此檔案路徑的提交 (string, optional)
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • repo：儲存庫名稱 (string, required)
  • sha：要列出提交的提交 SHA、分支或標籤名稱。如果未提供，則使用儲存庫的預設分支。如果提供提交 SHA，則會列出直到該 SHA 的提交。(string, optional)
  • since：僅傳回此日期之後的提交（ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ 或 YYYY-MM-DD）(string, optional)
  • until：僅傳回此日期之前的提交（ISO 8601 格式：YYYY-MM-DDTHH:MM:SSZ 或 YYYY-MM-DD）(string, optional)

• list_releases - 列出版本

  • OAuth Challenge Scopes：repo
  • fields：每個版本要傳回的欄位子集。如果省略，則傳回所有欄位。在只需要特定欄位時，使用此參數可減少回應大小；特別是省略 'body' 可刪除每個版本最大的資料。(string[], optional)
  • owner：儲存庫擁有者 (string, required)
  • page：分頁的頁碼（最小值 1）(number, optional)
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • repo：儲存庫名稱 (string, required)

• list_repository_collaborators - 列出儲存庫協作者

  • OAuth Challenge Scopes：repo
  • affiliation：依關係篩選。可以是以下之一：'outside'（外部協作者）、'direct'（所有具有權限者，無論組織成員資格）、'all'（所有協作者）。預設值：'all' (string, optional)
  • owner：儲存庫擁有者 (string, required)
  • page：分頁的頁碼（預設 1，最小值 1）(number, optional)
  • perPage：分頁的每頁結果數（預設 30，最小值 1，最大值 100）(number, optional)
  • repo：儲存庫名稱 (string, required)

• list_tags - 列出標籤

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

• push_files - 推送檔案到儲存庫

  • OAuth Challenge Scopes：repo、workflow
  • branch：要推送到的分支 (string, required)
  • files：要推送的檔案物件陣列，每個物件包含 path (string) 和 content (string) (object[], required)
  • message：提交訊息 (string, required)
  • owner：儲存庫擁有者 (string, required)
  • repo：儲存庫名稱 (string, required)

• search_code - 搜尋程式碼

  • OAuth Challenge Scopes：repo
  • fields：每個程式碼搜尋結果要傳回的欄位子集。如果省略，則傳回所有欄位。在只需要特定欄位時，使用此參數可減少回應大小；特別是省略 'repository' 和 'text_matches' 可刪除每個結果最大的資料。(string[], optional)
  • order：結果的排序順序 (string, optional)
  • page：分頁的頁碼（最小值 1）(number, optional)
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • 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。(string, required)
  • sort：排序欄位（僅 'indexed'）(string, optional)

• search_commits - 搜尋提交

  • OAuth Challenge Scopes：repo
  • order：排序順序 (string, optional)
  • page：分頁的頁碼（最小值 1）(number, optional)
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • 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。(string, required)
  • sort：依作者或提交者日期排序（預設為最佳比對）(string, optional)

• search_repositories - 搜尋儲存庫

  • OAuth Challenge Scopes：repo
  • minimal_output：傳回精簡的儲存庫資訊（預設：true）。當為 false 時，傳回完整的 GitHub API 儲存庫物件。(boolean, optional)
  • order：排序順序 (string, optional)
  • page：分頁的頁碼（最小值 1）(number, optional)
  • perPage：分頁的每頁結果數（最小值 1，最大值 100）(number, optional)
  • query：儲存庫搜尋查詢。範例：'machine learning in:name stars:>1000 language:python'、'topic:react'、'user:facebook'。支援進階搜尋語法以進行精確篩選。(string, required)
  • sort：依欄位排序儲存庫，預設為最佳比對 (string, optional)

密碼保護

• get_secret_scanning_alert - 取得密碼掃描警示

  • OAuth Challenge Scopes：security_events
  • alertNumber：警示的編號。(number, required)
  • owner：儲存庫的擁有者。(string, required)
  • repo：儲存庫的名稱。(string, required)

• list_secret_scanning_alerts - 列出密碼掃描警示

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

安全性公告

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

  • OAuth Challenge Scopes：security_events
  • ghsaId：GitHub 安全性公告 ID（格式：GHSA-xxxx-xxxx-xxxx）。(string, required)

• list_global_security_advisories - 列出全球安全公告

  • OAuth 挑戰範圍：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 挑戰範圍：security_events
  • direction：排序方向。（字串，選用）
  • org：組織登入名稱。（字串，必填）
  • sort：排序欄位。（字串，選用）
  • state：依公告狀態篩選。（字串，選用）

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

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

Stargazers

• 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：儲存庫名稱（字串，必填）

Users

• 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 的功能」、「修正錯誤 Y」等）（字串，必填）
  • title：將建立的拉取請求標題（字串，必填）
  • base_ref：代理開始工作的 Git 參考（例如分支）。若未指定，預設為儲存庫的預設分支（字串，選用）

• 驗證注意事項

  • 細粒度 PAT 不會被傳統 PAT 範圍篩選隱藏，因此即使權杖無法使用這些工具，它們仍可能出現。
  • 對於組織擁有的空間，細粒度 PAT 必須安裝在擁有組織上，並包含 organization_copilot_spaces: read。
  • 如果組織擁有的空間包含以儲存庫為基礎的資源，權杖也必須能存取每個引用的儲存庫，否則該空間可能被視為不存在。

• get_copilot_space - 取得 Copilot 空間

  • owner：空間的擁有者。（字串，必填）
  • name：空間的名稱。（字串，必填）

• list_copilot_spaces - 列出 Copilot 空間

• github_support_docs_search - 擷取與回答 GitHub 產品和支援問題相關的文件。支援主題包括：GitHub Actions 工作流程、驗證、GitHub 支援查詢、拉取請求實務、儲存庫維護、GitHub Pages、GitHub Packages、GitHub Discussions、Copilot Spaces
  • query：使用者關於需要回答問題的輸入。這是最新的未編輯原始使用者訊息。您應始終保持使用者訊息原樣，絕不修改它。（字串，必填）