Skip to main content
Glama
MCP Dokploy Online
by igoruam

volumeBackups-update

Idempotent

Updates an existing volume backup configuration—such as schedule, destination, prefix, and retention—to match current backup requirements.

Instructions

POST /volumeBackups.update

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": {
      "name": "<name>",
      "volumeName": "<volumeName>",
      "prefix": "<prefix>",
      "cronExpression": "<cronExpression>",
      "destinationId": "<destinationId>",
      "volumeBackupId": "<volumeBackupId>"
    },
    "name": "volumeBackups-update"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
prefixYes
appNameNo
enabledNo
mongoIdNo
mysqlIdNo
redisIdNo
turnOffNo
libsqlIdNo
composeIdNo
createdAtNo
mariadbIdNo
postgresIdNo
volumeNameYes
serviceNameNo
serviceTypeNo
applicationIdNo
destinationIdYes
cronExpressionYes
volumeBackupIdYes
keepLatestCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.3/5.0
Behavior1/5

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

Annotations already declare idempotentHint=true and openWorldHint=true, so the description needs to add behavioral context such as what fields actually change, what happens when optional service IDs conflict, or what the response looks like. It adds nothing beyond the endpoint string, leaving mutation semantics and permission requirements entirely undisclosed.

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 shortness here is under-specification rather than conciseness — a bare endpoint string provides no front-loaded statement of purpose or effect. There is no wasted wording, but also no useful content.

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 mutation tool with 21 mostly undocumented parameters, no output schema, and only two annotations, the description is completely inadequate. An agent cannot determine which fields are updatable, how partial updates are handled, or what a successful response contains.

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% across 21 parameters, including six required ones (name, volumeName, prefix, cronExpression, destinationId, volumeBackupId) and a serviceType enum whose selection logic is ambiguous. The description compensates for none of this, providing no field semantics, format hints (e.g. cron syntax), or guidance on mutually exclusive service IDs.

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 'POST /volumeBackups.update', which restates the tool name and HTTP path rather than stating in plain language what is being updated. It implies mutation of a volume backup but gives no description of the resource or effect that distinguishes it from siblings like volumeBackups-create or volumeBackups-runManually.

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 usage guidance at all: no when-to-use, no prerequisites (e.g. that volumeBackupId must reference an existing backup), and no mention of the sibling update-related tools. The agent must infer everything from the name alone.

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