Skip to main content
Glama
MCP Dokploy Online
by igoruam

deployment-allByCompose

Read-onlyIdempotent

Retrieves all deployments for a specified Compose application using its compose ID, helping you inspect deployment history and status for that stack.

Instructions

GET /deployment.allByCompose

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": "deployment-allByCompose"
  }
}

Input Schema

NameRequiredDescriptionDefault
composeIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered externally. The description adds nothing beyond the verb 'GET' — no cost of calling it, no pagination or result-set shape, no note that it is unfiltered or scoped only by compose.

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?

It is short, but that brevity is under-specification rather than conciseness — a single route string conveys no usable information. There is no front-loaded purpose statement or structure for an agent to parse.

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?

For a read tool with a required, undocumented identifier parameter, no output schema, and near-identical sibling variants, the description provides none of the distinguishing or behavioral information an agent would need. Calling it correctly requires guessing from the name alone.

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

Parameters1/5

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

Schema description coverage is 0% and the single required parameter 'composeId' is undocumented in the schema. The description does not compensate: it says nothing about the format of composeId, whether it is a compose name, ID, or numeric handle, or what happens when an unknown ID is supplied.

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 is just the HTTP route 'GET /deployment.allByCompose', which restates the tool name rather than explaining what it returns. It implies a lookup of deployments keyed by a compose ID, but never says what a compose is here or how the result differs from siblings like deployment-allByServer or deployment-all.

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?

There is no when-to-use guidance, no exclusions, and no mention of the sibling tools that offer alternative groupings. The only hint is the name-suffix 'allByCompose', which is left for the agent to interpret.

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