Github Workflow Debugger

🚀 GitHub 工作流調試器 MCP

一個藉助 GitHub API 來診斷和修復 GitHub Actions 工作流故障的多選提示（MCP）工具，能幫助用戶高效解決工作流中的問題。

🚀 快速開始

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

✨ 主要特性

• 獲取倉庫的最近失敗工作流運行。
• 分析工作流運行的作業和步驟。
• 識別常見失敗模式。
• 建議常見問題的具體修復方法。
• 查看和更新工作流文件。

📦 安裝指南

通過 Smithery 安裝

要自動通過 Smithery 安裝 githubworkflowmcp 用於 Claude 桌面，可執行以下命令：

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 設計用於支持 Model Context Protocol (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 dev

貢獻指南

請參閱 貢獻指南 瞭解如何為該項目做出貢獻。

📄 許可證

ISC 許可證

文檔

• 安裝：安裝說明
• 使用方法：使用指南
• 開發：開發文檔