Skip to main content
Glama

workflow_test_run

Destructive

Starts one test run of a workflow, either its open draft or a saved version, with the inputs you give. The run performs exactly the steps shown by workflow_get for that workflow and nothing else. Those steps can act on connected systems, for example sending an email or writing to an ERP, so confirm with the user first. A draft test never activates the workflow. Returns the run status, a link to the run and any errors.

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": {
      "workflowId": "<workflowId>",
      "inputs": "<inputs>",
      "idempotencyKey": "<idempotencyKey>"
    },
    "name": "workflow_test_run"
  }
}

Input Schema

NameRequiredDescriptionDefault
inputsYes
versionIdNo
workflowIdYes
idempotencyKeyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint and openWorldHint, but the description earns credit by specifying concrete external side effects (sending an email, writing to an ERP), stating that a draft test never activates the workflow, and describing the return payload (run status, run link, errors). It omits idempotency/retry behavior and whether a test run consumes quota or persists run history.

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

Conciseness4/5

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

Four short sentences, front-loaded with what the tool does, then consequences, then return value. No filler; only the missing sibling contrast keeps it from being exemplary.

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

Completeness3/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 helpfully summarizes the return value, and it covers the safety warning well. Still missing are the idempotencyKey's role, input shape expectations for the nested object, and differentiation from dry_run/execute — gaps that matter for a destructive, open-world tool.

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 0% for 4 parameters, so the description must compensate. It adds meaning for inputs ('with the inputs you give') and implies versionId selects a saved version vs the open draft, but says nothing about workflowId format or the required idempotencyKey — a significant omission for a side-effecting tool with a nested object parameter.

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?

Names a specific verb and resource ('Starts one test run of a workflow') and clarifies it operates on either the open draft or a saved version. It does not, however, name or contrast with the obvious siblings workflow_dry_run and workflow_execute, which is the main ambiguity an agent faces here.

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?

Gives a concrete usage precondition — 'confirm with the user first' because steps act on connected systems — which is genuinely actionable. But it never states when to prefer this over workflow_dry_run (safe preview) or workflow_execute (real run), leaving the core routing decision to 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.