Github Workflow Debugger

🚀 GitHub 工作流調試器 MCP

一個藉助 GitHub API，用於診斷和修復 GitHub Actions 工作流故障的多選提示（MCP）實用工具。它能通過結構化決策樹，幫助用戶快速定位並解決工作流中的問題，提升開發效率。

🚀 快速開始

此工具通過結構化的決策樹幫助用戶診斷和修復 GitHub Actions 工作流故障。它利用 GitHub API 獲取工作流運行信息，分析失敗情況，並提供可操作的解決方案。

✨ 主要特性

• 獲取倉庫中的近期失敗工作流運行
• 分析工作流運行的作業和步驟
• 識別常見失敗模式
• 建議常見問題的特定修復
• 查看和更新工作流文件

📦 安裝指南

使用 Smithery 安裝

通過 Smithery 自動安裝 githubworkflowmcp 以供 Claude Desktop 使用：

npx -y @smithery/cli install @Maxteabag/githubworkflowmcp --client claude

手動安裝

# 克隆倉庫
git clone https://github.com/yourusername/github-workflow-debugger-mcp.git
cd github-workflow-debugger-mcp

# 安裝依賴項
npm install

# 構建項目
npm run build

# 本地使用鏈接
npm link

💻 使用示例

基礎用法

GitHub 工作流調試器 MCP 設計用於與支持模型上下文協議（MCP）的 AI 助手一起使用。它提供了多個工具，用於診斷和修復 GitHub Actions 工作流故障。

必要權限

使用此工具時，您需要一個具有以下權限的 GitHub 個人訪問令牌（PAT）：

• repo - 私有倉庫的完全控制
• workflow - 更新 GitHub Action 工作流

必須將此令牌設置為環境變量 GITHUB_PERSONAL_ACCESS_TOKEN。

配置

當與 MCP 兼容客戶端一起使用時，可以按如下方式配置：

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

將 <YOUR_TOKEN> 替換為您自己的 GitHub 個人訪問令牌。

可用工具

1. get-failed-workflow-runs - 獲取倉庫中的近期失敗工作流運行
2. get-workflow-run-jobs - 獲取特定工作流運行的作業
3. get-workflow-file - 檢索工作流文件的內容
4. update-workflow-file - 使用修復更新工作流文件
5. analyze-workflow-failure - 分析失敗的工作流運行並建議修復

示例用法

以下是使用 GitHub 工作流調試器 MCP 與 AI 助手一起使用的示例：

1. 首先，獲取近期的失敗工作流運行：

我需要檢查倉庫 "username/repo" 中的近期失敗工作流運行。

2. 分析特定的失敗運行：

您能分析工作流運行 #123456 並提出修復建議嗎？

3. 查看工作流文件：

顯示 .github/workflows/main.yml 中的工作流文件內容。

4. 使用修復建議更新工作流文件：

使用建議的修復更新工作流文件。

🔧 技術細節

先決條件

• Node.js 16 或更高版本
• npm 或 yarn

設置

# 安裝依賴項
npm install

# 構建項目
npm run build

項目結構

• src/index.ts - MCP 服務器的主要入口點
• build/ - 編譯後的 JavaScript 文件