Skip to main content
Glama

Opsphere — DevOps & SRE Intelligence

GHE Workflows: Trigger (workflow_dispatch)

ghe_workflow_dispatch
Destructive

Manually trigger a GitHub Actions workflow that has "on: workflow_dispatch" defined. Accepts workflow ID, name, or file path. Returns confirmation with repo, workflow, and ref. Returns HTTP 422 if the workflow does not support manual dispatch.

Input Schema

NameRequiredDescriptionDefault
refNoBranch or tag to run the workflow on (default: main)main
repoYesRepository name or full owner/name slug. Prefer owner/name when known so routing never depends on a workspace default.
ownerNoOptional GitHub org/user. A full repo slug (owner/name) takes precedence; otherwise the active workspace default org is used.
inputsNoKey-value inputs declared in the workflow (optional)
workflowYesWorkflow ID, name, or path (e.g. deploy.yml)
context_idNoOptional explicit Connection Hub work context (ctx_*). Omit to use the conversation's active workspace; global Hub tools ignore it.

Output Schema

NameRequiredDescriptionDefault
okYes
dataYes
contractVersionYes
dataSchemaVersionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed20 schema fields changed
    • changedOutput schema / properties / data / additionalProperties
      Previous value: -trueNew value: +false
    • removedOutput schema / properties / data / properties / count
      Removed value: -{
      -  "type": "number"
      -}
    • addedOutput schema / properties / data / properties / dispatched
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / data / properties / gaps
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • removedOutput schema / properties / data / properties / issues
      Removed value: -{
      -  "$ref": "#/properties/data/properties/items"
      -}
    • removedOutput schema / properties / data / properties / items
      Removed value: -{
      -  "items": {
      -    "additionalProperties": true,
      -    "properties": {},
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • removedOutput schema / properties / data / properties / maxResults
      Removed value: -{
      -  "type": "number"
      -}
    • removedOutput schema / properties / data / properties / nextPageToken
      Removed value: -{
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedOutput schema / properties / data / properties / partial
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / data / properties / ref
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / data / properties / repository
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / properties / data / properties / results
      Removed value: -{
      -  "$ref": "#/properties/data/properties/items"
      -}
    • removedOutput schema / properties / data / properties / startAt
      Removed value: -{
      -  "type": "number"
      -}
    • removedOutput schema / properties / data / properties / total
      Removed value: -{
      -  "type": "number"
      -}
    • addedOutput schema / properties / data / properties / truncated
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / data / properties / warnings
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / data / properties / workflow
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "integer"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / data / required
      Added value: +[
      +  "repository",
      +  "workflow",
      +  "dispatched",
      +  "partial",
      +  "truncated",
      +  "warnings",
      +  "gaps"
      +]
    • addedOutput schema / properties / dataSchemaVersion
      Added value: +{
      +  "const": 2,
      +  "type": "number"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "contractVersion",
      -  "ok",
      -  "data"
      -]New value: +[
      +  "contractVersion",
      +  "dataSchemaVersion",
      +  "ok",
      +  "data"
      +]
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already flag this as a non-read-only, open-world, destructive operation; the description adds value by disclosing the success response shape (repo, workflow, ref) and the HTTP 422 failure mode for workflows lacking manual dispatch. It stops short of mentioning required token scopes or that dispatching creates a real run consuming the target ref.

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

Conciseness5/5

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

Three short sentences, front-loaded with the action and its precondition, then return values, then the error case. No filler or repetition.

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

Completeness4/5

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

An output schema exists, so the return-description sentence is redundant but harmless, and the description covers the key failure mode and precondition. Given this is a mutating tool with a destructive hint, a brief note on permissions or side effects would round it out.

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 every parameter including inputs, context_id, and owner is already documented. The description's 'workflow ID, name, or file path' restates the schema rather than adding new semantics such as input key validation or ref defaults, so baseline 3 applies.

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?

Names a specific verb and resource ('manually trigger a GitHub Actions workflow') and adds the essential precondition ('on: workflow_dispatch'). The action is clearly distinguishable from read-oriented siblings like ghe_workflow_list and ghe_workflow_runs_list, which only inspect state.

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?

The precondition ('has on: workflow_dispatch defined') implicitly defines when the tool is applicable, and the 422 note warns of the failure case when it isn't. However, it never names alternatives or states explicitly that list/inspect tools should be used first to find a workflow.

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