Undeploy API
deployment_undeployUndeploy an environment, disabling it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiId | Yes | ||
| environmentName | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| success | No | ||
| versionNumber | No |
deployment_undeployUndeploy an environment, disabling it.
| Name | Required | Description | Default |
|---|---|---|---|
| apiId | Yes | ||
| environmentName | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| success | No | ||
| versionNumber | No |
Changes observed during successful MCP inspections.
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 carried structurally. The phrase 'disabling it' does add value by implying the environment is deactivated rather than destroyed, but the description never says whether this is reversible, whether prod is protected, or what happens to in-flight traffic.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One short sentence, front-loaded with the verb and object; nothing is padded or repeated from the schema. It is efficient, though the brevity shades into under-specification.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, and annotations cover the destructive profile. Still missing for a prod-capable destructive mutation: prerequisites, reversibility, and how it differs from deployment_rollback.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the description says nothing about either parameter. environmentName's enum (dev/test/prod) is visible in the schema, but the description never warns that undeploying 'prod' is a severe operation, nor does it explain the apiId/environmentName pairing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (undeploy) and resource (an environment), which is clearly distinguishable from api_create, secret_rotate, or endpoint_delete in the sibling list. It does not, however, differentiate itself from the adjacent deployment_rollback or deployment_deploy, so the agent must guess at the relationship between those operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites (must the environment currently be deployed?), and no mention of the obvious alternative deployment_rollback. The agent gets a definition but no routing logic.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.