Skip to main content
Glama
MCP Dokploy Online
by igoruam

deployment-allByType

Read-onlyIdempotent

Retrieve deployment records by resource ID and type—application, compose, server, schedule, preview deployment, backup, or volume backup—to review deployment history or status.

Instructions

GET /deployment.allByType

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": {
      "id": "<id>",
      "type": "<type>"
    },
    "name": "deployment-allByType"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
typeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2/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 by structured data. The description adds nothing beyond that — no mention of aggregation behavior, result shape, ordering, or cost of an unfiltered "all" query.

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?

Five words with no waste, but this is under-specification rather than conciseness. There is no front-loaded purpose sentence to trim around.

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

Completeness2/5

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

For a two-parameter, required-both, enum-bearing read tool with no output schema, an agent needs to know what "id" scopes and what each type yields. The definition supplies neither and also omits sibling differentiation, leaving the tool callable only by guesswork.

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?

Schema description coverage is 0% for both required parameters, so the description must compensate and does not. Only the tool name gestures at the "type" filter; the meaning of "id" (which entity it identifies and its relation to the type enum) is left entirely unstated.

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?

"GET /deployment.allByType" merely restates the tool name as an HTTP method plus route. It does convey a read of deployments grouped by type, but there is no plain-language statement of what the tool actually does or how it differs from deployment-all, deployment-allByCompose, or deployment-allByServer.

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?

No when-to-use guidance at all. The presence of near-identical siblings (deployment-allByCompose, deployment-allByServer, deployment-all) makes selection ambiguous, and the definition offers no condition for choosing this one over them.

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