Skip to main content
Glama

Start workflow run

start_workflow

Start a run of one workflow from an Idea, a planned existing Batch whose Work has not begun, or a new batch plan (name and ordered works, as in create_batch_plan). A workflow that starts at Delivery takes none of them: the run begins on its Start to Delivery connection, and create_delivery, or update_delivery adding a Batch, completes it. With batch, the Batch is planned and the run started in one call, its review step is skipped, and edgeId can name the Batch stage route; a retry while that run is open returns the same run. A Batch run governs that Batch's Work queue until it is ready. The run is pinned to the workflow's current revision and returns its current step. Each instruction body is sent once per run; a document already sent earlier in the run comes back as a uri reference.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
batchNoNew Batch plan to create and start the run from.
edgeIdNoBatch stage route to take when the run starts from a Batch.
ideaIdNoIdea to start the run from.
batchIdNoPlanned Batch to start the run from.
projectIdYesId of the Project.
workflowIdYesId of the Workflow.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only declare it is not read-only and not destructive; the description adds the real behavioral payload: the run is pinned to the workflow's current revision, it returns its current step, a batch start skips the review step, edgeId can name the Batch stage route, retries against an open run return the same run, and a Batch run governs that Batch's Work queue. It even discloses the document dedup rule (re-sent documents return as uri references).

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 purpose and main input branches are front-loaded, and nearly every sentence carries distinct edge-case information. The single dense paragraph packs a lot of conditional clauses together, which slightly hurts scannability but wastes little.

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?

With 6 parameters, nested objects, and no output schema, the description carries the return-value burden and does state what comes back (the current step) along with side effects on the Work queue and revision pinning. Error conditions and the precise shape of the returned step are not covered, which is the main residual gap.

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 description coverage is 100%, so the baseline is 3, but the description adds semantics the schema does not: it explains how the batch object is used (planned and run started in one call, review step skipped) and what edgeId means (the Batch stage route). It does not explain the batch name pattern constraint, leaving that to the referenced create_batch_plan.

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?

States a specific verb and resource (start a run of one workflow) and enumerates the three valid starting points: an Idea, a planned existing Batch whose Work has not begun, or a new batch plan. It also names the contrast case (a workflow that starts at Delivery takes none of them) and the sibling tools that complete that path, so an agent can pick it apart from create_batch_plan and create_delivery.

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 clear selection logic across the mutually exclusive inputs and points to create_delivery/update_delivery for the Delivery-start variant, plus a retry-idempotency note. It stops short of explicitly contrasting with resume_workflow, cancel_workflow, or begin_work, so the when-not-to-use side is left 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.

Resources