Skip to main content
Glama

Approve an aictrl workflow step

approve_workflow_step
Destructive

Approve or reject the manual quality gate currently pausing a workflow run, bound to the exact expected code revision (and optionally the approval digest of the reviewed outputs). Every decision records an approval receipt that downstream nodes can read; rejection cancels the run. Only the run owner or an organization admin may decide.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoOptional gate-decision audit note.
run_idYesWorkflow run ID returned by start_workflow or list_workflow_runs.
decisionYesExplicit gate decision.
expected_gateNoThe gate being decided, from get_workflow_run requiredAction (afterWave, gateIndex). A decision for a gate the run is no longer paused on is rejected with gate_changed.
expected_digestNoOptional approvalDigest shown by get_workflow_run requiredAction. Binds the decision to the exact upstream outputs reviewed; a stale digest is rejected with digest_mismatch.
organization_idYesAICtrl organization ID returned by list_organizations.
expected_revisionYesExact 40-character Git revision shown by get_workflow_run.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / run_id / description
      Previous value: -"Workflow run ID returned by start_workflow."New value: +"Workflow run ID returned by start_workflow or list_workflow_runs."
  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 declare destructiveHint=true and readOnlyHint=false; the description adds important consequences: every decision records a receipt readable by downstream nodes, rejection cancels the run, and decisions are bound to revision/digest. It does not mention rate limits or auth beyond role, but adds enough beyond annotations.

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?

Two concise sentences; the first front-loads the action and binding constraints, the second covers outcomes and permissions. Every clause earns its place with no redundancy.

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?

Given 7 parameters, nested objects, and no output schema, the description covers the core decision mechanics, outcomes, and permissions. It omits return value details (no output schema) and error codes beyond schema mention, but is largely complete for invocation.

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 coverage is 100%, so the schema fully documents all parameters including nested objects and enums. The description mentions expected_revision and approval digest but does not add syntax or format details beyond the schema, so baseline 3 is appropriate.

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?

The description states a specific verb ('Approve or reject') and resource ('manual quality gate currently pausing a workflow run'), and adds a distinguishing scope: bound to expected code revision and optional approval digest. It is clearly distinct from siblings like cancel_workflow_run or get_workflow_run.

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?

It describes the context of use (a paused manual gate) and authority ('Only the run owner or an organization admin may decide'), and implies the need for expected_revision. However, it does not explicitly name alternatives or when to use reject vs. cancel_workflow_run.

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