Skip to main content
Glama
MCP Dokploy Online
by igoruam

volumeBackups-create

Create a scheduled backup configuration for a Dokploy volume by setting the volume name, cron schedule, destination, retention count, and optional service association.

Instructions

POST /volumeBackups.create

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>"
    },
    "name": "volumeBackups-create"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
prefixYes
appNameNo
enabledNo
mongoIdNo
mysqlIdNo
redisIdNo
turnOffNo
libsqlIdNo
composeIdNo
createdAtNo
mariadbIdNo
postgresIdNo
volumeNameYes
serviceNameNo
serviceTypeNo
applicationIdNo
destinationIdYes
cronExpressionYes
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 only supply a title and openWorldHint=true; there is no readOnly or destructive hint, so the description carries the full burden and provides none. It does not disclose that this is a mutating create, that a cronExpression schedules recurring jobs, that destinationId must reference an existing destination, or any permission requirements.

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 single route string is as short as possible but is under-specification rather than conciseness. Nothing is front-loaded because there is nothing of substance to front-load.

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 20-parameter mutation with polymorphic service-type IDs, a cron schedule, and no output schema, the description is wholly inadequate. An agent cannot determine required input formats, mutual exclusivity of the service-type ID fields, 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 20 parameters, including 5 required ones (name, volumeName, prefix, cronExpression, destinationId), and the description adds no meaning. Semantics of serviceType enum, the service-type ID fields (mongoId, mysqlId, composeId, etc.), keepLatestCount, turnOff, and the cron format are all left undocumented.

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 route string "POST /volumeBackups.create", which restates the tool name rather than explaining the operation. It hints at creating a volume backup via HTTP POST but says nothing about what resource is produced, for which service, or how it differs from siblings like backup-create or volumeBackups-update.

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 prerequisites, and no mention of alternatives such as volumeBackups-runManually or volumeBackups-update. An agent must infer entirely from the name that this schedules or registers a backup rather than triggering one.

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