Skip to main content
Glama

Start a GitHub workflow

gh_actions_dispatch
Destructive

Start a GitHub Actions workflow that has a workflow_dispatch trigger: workflow is its file name (deploy.yml) or id from gh_actions, ref the branch or tag (default the main branch), inputs the workflow's own inputs. It runs whatever the workflow does, deploys included, so check the workflow first.

Input Schema

NameRequiredDescriptionDefault
refNoBranch or tag to run on. Default the main branch.
repoYesowner/name, like shopwhizzy/client-shop (or a GitHub address).
inputsNoThe workflow's own workflow_dispatch inputs.
workflowYesFile name like deploy.yml, or id, from gh_actions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, openWorldHint=true, and idempotentHint=false; the description adds the crucial consequence the annotations cannot express — 'It runs whatever the workflow does, deploys included' — plus the trigger prerequisite. It does not cover permissions/auth (relevant given gh_accounts exists) or whether repeated calls create duplicate runs, keeping it at 4.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense and front-loaded: the trigger constraint and parameter meanings come in one sentence, with the risk warning placed last where it reads as a final caution. The first sentence is somewhat run-on, but no sentence is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description is the only place an agent could learn what a dispatch returns (run id? URL?) and how to follow up — that information is absent, leaving the agent unable to chain into gh_actions or gh_actions_cancel after firing. Parameter and risk coverage are otherwise adequate for a 4-param tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so baseline is 3. The description largely restates the schema for workflow, ref, and inputs, with only marginal added value in pointing to gh_actions as the source of workflow ids; the nested inputs object gets no structural elaboration.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a GitHub Actions workflow') and narrows the scope to workflows with a workflow_dispatch trigger, which is exactly what separates this tool from gh_actions, gh_actions_rerun, and gh_actions_cancel. An agent knows what this does and what class of workflow it applies to without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a real precondition (the workflow must have a workflow_dispatch trigger) and a pre-flight instruction ('check the workflow first'), which is actionable guidance for a risky operation. It stops short of naming an alternative tool or stating outright when not to use it, so it lands just below the top band.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources