Skip to main content
Glama
env0

env0

Official
by env0

Cancel Environment

cancel-environment

Cancel an environment's queued deployment before it starts or awaits approval. No changes are applied; use abort-environment to stop a deployment already running.

Instructions

Cancel an environment's latest deployment while it is still queued or waiting for user approval. No changes are applied. To stop a deployment that is already in progress, use abort-environment instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
environmentIdYesThe ID of the environment to cancel

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral burden, and it does disclose the key effect: 'No changes are applied.' It also scopes the tool to a specific deployment state. It stops short of stating auth requirements, idempotency, or error behavior when no deployment is queued, so it is strong but not exhaustive.

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, front-loaded with the action and precondition, followed by the effect and the routing alternative. Every sentence earns its place with no redundancy.

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 cancel tool with no output schema, the definition covers precondition, effect, and alternative tool. It omits failure/no-op behavior when nothing is queued, a minor gap given the tool's simplicity.

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?

Single required parameter with 100% schema description coverage, so the schema already documents environmentId. The description adds only scope context ('the environment's latest deployment') rather than new parameter syntax, which is appropriate at this coverage level.

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 (cancel) and resource (environment's latest deployment) plus the exact precondition (still queued or awaiting user approval). It explicitly names the sibling it is not — abort-environment — so the agent can route without opening either 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 both when-to-use (deployment queued or waiting for user approval) and when-not-to-use (already in progress), and names the alternative tool for the excluded case. Nothing is left to inference.

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