GitHub Workflow Debugger MCP
GitHub Workflow Debugger MCP
A Multi-Choice Prompt (MCP) utility for diagnosing and fixing GitHub Actions workflow failures using the GitHub API.
Overview
This tool helps users diagnose and fix GitHub Actions workflow failures through a structured decision tree. It uses the GitHub API to fetch workflow run information, analyze failures, and provide actionable solutions.
Features
- Fetch recent failed workflow runs for a repository
- Analyze workflow run jobs and steps
- Identify common failure patterns
- Suggest specific fixes for common issues
- View and update workflow files
Installation
Installing via Smithery
To install githubworkflowmcp for Claude Desktop automatically via Smithery:
Manual Installation
Usage
The GitHub Workflow Debugger MCP is designed to be used with AI assistants that support the Model Context Protocol (MCP). It provides several tools that can be used to diagnose and fix GitHub Actions workflow failures.
Required Permissions
To use this tool, you'll need a GitHub Personal Access Token (PAT) with the following permissions:
repo
- Full control of private repositoriesworkflow
- Update GitHub Action workflows
You must set this token as an environment variable named GITHUB_PERSONAL_ACCESS_TOKEN
.
Configuration
When using this tool with an MCP-compatible client, you can configure it as follows:
Replace <YOUR_TOKEN>
with your GitHub Personal Access Token.
Available Tools
- get-failed-workflow-runs - Fetches recent failed workflow runs for a repository
- get-workflow-run-jobs - Gets jobs for a specific workflow run
- get-workflow-file - Retrieves the content of a workflow file
- update-workflow-file - Updates a workflow file with fixes
- analyze-workflow-failure - Analyzes a failed workflow run and suggests fixes
Example Usage
Here's an example of how to use the GitHub Workflow Debugger MCP with an AI assistant:
- First, get recent failed workflow runs:
- Analyze a specific failed run:
- View the workflow file:
- Update the workflow file with fixes:
Development
Prerequisites
- Node.js 16 or higher
- npm or yarn
Setup
Project Structure
src/index.ts
- Main entry point for the MCP serverbuild/
- Compiled JavaScript files
License
ISC
This server cannot be installed
A utility that helps diagnose and fix GitHub Actions workflow failures by analyzing run logs, identifying common failure patterns, and suggesting specific fixes through a structured decision tree.