Skip to main content
Glama

Validate workflow

validate_workflow
Read-onlyIdempotent

Statically check a workflow definition WITHOUT running it — use this to catch authoring mistakes before create_workflow / create_workflow_version. Returns a findings list: JSON/schema shape, per-expression syntax, variable scope (a $var referenced where it isn't in scope), and resolution of referenced api_templates / sub_workflows / schemas / secrets. valid is true when there are no error-severity findings; warnings/info are advisory. Author the definition against get_workflow_definition_schema.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
definitionYesThe workflow definition, as a JSON object. Fetch the exact JSON Schema it must satisfy with get_workflow_definition_schema and author against it (or copy an existing one with the get_*_version tool). The owning service validates it on submit.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
validYes
findingsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

The description clearly states the tool does not execute the workflow, describes the returned findings list, and explains the meaning of valid, warnings, and info. This aligns with and goes beyond the annotations readOnlyHint, idempotentHint, and destructiveHint=false.

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?

The description is dense but each sentence contributes useful information about purpose, usage, and output semantics. The repeated schema-authoring instruction is slightly redundant with the parameter description, but overall it is well-organized and not overly verbose.

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?

It covers validation scope, side-effect-free behavior, and output semantics, and an output schema is present so detailed return-value explanation is unnecessary. It could mention error or failure behavior more explicitly, but the core context is sufficiently complete.

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?

The only parameter, definition, is already fully described in the input schema, including its nested object nature and the instruction to author against get_workflow_definition_schema. The tool description restates this but does not add substantial new parameter-level meaning.

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?

The description states an explicit verb ('Statically check') and resource ('workflow definition'), and clarifies it does NOT run the workflow. It also distinguishes its purpose from create_workflow/create_workflow_version by positioning it as a pre-authoring validation step.

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?

It explicitly says to use this before create_workflow/create_workflow_version and points to get_workflow_definition_schema for authoring. It implies the alternative is running/creation, but does not explicitly enumerate when-not-to-use compared with run_workflow or other tools.

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