Skip to main content
Glama
MCP Dokploy Online
by igoruam

compose-cancelDeployment

Idempotent

Cancels an active deployment for a specified Docker Compose service using its compose ID, stopping the deployment process before completion.

Instructions

POST /compose.cancelDeployment

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": {
      "composeId": "<composeId>"
    },
    "name": "compose-cancelDeployment"
  }
}

Input Schema

NameRequiredDescriptionDefault
composeIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.7/5.0
Behavior2/5

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

The annotations state idempotentHint=true and openWorldHint=true, so the agent already knows repeating the call is safe and that the call interacts with external state. The description adds no behavioral context: it does not describe what happens to a running deployment, whether it is revoked or rolled back, or what permissions are needed. It is silent rather than contradictory.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The text is brief, but that brevity results from under-specification rather than conciseness. It contains a single URL fragment with no front-loaded explanation of intent.

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

Completeness1/5

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

This is a mutating cancel operation with no output schema, an undocumented required parameter, and annotations that do not include a destructive hint. The definition should explain what cancellation does to the deployment and how to identify the target, but it provides none of that.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter composeId has 0% schema description coverage and no description support. The description only implies the target via the tool name, without saying whether composeId is a stack identifier, deployment identifier, or name.

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

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description only restates the endpoint as 'POST /compose.cancelDeployment' and adds nothing beyond the tool name. A reader can infer that it cancels a compose deployment, but the operation's scope is never stated, so it cannot be distinguished from siblings such as compose-killBuild or compose-clearDeployments.

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

Usage Guidelines1/5

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

The definition provides no when-to-use guidance. It does not say when to cancel a deployment rather than kill a build or clear the deployment queue, and it does not mention any prerequisites or conditions for use.

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