Github Actions MCP Server

🚀 GitHub Actions MCP 服務器

本項目是基於 GitHub Actions 的 MCP 服務器，它能助力人工智能助手對 GitHub Actions 工作流進行管理與操作，極大提升工作流管理的效率與便捷性。

🚀 快速開始

克隆倉庫並構建：

git clone https://github.com/ko1ynnky/github-actions-mcp-server.git
cd github-actions-mcp-server
npm install
npm run build

這將生成位於 dist 目錄中的必要文件，以運行 MCP 服務器。

✨ 主要特性

• 完整工作流管理：可對工作流進行列舉、查看、觸發、取消和重新運行等操作。
• 工作流運行分析：能夠獲取工作流運行的詳細信息及其作業情況。
• 全面錯誤處理：提供清晰的錯誤消息，並帶有增強細節。
• 靈活類型驗證：具備穩健的類型檢查，能優雅處理 API 變異。
• 安全導向設計：包含超時處理、速率限制和嚴格 URL 驗證等安全機制。

📚 詳細文檔

工具列表

1. list_workflows

   • 功能：列舉倉庫中的工作流。
   • 輸入參數：
     • owner (字符串)：倉庫所有者（用戶名或組織）。
     • repo (字符串)：倉庫名稱。
     • page (可選數字)：分頁頁碼。
     • perPage (可選數字)：每頁結果數（最多 100）。
   • 返回值：倉庫中的工作流列表。

2. get_workflows

   • 功能：獲取指定所有者的工作流。
   • 輸入參數：
     • owner (字符串)：倉庫所有者。
   • 返回值：所有者的詳細工作流信息。

3. trigger_workflow

   • 功能：觸發指定的工作流運行。
   • 輸入參數：
     • owner (字符串)：倉庫所有者。
     • repo (字符串)：倉庫名稱。
     • workflow_id (字符串)：工作流 ID。
     • ref (字符串)：代碼引用（分支、標籤或提交哈希）。
     • inputs (對象)：傳遞給工作流的輸入參數。
   • 返回值：觸發運行的狀態信息。

4. get_workflow_run

   • 功能：獲取指定的工作流運行詳細信息。
   • 輸入參數：
     • owner (字符串)：倉庫所有者。
     • repo (字符串)：倉庫名稱。
     • run_id (字符串)：運行 ID。
   • 返回值：運行的詳細信息。

5. list_workflow_runs

   • 功能：列舉指定工作流的所有運行。
   • 輸入參數：
     • owner (字符串)：倉庫所有者。
     • repo (字符串)：倉庫名稱。
     • workflow_id (字符串)：工作流 ID。
   • 返回值：工作流的運行列表。

💻 使用示例

基礎用法

// 列舉工作流
const result = await listWorkflows({
  owner: "your-username",
  repo: "your-repository"
});

// 觸發工作流
const result = await triggerWorkflow({
  owner: "your-username",
  repo: "your-repository", 
  workflowId: "ci.yml",
  ref: "main",
  inputs: {
    environment: "production"
  }
});

配置示例

在 claude_desktop_config.json 中添加：

{
  "mcpServers": {
    "github-actions": {
      "command": "node",
      "args": [
        "<path-to-mcp-server>/dist/index.js"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

📚 使用說明

常見問題

1. 身份驗證錯誤：
   • 確保您的 GitHub 令牌具有正確的權限。
   • 檢查令牌是否正確設置為環境變量。
2. 速率限制：
   • 該服務器實現速率限制以避免觸及 GitHub API 的限制。
   • 如果遇到速率限制錯誤，請降低請求頻率。
3. 類型驗證錯誤：
   • GitHub API 響應可能與預期的架構有所不同。
   • 該服務器實現靈活驗證以處理大多數變體。
   • 如果遇到持續性錯誤，請打開問題報告。

📄 許可證

此 MCP 服務器根據 MIT 許可證發佈。