Skip to main content
Glama
MCP Dokploy Online
by igoruam

volumeBackups-one

Read-onlyIdempotent

Retrieve a single volume backup by its ID from your Dokploy instance to inspect its details and status.

Instructions

GET /volumeBackups.one

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": {
      "volumeBackupId": "<volumeBackupId>"
    },
    "name": "volumeBackups-one"
  }
}

Input Schema

NameRequiredDescriptionDefault
volumeBackupIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.8/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. The description adds nothing beyond that: it does not say what happens when the ID is unknown, whether the response is a single object, or any auth/scope requirement. With annotations carrying the basics, a low-but-nonzero score is warranted for a description that contributes zero extra context.

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 with no filler, but that brevity comes from under-specification rather than economy. A single bare route string gives the reader nothing to front-load or structure 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?

There is no output schema, yet the description does not describe the returned record or error behavior for a missing ID. For a simple single-entity read the bar is low, but the definition leaves the agent without the essentials it would want before calling.

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% and the sole parameter volumeBackupId is documented nowhere. The description does not explain that the parameter identifies which volume backup to retrieve, nor its format or source. With a low-coverage schema, the description needed to compensate and does not.

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 only the HTTP route 'GET /volumeBackups.one'. The word 'one' weakly signals single-resource retrieval versus the sibling list/create/delete tools, but an agent must infer that it fetches one volume backup by ID from the name and path alone. This largely restates the tool name rather than stating the purpose in its own words.

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 guidance on when to use this tool, no mention of when not to, and no reference to alternatives such as volumeBackups-list or volumeBackups-create. The agent is left to infer everything from naming conventions.

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