Skip to main content
Glama

Extend MCP

Deploy a workflow version

deploy_workflow_version

Deploy the workflow's current draft as a new immutable version (workflows group). Unlike extractor/classifier/splitter publishing there is NO releaseType — workflow versions are integer deploy numbers ("1", "2", ...) with an optional display name referenced at run time. Pass steps to deploy that graph instead of the draft. Deployed versions never change — keep iterating on the draft.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesWorkflow ID (workflow_...).
nameNoDisplay name for this deployed version (max 255 chars).
stepsNoDeploy these steps instead of the current draft. Step graph (max 125 steps), TRIGGER → PARSE first. Every step needs { type, name }; "name" is REQUIRED and is what other steps route to. Route via next, an ARRAY of objects: linear steps (TRIGGER/PARSE/EXTRACT) use next: [{ step: "<target name>" }]; CLASSIFY/SPLIT branch with next: [{ step, classificationId }] (classificationId = a classification id from the config, not its type). TRIGGER routes to exactly one PARSE. Types: TRIGGER, PARSE, EXTRACT, CLASSIFY, SPLIT, MERGE_EXTRACT, CONDITIONAL, CONDITIONAL_EXTRACT, EXTERNAL_DATA_VALIDATION, WEBHOOK_RESPONSE, RULE_VALIDATION, VALIDATION, ROUTER, HUMAN_REVIEW, COLLECT, FILE_CONVERSION. EXTRACT/CLASSIFY/SPLIT need a config with exactly one of a saved ref or inline config (EXTRACT: config.extractor {id,version} or config.extractorConfig with REQUIRED schema; CLASSIFY: config.classifier {id,version} or config.classifierConfig); next is only allowed once config is set. Classifier/splitter refs can't be "latest" — use semver or "draft". The rules here are a summary — before authoring a step graph by hand, call get_documentation with https://docs.extend.ai/workflows/configuring-workflows.md and follow it.
environmentYes"TEST" = the Test (development) environment, "PRODUCTION" = live. Must match a granted target from get_me (an API key pins one environment).
workspaceIdYesTarget workspace (ws_...). Must be a granted workspace — get_me lists the accepted values.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameNo
stepsNo
versionYes
createdAtNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / steps / description
      Previous value: -"Deploy these steps instead of the current draft. Step graph (max 500 steps), TRIGGER → PARSE first. Every step needs { type, name }; \"name\" is REQUIRED and is what other steps route to. Route via next, an ARRAY of objects: linear steps (TRIGGER/PARSE/EXTRACT) use next: [{ step: \"<target name>\" }]; CLASSIFY/SPLIT branch with next: [{ step, classificationId }] (classificationId = a classification id from the config, not its type). TRIGGER routes to exactly one PARSE. Types: TRIGGER, PARSE, EXTRACT, CLASSIFY, SPLIT, MERGE_EXTRACT, CONDITIONAL, CONDITIONAL_EXTRACT, EXTERNAL_DATA_VALIDATION, WEBHOOK_RESPONSE, RULE_VALIDATION, VALIDATION, ROUTER, HUMAN_REVIEW, COLLECT, FILE_CONVERSION. EXTRACT/CLASSIFY/SPLIT need a config with exactly one of a saved ref or inline config (EXTRACT: config.extractor {id,version} or config.extractorConfig with REQUIRED schema; CLASSIFY: config.classifier {id,version} or config.classifierConfig); next is only allowed once config is set. Classifier/splitter refs can't be \"latest\" — use semver or \"draft\". The rules here are a summary — before authoring a step graph by hand, call get_documentation with https://docs.extend.ai/workflows/configuring-workflows.md and follow it."New value: +"Deploy these steps instead of the current draft. Step graph (max 125 steps), TRIGGER → PARSE first. Every step needs { type, name }; \"name\" is REQUIRED and is what other steps route to. Route via next, an ARRAY of objects: linear steps (TRIGGER/PARSE/EXTRACT) use next: [{ step: \"<target name>\" }]; CLASSIFY/SPLIT branch with next: [{ step, classificationId }] (classificationId = a classification id from the config, not its type). TRIGGER routes to exactly one PARSE. Types: TRIGGER, PARSE, EXTRACT, CLASSIFY, SPLIT, MERGE_EXTRACT, CONDITIONAL, CONDITIONAL_EXTRACT, EXTERNAL_DATA_VALIDATION, WEBHOOK_RESPONSE, RULE_VALIDATION, VALIDATION, ROUTER, HUMAN_REVIEW, COLLECT, FILE_CONVERSION. EXTRACT/CLASSIFY/SPLIT need a config with exactly one of a saved ref or inline config (EXTRACT: config.extractor {id,version} or config.extractorConfig with REQUIRED schema; CLASSIFY: config.classifier {id,version} or config.classifierConfig); next is only allowed once config is set. Classifier/splitter refs can't be \"latest\" — use semver or \"draft\". The rules here are a summary — before authoring a step graph by hand, call get_documentation with https://docs.extend.ai/workflows/configuring-workflows.md and follow it."
  2. Changed1 schema field changed
    • changedInput schema / properties / steps / description
      Previous value: -"Deploy these steps instead of the current draft. Step graph (max 100 steps), TRIGGER → PARSE first. Every step needs { type, name }; \"name\" is REQUIRED and is what other steps route to. Route via next, an ARRAY of objects: linear steps (TRIGGER/PARSE/EXTRACT) use next: [{ step: \"<target name>\" }]; CLASSIFY/SPLIT branch with next: [{ step, classificationId }] (classificationId = a classification id from the config, not its type). TRIGGER routes to exactly one PARSE. Types: TRIGGER, PARSE, EXTRACT, CLASSIFY, SPLIT, MERGE_EXTRACT, CONDITIONAL, CONDITIONAL_EXTRACT, EXTERNAL_DATA_VALIDATION, WEBHOOK_RESPONSE, RULE_VALIDATION, VALIDATION, ROUTER, HUMAN_REVIEW, COLLECT, FILE_CONVERSION. EXTRACT/CLASSIFY/SPLIT need a config with exactly one of a saved ref or inline config (EXTRACT: config.extractor {id,version} or config.extractorConfig with REQUIRED schema; CLASSIFY: config.classifier {id,version} or config.classifierConfig); next is only allowed once config is set. Classifier/splitter refs can't be \"latest\" — use semver or \"draft\". The rules here are a summary — before authoring a step graph by hand, call get_documentation with https://docs.extend.ai/workflows/configuring-workflows.md and follow it."New value: +"Deploy these steps instead of the current draft. Step graph (max 500 steps), TRIGGER → PARSE first. Every step needs { type, name }; \"name\" is REQUIRED and is what other steps route to. Route via next, an ARRAY of objects: linear steps (TRIGGER/PARSE/EXTRACT) use next: [{ step: \"<target name>\" }]; CLASSIFY/SPLIT branch with next: [{ step, classificationId }] (classificationId = a classification id from the config, not its type). TRIGGER routes to exactly one PARSE. Types: TRIGGER, PARSE, EXTRACT, CLASSIFY, SPLIT, MERGE_EXTRACT, CONDITIONAL, CONDITIONAL_EXTRACT, EXTERNAL_DATA_VALIDATION, WEBHOOK_RESPONSE, RULE_VALIDATION, VALIDATION, ROUTER, HUMAN_REVIEW, COLLECT, FILE_CONVERSION. EXTRACT/CLASSIFY/SPLIT need a config with exactly one of a saved ref or inline config (EXTRACT: config.extractor {id,version} or config.extractorConfig with REQUIRED schema; CLASSIFY: config.classifier {id,version} or config.classifierConfig); next is only allowed once config is set. Classifier/splitter refs can't be \"latest\" — use semver or \"draft\". The rules here are a summary — before authoring a step graph by hand, call get_documentation with https://docs.extend.ai/workflows/configuring-workflows.md and follow it."
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false and openWorldHint=true. The description goes beyond them by disclosing that deployed versions are immutable and 'never change', that versions are integer deploy numbers with an optional run-time display name, and by steering the agent to author step graphs via get_documentation. It stops short of stating auth/permission or failure behavior, but adds real consequence context.

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?

Purpose is front-loaded in the first clause, and the following sentences each add a distinct fact (no releaseType, integer versions, steps override, immutability). Slightly dense but no filler or repetition.

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 an output schema present, return values need no explanation, and the description covers the versioning model, immutability, the steps override, and defers step-graph authoring detail to documentation. Complete for correct invocation, though it could note environment/permission prerequisites more explicitly.

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 100%, so the schema already documents id, name, steps, environment and workspaceId in depth; the description's parameter content (steps instead of draft, display name referenced at run time) largely echoes it. The 'integer deploy numbers vs releaseType' framing adds a small amount of meaning about the naming model, so it edges to the baseline rather than above it.

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 ('Deploy') and resource ('the workflow's current draft as a new immutable version') and explicitly separates itself from the sibling publish_extractor_version / publish_classifier_version / publish_splitter_version tools by noting there is NO releaseType for workflows. An agent can tell exactly what this does and what it does not do relative to siblings.

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 the condition for using the alternative deployment input ('Pass steps to deploy that graph instead of the draft') and clarifies the equivalent publishing siblings use a different parameter model. It does not spell out when-not to deploy or prerequisite ordering (e.g. must the draft exist?), but the context is clear enough to select the tool.

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