Skip to main content
Glama

test_flow

Run a published flow or subflow synchronously with sample inputs to validate behavior and return its context ID and outputs.

Instructions

Run a published flow or subflow synchronously (foreground) with sample inputs and return its context id and outputs (needs SCRIPTING_ENABLED). [Write]

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "flow_sys_id": "<flow_sys_id>"
    },
    "name": "test_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
asyncNoRun as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.
flow_sys_idYesFlow sys_id to test
test_inputsNoTest input values

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • addedInput schema / properties / async
      Added value: +{
      +  "description": "Run as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.",
      +  "type": "boolean"
      +}
  2. First observedv1.0.2

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=true, and the description's **[Write]** tag plus prerequisite requirement is consistent with them. It usefully discloses that the call returns a context id and outputs and depends on SCRIPTING_ENABLED, but says nothing about what running a test flow affects in the instance or how failures surface, which matters for an open-world non-idempotent operation.

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?

A single front-loaded sentence covering action, mode, return value, prerequisite, and a write marker, with zero filler. Nothing can be trimmed without losing signal.

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?

For a three-parameter, no-output-schema tool, the description states the return values, the execution mode, and the enabling flag, which is most of what an agent needs. The remaining gap is that it does not mention the automatic ~20 second switch to a job or point to get_job, though the schema covers that.

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%, including the async/job behaviour and the get_job polling hint, so the schema carries the parameter burden. The description only adds the notion of 'sample inputs' for test_inputs, which is marginal beyond what the schema states.

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

Purpose4/5

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

The description uses a specific verb ('Run') and resource ('a published flow or subflow'), and adds the execution mode ('synchronously (foreground)') plus the return payload ('context id and outputs'). It does not name a sibling tool to contrast with (e.g. trigger_flow), so differentiation is implied by 'test with sample inputs' rather than stated.

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

Usage Guidelines3/5

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

It implies the when: testing a published flow with sample inputs, and supplies a hard prerequisite ('needs SCRIPTING_ENABLED'). However, it never states when to choose this over trigger_flow or the async path, and offers no exclusions or failure conditions beyond the feature flag.

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

Deploy Server

Other Tools