Skip to main content
Glama

Unpublish Workflow

workflow.unpublish
DestructiveIdempotent

Unpublish a workflow: it turns off and its scheduled runs are cancelled. The draft and the published versions stay; workflow.publish turns it back on.

Input Schema

NameRequiredDescriptionDefault
workflowIdYes

Output Schema

NameRequiredDescriptionDefault
nameYes
isActiveYes
workflowIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, but the description adds crucial nuance: scheduled runs are cancelled, yet the draft and published versions survive and the action is reversible. That resolves the potentially alarming 'destructive' hint into concrete consequences.

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?

Two tight sentences: the definition and effects come first, then the recovery route. No filler, no restatement of the title, and nothing that could be cut.

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?

An output schema exists, annotations cover the safety and idempotency profile, and the description supplies the one thing structured fields can't convey — that state is preserved and scheduled runs stop. Nothing an agent needs before invoking it is missing.

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?

There is one parameter with 0% schema description coverage, so the description carries the full burden — but it says nothing about workflowId beyond the obvious implication of which workflow is affected, and does not mention the UUID format constraint. Adequate for a single self-evident identifier, but no added value.

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 ('Unpublish a workflow') and immediately defines the operation's effect: it turns off and scheduled runs are cancelled. It also names the counterpart tool workflow.publish, so an agent can distinguish it from siblings like workflow.toggle or workflow.delete.

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?

Clear context for use (turn a workflow off while keeping versions) and an explicit reversal path via 'workflow.publish turns it back on'. No explicit when-not-to-use guidance, and the similar sibling workflow.toggle is not contrasted, so it falls short of a full 5.

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