Skip to main content
Glama

coolify_create_database_backup

Create a database backup schedule by setting a cron frequency, with optional immediate execution, S3 storage, retention rules, and alert notifications.

Instructions

[WRITE] Create a database backup schedule (frequency required). Set backup_now=true to also run it immediately.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesUUID of the database
enabledNo
save_s3No
timeoutNo
dump_allNo
frequencyYesCron expression, e.g. 0 2 * * *
backup_nowNoRun the backup immediately as well as scheduling it
s3_storage_uuidNoS3 storage UUID (required with save_s3)
databases_to_backupNo
missing_backup_notification_daysNoAlert after this many days without an execution; 0 disables alerts (Coolify v4.3.23)
database_backup_retention_days_s3No
database_backup_retention_amount_s3No
database_backup_retention_days_locallyNo
database_backup_retention_amount_locallyNo
database_backup_retention_max_storage_s3No
database_backup_retention_max_storage_locallyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed16 schema fields changedv4.1.0
    • addedInput schema / properties / backup_now
      Added value: +{
      +  "description": "Run the backup immediately as well as scheduling it",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / database_backup_retention_amount_locally
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / database_backup_retention_amount_s3
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / database_backup_retention_days_locally
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / database_backup_retention_days_s3
      Added value: +{
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / database_backup_retention_max_storage_locally
      Added value: +{
      +  "minimum": 0,
      +  "type": "number"
      +}
    • addedInput schema / properties / database_backup_retention_max_storage_s3
      Added value: +{
      +  "minimum": 0,
      +  "type": "number"
      +}
    • addedInput schema / properties / databases_to_backup
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedInput schema / properties / dump_all
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / enabled
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / frequency
      Added value: +{
      +  "description": "Cron expression, e.g. 0 2 * * *",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / missing_backup_notification_days
      Added value: +{
      +  "description": "Alert after this many days without an execution; 0 disables alerts (Coolify v4.3.23)",
      +  "maximum": 365,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / s3_storage_uuid
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "S3 storage UUID (required with save_s3)"
      +}
    • addedInput schema / properties / save_s3
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / timeout
      Added value: +{
      +  "maximum": 36000,
      +  "minimum": 60,
      +  "type": "integer"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "uuid"
      -]New value: +[
      +  "uuid",
      +  "frequency"
      +]
  2. First observedv4.0.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations are absent, so the description carries the burden of behavioral disclosure. It does disclose that backup_now=true triggers an immediate backup in addition to scheduling, and the [WRITE] marker signals mutation. It does not cover persistence, permissions, or failure behavior, but the core write action and conditional side effect are stated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single compact sentence with the action front-loaded and the key conditional flag included. Every clause earns its place, and there is no filler.

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?

This is a 16-parameter create operation with no annotations and no output schema, yet the description only covers the core action and one optional flag. Important constraints like save_s3 requiring s3_storage_uuid, retention settings, and notification options are absent, so an agent lacks enough context to use the tool correctly beyond the required parameters.

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 only 31%, so the description needed to compensate. It calls out frequency and backup_now, but both are already described in the schema, and it adds no meaning for uuid, the save_s3/s3_storage_uuid dependency, timeout, dump_all, or the retention parameters.

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

Purpose5/5

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

The description uses a specific verb, 'create', and a clear resource, 'database backup schedule', and highlights the required frequency field. It is clearly distinguishable from sibling tools like list/delete/update/run backup operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description makes the core use case clear: scheduling a database backup, with an optional immediate run via backup_now. However, it does not explicitly say when to use this over run_database_storage_backup or update_database_backup, so tool selection among siblings is mostly left to inference.

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