Skip to main content
Glama

Publish Workflow

workflow.publish
Destructive

Publish a workflow's draft as a new version and turn it on. This always asks the user first. When the draft has errors nothing is published and the workflow stays as it was: errors say what to fix.

Input Schema

NameRequiredDescriptionDefault
workflowIdYes

Output Schema

NameRequiredDescriptionDefault
nameYes
errorsYesWhy it was not published; fix them with workflow.update
versionNo
isActiveYes
warningsYes
publishedYes
workflowIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

The description adds meaningful behavior beyond the annotations: it always asks the user first, nothing is published when the draft has errors, and the workflow remains unchanged in that failure case. This complements the destructiveHint=true annotation without contradicting it.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three short sentences, front-loaded with the action and outcome, then the confirmation requirement, then the error behavior. There is no wasted text.

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 and annotations already declaring destructive/non-readonly behavior, the description supplies the key operational context: user confirmation and atomic failure on errors. The main remaining gap is that workflowId semantics and sibling alternatives are not addressed.

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

Parameters2/5

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

Schema description coverage is 0% and the sole parameter, workflowId, is never mentioned or explained in the description. The schema does provide a UUID type and pattern, but the description does not compensate for the missing textual parameter documentation.

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 gives a specific verb and resource: publish a workflow's draft as a new version and turn it on. This clearly distinguishes the operation from nearby siblings like workflow.unpublish and workflow.toggle by specifying that it publishes the draft into a new active version.

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

Usage Guidelines3/5

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

The description implies when to use it by saying it publishes a draft, and it notes that errors block publishing. However, it does not explicitly compare this with workflow.toggle, workflow.unpublish, or workflow.update, leaving the agent to infer the alternative routing.

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