Skip to main content
Glama

Preview an automation as a conversation

preview_automation
Read-onlyIdempotent

Read a flow the way a customer would experience it: the sequence of messages, buttons and branches. Use it to check a flow you just built BEFORE enabling it, and to explain to the user what the bot will answer.

Input Schema

NameRequiredDescriptionDefault
flowIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered. The description adds value beyond that by describing what the preview surfaces (the simulated message/button/branch sequence), which matters since there is no output schema. No auth or rate-limit detail, but those are minor 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?

Two sentences, zero filler. The core purpose leads, then the usage triggers follow, and the customer-experience framing is front-loaded where an agent will see it first.

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 read-only, single-parameter preview with annotations covering safety and a description covering the returned content, this is nearly complete. It lacks any statement about whether the preview affects the live flow or how large/long the rendered conversation may be, which would only marginally improve it.

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?

One required parameter (flowId) with 0% schema description coverage, so the description carries the burden. It only implies the flow via 'a flow you just built' and adds no format, source, or ID-hint beyond what the name flowId already conveys. Adequate but not compensating for the coverage gap.

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?

States a specific verb (read/preview) and resource (a flow/automation), and clarifies the lens is the customer's experience — 'the sequence of messages, buttons and branches.' This implicitly separates it from get_automation (raw structure) but no sibling is named explicitly, so it lands at clearly-scoped rather than fully differentiated.

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?

Gives two concrete when-to-use triggers: check a flow you just built BEFORE enabling it, and explain to the user what the bot will answer. That is strong contextual guidance. It stops short of 5 because it names no alternative tool or when-not-to-use condition.

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