Skip to main content
Glama

Meta Council

by com.meta-council
OverviewDiscussionsAdmin

Plan Workflow

plan_workflow
Read-onlyIdempotent

Preview what a workflow WOULD do, without running it. Costs nothing and runs no models: returns the step execution order, each step's role/model/max_tokens and whether it pauses for a human checkpoint, the workflow's declared parameters (validated if you supply values), which required integrations your account already has credentials on file for, an upper-bound cost estimate, and definition_sha — a fingerprint of the definition this plan was built from, which tells you whether the definition changed between planning and running but never hands back the definition itself. Starts no session and records no usage. Use before run_workflow to check a pipeline fits before spending on it. Requires authentication.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflowYesThe workflow slug (from list_workflows), e.g. 'due_diligence'.
parametersNoOptional values for the workflow's declared parameters, as a flat name-to-value object, e.g. {"region": "EU"}. Supply them to have them validated; omit to skip validation.
step_modelsNoOptional per-run model choices, keyed by zero-based step index (for example {"0": "claude-sonnet-4-6"}). Uses the same catalog validation as run_workflow; send the same choices when starting. Does not change the saved template or grant provider access.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
-  "additionalProperties": false,
-  "properties": {
-    "text": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "text"
-  ],
-  "type": "object"
-}New value: +null
  2. Changed1 schema field changed
    • addedInput schema / properties / step_models
      Added value: +{
+  "additionalProperties": {
+    "type": "string"
+  },
+  "description": "Optional per-run model choices, keyed by zero-based step index (for example {\"0\": \"claude-sonnet-4-6\"}). Uses the same catalog validation as run_workflow; send the same choices when starting. Does not change the saved template or grant provider access.",
+  "type": "object"
+}
  3. Added

TDQS

A4.5/5.0
Behavior5/5

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

The description goes well beyond the annotations (readOnlyHint, idempotentHint, destructiveHint). It adds critical behavioral details: 'Starts no session and records no usage,' 'Costs nothing and runs no models,' 'never hands back the definition itself,' and 'Requires authentication.' These are all extra transparency that helps the agent understand side effects and prerequisites, and none contradict the annotations.

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 longer than average but every sentence adds new information. It is front-loaded with the core purpose and then systematically lists outputs, side effects, and usage. It could be trimmed slightly (e.g., the list of returned items is exhaustive), but it remains structured and readable. The key constraint (cost-free, no models) is prominent, and the usage hint is near the end, which is acceptable.

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?

Given the tool's moderate complexity and lack of an output schema, the description is fairly complete. It enumerates what the tool returns, mentions authentication, notes the fingerprint and its purpose, and clarifies side effects. It does not cover error handling or edge cases, but these are not critical for a preview tool with annotations indicating read-only and idempotent behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% for all three parameters, so the baseline is 3. The description adds value by clarifying the semantics of parameters: it explains that 'parameters' are validated when supplied and that 'step_models' uses the same catalog validation as run_workflow. It also mentions that the plan returns validated parameters, which is not in the schema. This extra context justifies a 4.

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 clearly states a specific action: 'Preview what a workflow WOULD do, without running it.' It identifies the resource (workflow) and distinguishes itself from run_workflow and other workflow-related siblings by emphasizing the non-executing, cost-free nature. The list of returned data (step order, roles, parameters, credentials, cost estimate) makes the purpose unmistakable.

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?

The description explicitly says 'Use before run_workflow to check a pipeline fits before spending on it,' providing a clear when-to-use condition. It also implies when not to use it (when you actually want to execute the workflow) by stating it does not run models. However, it doesn't explicitly mention alternatives like test_workflow_step or retry_workflow, which are related siblings, so it lacks a full exclusion list.

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

All Meta Council toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources