Skip to main content
Glama

Workflows preview

workflows_preview
Read-onlyIdempotent

Previews an automation or integration source without delivering messages or applying its proposed changes.

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": {
      "input": "<input>"
    },
    "name": "workflows_preview"
  }
}

Input Schema

NameRequiredDescriptionDefault
inputYes
accountIdsNoOptional account selection; can only narrow this workspace's access.
userStatementNoRequired for launch_brief: the user's request or answer for this launch, in their own words. Otherwise optional: the user's request for this call, treated as an unverified user statement, never permission or verified platform evidence.
idempotencyKeyNoRequired for mutations. Reuse the same key only when retrying the exact same call; a completed outcome is applied once.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / userStatement / description
      Previous value: -"Required for launch_brief: the latest verbatim user request or free-text answer. Otherwise optional user-provided context, treated as an unverified user statement, never permission or verified platform evidence."New value: +"Required for launch_brief: the user's request or answer for this launch, in their own words. Otherwise optional: the user's request for this call, treated as an unverified user statement, never permission or verified platform evidence."
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, destructiveHint=false, and idempotentHint, so the safety profile is covered. The description adds useful specificity about which side effects are withheld (no message delivery, no applied changes), but says nothing about what the preview returns, whether it can error on malformed definitions, or how expensive the call is.

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?

A single front-loaded sentence with no filler; the no-side-effects clause is the right thing to lead with. It is efficient but leaves little room for the routing and return-value detail an agent needs.

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?

The tool takes a required discriminated union plus optional scoping fields and has no output schema, so the description should at least sketch what a preview yields or how to interpret a failed preview. Read-only annotations cover the safety story, but the omission of return-shape guidance leaves a real gap.

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 75%, so the schema carries most parameter meaning. The description's phrase "automation or integration source" loosely gestures at the two operation modes (workflow/source) in the union, but it never names them, and it says nothing about the nested definition, node, timeZone, or accountIds inputs.

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 ("previews") on a specific resource ("an automation or integration source"), so an agent can tell it is a dry-run evaluation rather than a listing or execution. It does not explicitly distinguish itself from the sibling workflows_list, which is the closest alternative.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no prerequisites, and no mention of workflows_list as the alternative for enumerating existing workflows. The phrase "without delivering messages or applying its proposed changes" implies a pre-flight check, but the agent must infer when to reach for it.

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.