Skip to main content
Glama
MCP Dokploy Online
by igoruam

volumeBackups-runManually

Idempotent

Triggers a manual backup for the specified volume backup ID, letting you start an on-demand Dokploy volume backup outside scheduled runs.

Instructions

POST /volumeBackups.runManually

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-runManually"
  }
}

Input Schema

NameRequiredDescriptionDefault
volumeBackupIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.1/5.0
Behavior1/5

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

Annotations only supply idempotentHint and openWorldHint; the description carries the remaining burden and supplies nothing about side effects, whether a new backup artifact is created, what happens if a run is already in progress, or permission requirements. The word 'POST' only weakly signals mutation and is effectively part of the name.

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 and front-loaded, but that brevity is under-specification rather than economy; the single line conveys no usable information beyond the tool name.

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 mutating, open-world tool with an undocumented required parameter and no output schema, the definition is completely inadequate. Nothing tells the agent what the call returns or how to interpret success.

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?

The single required parameter volumeBackupId has 0% schema description coverage and the description says nothing about it, not even whether it is the backup definition ID or an existing backup instance ID. This gap is fatal for a one-parameter tool where the parameter is the entire input.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description is just the HTTP route 'POST /volumeBackups.runManually', which restates the tool name and adds no verb-plus-resource statement of what the tool actually does. An agent cannot tell from this text whether it triggers one backup now, queues one, or runs all pending backups.

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 call this instead of siblings such as schedule-runManually or volumeBackups-create, and no exclusion conditions. Nothing indicates whether the volume backup must be in a particular state first.

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