Skip to main content
Glama

Respond to Workflow Gate

respond_to_workflow_gate
Destructive

Submit a user response to a paused HITL gate in a running workflow. Only relevant when the segment was created with hitl=true. After responding, call wait_for_workflow again to continue monitoring. Requires 'creator' scope.

Input Schema

NameRequiredDescriptionDefault
gate_idYesThe gate_id from the paused_gate payload returned by wait_for_workflow or get_workflow_status
responseYesThe user's chosen response — must be one of the options listed in the gate payload
workflow_run_idYesThe workflow run ID

Output Schema

NameRequiredDescriptionDefault
statusYes
guidanceNoInterpretation or recovery guidance for this result
count_unitNo
page_countNoNumber of objects on this page, not the organization total
count_stateNoUnknown means no count; available does not guarantee freshness. Recount for a current value.
next_actionsNoSuggested next calls using returned IDs and available scopes. Not executed and not user consent.
money_displayNoCurrency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero.
workflow_run_idYes
population_inputNoPopulation input used for the preview; IDs refer to their current saved definitions

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is carried by structured data. The description adds genuinely non-redundant operational context: the creator-scope requirement and the required post-response monitoring call, which tell the agent this mutates run state and must be followed by a wait. It stops short of explaining what 'destructive' means here (e.g., whether a submitted response is final and cannot be revised).

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?

Four short sentences, each carrying distinct load: purpose, applicability condition, follow-up call, and auth requirement. The primary action is front-loaded and there is no filler.

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 return values need no explanation, and the description covers prerequisites, scope, and next steps for a state-mutating tool. The remaining gap is failure-mode guidance: what happens if the response is not one of the offered options or if the gate was already resolved.

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%, and each of the three parameters is documented in-schema, including that gate_id comes from the paused_gate payload and response must match a gate option. The description adds no parameter semantics beyond what the schema already states, so the 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?

States a specific verb and resource: 'Submit a user response to a paused HITL gate in a running workflow.' The gate/response framing and the HITL qualifier distinguish it cleanly from siblings like wait_for_workflow and get_workflow_status, which only observe rather than resolve a gate.

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

Usage Guidelines5/5

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

Gives an explicit precondition ('Only relevant when the segment was created with hitl=true'), the follow-up action ('After responding, call wait_for_workflow again to continue monitoring'), and the authorization requirement ('Requires creator scope'). An agent knows both when to call it and what to do next without inference.

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