Skip to main content
Glama

environment.suspend

Destructive

Suspend an environment. POST .../environments/{env}/suspend.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "organization_id": "<organization_id>",
      "project_id": "<project_id>",
      "environment_id": "<environment_id>",
      "idempotency_key": "<idempotency_key>",
      "confirm": "<confirm>"
    },
    "name": "environment.suspend"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmYesMust be true to apply this mutation; otherwise the tool returns the request it would send for approval.
project_idYesproject_id (required)
environment_idYesenvironment_id (required)
idempotency_keyYesidempotency_key (required)
organization_idYesorganization_id (required)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. Beyond that the description adds nothing: it does not say whether the suspension is reversible, what happens to running services or connections, whether data is retained, or how the idempotency key behaves on retry.

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?

Two short sentences with the action front-loaded and the endpoint as supporting detail; nothing is wasted. It is terse rather than padded, though the terseness comes at the cost of the missing behavioral detail noted elsewhere.

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

Completeness3/5

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

For a destructive mutation with a confirm gate and an idempotency key, the definition leans entirely on annotations and schema to convey risk, and there is no output schema to worry about. It is minimally sufficient to call correctly but does not tell an agent the consequences of a successful suspend.

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?

Schema description coverage is 100%, so all five required parameters (including the confirm approval gate and idempotency_key) are already documented in the schema. The description's only contribution is the {env} path placeholder, which adds no meaning beyond what the schema states, so baseline 3 applies.

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 names a specific verb and resource ('Suspend an environment') and includes the exact endpoint, which makes it distinguishable from siblings such as environment.resume, environment.delete and environment.get. It stops short of explicitly contrasting with those alternatives, so it is clear but not maximally differentiated.

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

Usage Guidelines2/5

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

There is no guidance on when to suspend versus deleting, resuming, or recreating an environment, and no mention of prerequisites or the confirm-gated approval flow. An agent must infer the appropriate context entirely from the name.

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