Skip to main content
Glama

retire_process_definition

Destructive

Retires a process definition by key so agents can no longer open its published versions, while in-progress instances finish on the version they started with.

Instructions

Aposenta um PROCESSO: todas as versões publicadas da key deixam de poder ser abertas pelos agentes. Instâncias em andamento seguem até o fim na versão com que abriram. Para voltar, publique de novo.

Input Schema

NameRequiredDescriptionDefault
keyYesKey da definição (ex.: "analisar-cadastro-erp")

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.3

TDQS

A4.1/5.0
Behavior5/5

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

Beyond destructiveHint=true and readOnlyHint=false, it discloses the exact blast radius, the treatment of running instances and their version pinning, and reversibility by republishing. These details substantially clarify a destructive operation and are consistent with the annotations.

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?

Three short sentences are front-loaded with the action and then cover in-flight behavior and recovery. There is no filler, and each sentence adds operationally useful information.

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?

For a one-parameter destructive lifecycle tool, the description, schema, and annotations provide enough to invoke it and understand its main consequences. It is not fully complete for tool selection because the relationship to disable_process/enable_process is unexplained and the restoration step only generically says to publish again.

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?

The sole required key parameter is already fully documented by the schema, including its definition-key role, pattern, and example, so the baseline is 3. Saying that all published versions "da key" are affected adds operational scope but no further parameter selection or format semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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, then precisely states that every published version of the key becomes unavailable for agents to open. It does not explicitly distinguish retirement from the sibling disable_process, so it is clear but not fully differentiating.

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?

It supplies practical context: retire a process to block new openings while allowing in-flight instances to finish, and republish to restore availability. However, it gives no explicit when-not guidance or comparison with disable_process/enable_process, and "publique de novo" does not name publish_process_definition.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools