From b1709b47cd5c3d61a679168f9c73d3f20c1c8ea8 Mon Sep 17 00:00:00 2001 From: logikonline Date: Sun, 25 Jan 2026 15:41:39 -0500 Subject: [PATCH] docs(api): document new workflow management and artifact tools Add documentation for new MCP tools: trigger_workflow, rerun_workflow, cancel_workflow_run, approve_workflow, list_workflows, get_workflow_file, list_artifacts, get_artifact_download_url, and get_queue_depth. Reorganize tools section into logical categories (Runner, Workflow, Artifact, Release & Package) and add usage examples. --- README.md | 43 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4e17e84..65cf26a 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that e ## Features -- **Query Runners** - List runners, check status, view capabilities (OS, tools, disk space) -- **Monitor Workflows** - List runs, get job details, view logs +- **Query Runners** - List runners, check status, view capabilities, monitor queue depth +- **Manage Workflows** - List, trigger, rerun, cancel, and approve workflow runs +- **View Logs** - Get job logs with automatic error extraction for failed jobs +- **Access Artifacts** - List and download workflow artifacts - **Manage Releases** - List releases, get assets, check download counts - **AI Learning** - Query error patterns, report solutions, help other AIs learn - **AI-Friendly** - Structured JSON responses designed for AI consumption @@ -53,24 +55,55 @@ Ask Claude things like: - "What runners are online?" - "Show me the latest workflow runs for gitcaddy/act_runner" - "Why did run #77 fail?" +- "Rerun the failed jobs in run #77" +- "Cancel run #80" +- "Trigger the build.yml workflow on the main branch" +- "What workflows are available in myorg/myrepo?" +- "Show me the build.yml workflow file" +- "What artifacts were produced by run #77?" +- "What's the queue depth for each runner label?" +- "Approve the workflow run from the fork PR" - "What assets are in the v0.3.6 release?" - "Are there any known solutions for NETSDK1147?" - "Diagnose why job 456 failed" - "What secrets are available for myorg/myrepo?" - "List all NuGet packages for myorg" -- "What global packages are available?" ## Available Tools -### Runner & Workflow Tools +### Runner Tools | Tool | Description | |------|-------------| | `list_runners` | List all runners with status, capabilities, disk space | | `get_runner` | Get detailed runner info by ID | +| `get_queue_depth` | Get waiting jobs per runner label (capacity insight) | + +### Workflow Tools + +| Tool | Description | +|------|-------------| +| `list_workflows` | List available workflow files in a repository | +| `get_workflow_file` | Get the YAML content of a workflow file | | `list_workflow_runs` | List workflow runs for a repository | | `get_workflow_run` | Get run details with all jobs | -| `get_job_logs` | Get logs from a specific job | +| `get_job_logs` | Get logs from a specific job (auto-extracts errors for failed jobs) | +| `trigger_workflow` | Manually trigger a workflow_dispatch workflow with inputs | +| `rerun_workflow` | Rerun a completed workflow or specific failed job | +| `cancel_workflow_run` | Cancel a running workflow and all its jobs | +| `approve_workflow` | Approve a workflow run that requires approval (fork PRs) | + +### Artifact Tools + +| Tool | Description | +|------|-------------| +| `list_artifacts` | List artifacts from a workflow run | +| `get_artifact_download_url` | Get the download URL for a specific artifact | + +### Release & Package Tools + +| Tool | Description | +|------|-------------| | `list_releases` | List releases for a repository | | `get_release` | Get release details with all assets | | `list_secrets` | List secret names and descriptions (not values) for global, org, and repo scopes |