Skip to main content
Glama

Test Flow

test_flow

Test-run a single component and its downstream graph without starting the flow. Provide input data to verify the flow works before you start it, and get the outputs each component produced.

Instructions

Test-run a single component (and its downstream graph) of a flow without starting the flow. Provide the input data the component should receive; returns the outputs each component produced. The flow does not need to be running. Use this to verify a flow works before start_flow.

Input Schema

NameRequiredDescriptionDefault
idYesThe ID of the flow.
payloadNoWebhook-style payload when testing a trigger component.
input_dataNoInput for the tested component, keyed by its inPort name, e.g. {"in": {"to": "x@example.com"}}.
component_idYesThe component to inject test input into (typically the first action after the trigger, or the trigger itself with `payload`).
timeout_secondsNoHow long to wait for the test to finish.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=false and openWorldHint=true; the description adds useful context that the flow doesn't need to be running and that outputs per component are returned. However, for an open-world test execution it never says whether tested components perform real side effects (emails, store writes) or are sandboxed — the single most important behavioral question here.

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, front-loaded with the action and its scope, then the input expectation, the return shape, and the usage rule. No filler or restated title.

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?

With no output schema, the description compensates by stating that outputs per component are returned, and the multi-component scope is made clear. The remaining gap is side-effect semantics for an open-world execution, which an agent would need before running it on a live flow.

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 every parameter is already documented, including the payload/input_data distinction and the timeout bound. The description's 'Provide the input data the component should receive' only paraphrases the schema, adding no syntax or edge-case guidance.

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 — 'Test-run a single component (and its downstream graph) of a flow' — plus the key scope qualifier 'without starting the flow.' This clearly separates it from start_flow, validate_flow, and trigger_component.

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?

Explicitly says 'Use this to verify a flow works before start_flow,' naming the alternative and the selecting condition, and adds that the flow need not be running. It does not address when to prefer validate_flow or trigger_component instead, which are the closest competing siblings.

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