Skip to main content
Glama

Create workflow version

create_workflow_version

Workflow versioning — add a new version to an EXISTING workflow (by workflow_id) to evolve a workflow you already created. Author the new version's definition against the schema from get_workflow_definition_schema. Like create_workflow, the definition is statically validated BEFORE it is written: error-severity findings mint nothing (valid=false, created=false), and a successful write returns any advisory (warning/info) findings. Pass publish=true to publish this workflow version immediately, or later with publish_workflow. (For a brand-new workflow, use create_workflow.)

Input Schema

NameRequiredDescriptionDefault
publishNoIf true, immediately publish the version this call creates (the common create-then-publish in one step). Defaults to false; omit to leave the version as an unpublished draft.
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.
workflow_idYesThe workflow id to add a version to.

Output Schema

NameRequiredDescriptionDefault
slugNo
validYes
createdYes
versionNo
findingsNo
publishedYes
workflow_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only cover safety/read-write hints; the description adds substantial behavior: static validation before write, error findings produce valid=false/created=false, successful writes surface advisory findings, and the publish flag's effect. This is exactly the kind of transactional detail annotations cannot express.

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?

Front-loads the core action and constraint, then layers validation behavior and alternatives. Dense but every sentence carries routing or behavior information; only the trailing parenthetical is mildly redundant with the opening scope.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a nested-object mutation with an output schema present, the description covers the prerequisite schema fetch, validation outcomes, failure modes, and publishing path. Nothing an agent needs to invoke it correctly is missing.

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 already 100%, so baseline is 3; the description adds real value by explaining the definition must satisfy get_workflow_definition_schema, the pre-write validation contract, and the create-then-publish semantics of publish. It stops short of enumerating each parameter but compensates meaningfully above the schema.

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+resource ('add a new version to an EXISTING workflow') and explicitly scopes it against the sibling create_workflow ('For a brand-new workflow, use create_workflow'). An agent can distinguish it from create_workflow and publish_workflow without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use (evolve an existing workflow), when-not (brand-new workflow → create_workflow), and the in-step alternative for publishing (publish=true vs later publish_workflow). All routing decisions are named.

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