Skip to main content
Glama
MCP Dokploy Online
by igoruam

backup-create

Creates a scheduled database backup in Dokploy by configuring the target database, destination, prefix, and retention settings.

Instructions

POST /backup.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": {
      "schedule": "<schedule>",
      "prefix": "<prefix>",
      "destinationId": "<destinationId>",
      "database": "<database>",
      "databaseType": "<databaseType>"
    },
    "name": "backup-create"
  }
}

Input Schema

NameRequiredDescriptionDefault
prefixYes
userIdNo
enabledNo
mongoIdNo
mysqlIdNo
databaseYes
libsqlIdNo
metadataNo
scheduleYes
composeIdNo
mariadbIdNo
backupTypeNo
postgresIdNo
serviceNameNo
databaseTypeYes
destinationIdYes
keepLatestCountNo
includeEncryptionKeyNo

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 supply only a title and openWorldHint, so the description carries the full disclosure burden. "POST" implies a mutation, but the description says nothing about permissions, whether a destination must exist, what schedule syntax is accepted, or what happens to prior backups when keepLatestCount is set.

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 text is short but not concise in the useful sense: it is under-specified rather than economical. There is no structure, no front-loaded purpose statement, and the one fragment present conveys little beyond the endpoint path.

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 an 18-parameter mutation tool with no output schema, no read-only annotation, and zero schema documentation, the description should explain at minimum schedule format, destination requirements, and the database-id selection rule. It explains none of these, so an agent cannot call it correctly without guessing.

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?

There are 18 parameters with 0% schema description coverage, so the description must supply all parameter meaning and supplies none. Fields like schedule, prefix, keepLatestCount, includeEncryptionKey, and the six mutually exclusive database-id fields (postgresId, mysqlId, mongoId, libsqlId, mariadbId, composeId) are entirely unexplained, and no rules for which combination is valid are given.

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 "POST /backup.create", which restates the tool name and HTTP verb rather than explaining the resource. An agent learns that a backup is created, but nothing about what a backup schedule, prefix, or destination means here, and nothing distinguishes this from the many sibling create tools.

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?

No when-to-use guidance, no prerequisites, and no mention of the numerous manual backup siblings (backup-manualBackupPostgres, backup-manualBackupMongo, etc.) that could be confused with this scheduled-backup creation tool. The entire burden of choosing this tool is left to the caller.

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