🚀 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 许可证

文档

• 安装：安装说明
• 使用方法：使用指南
• 开发：开发文档