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 助手一起使用的示例：

# 首先，获取近期的失败工作流运行
我需要检查仓库 "username/repo" 中的近期失败工作流运行。

# 分析特定的失败运行
您能分析工作流运行 #123456 并提出修复建议吗？

# 查看工作流文件
显示 .github/workflows/main.yml 中的工作流文件内容。

# 使用修复建议更新工作流文件
使用建议的修复更新工作流文件。

🔧 技术细节

先决条件

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

设置

# 安装依赖项
npm install

# 构建项目
npm run build

项目结构

• src/index.ts - MCP 服务器的主要入口点
• build/ - 编译后的 JavaScript 文件