Skip to main content
Glama

coolify_set_database_storage_backup

Set or update a backup schedule for a database's persistent volume or directory. Define cron frequency, enable S3 uploads, set retention policies, and configure backup behavior.

Instructions

[WRITE] Create or replace a backup schedule for a database persistent volume/directory

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesUUID of the database
enabledNoWhether the schedule is enabled (default true)
save_s3NoAlso upload backups to S3
timeoutNoBackup timeout in seconds
frequencyYesCron frequency for the backup (e.g. '0 2 * * *')
storage_uuidYesUUID of the persistent volume or directory storage
s3_storage_uuidNoS3 storage UUID when save_s3 is true
retention_days_s3No
stop_during_backupNoStop the resource during backup
retention_amount_s3No
disable_local_backupNoDisable local backup retention
retention_days_locallyNo
retention_amount_locallyNo
retention_max_storage_s3No
retention_max_storage_locallyNo
Behavior3/5

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

No annotations are provided, so the description carries full burden. It correctly flags the tool as a write/mutation operation via '[WRITE]'. It mentions 'replace' implying idempotent overwrite behavior, but does not disclose other behavioral traits (e.g., whether it overwrites entirely or merges, whether existing backups are affected, or any rate limits or authorization requirements). This is adequate but not comprehensive for a mutation tool.

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

Conciseness4/5

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

The description is a single, clear sentence with a useful '[WRITE]' prefix for quick scanning. It is appropriately concise for a 15-param tool with good schema descriptions. No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (15 parameters, no output schema, no annotations), the description is somewhat underspecified. It does not explain that it creates or replaces a backup schedule for a persistent volume/directory, but omits mention of return behavior (e.g., whether it returns the schedule object or just confirmation). The sibling set includes similar backup tools, increasing the need for more context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 15 parameters, 3 required, with schema description coverage at 60%. The description itself does not mention any parameters, but the schema descriptions are mostly self-documenting (e.g., 'Cron frequency for the backup'). Given the high schema coverage, the description does not need to add much parameter detail. Credit for not cluttering the description with redundant param info.

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

Purpose4/5

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

The description clearly states the tool's action ('Create or replace a backup schedule') and the resource it targets ('a database persistent volume/directory'). The '[WRITE]' prefix signals mutation, distinguishing it from read tools in the sibling list. However, it does not explicitly distinguish from other database backup tools like 'coolify_create_database_backup' or 'coolify_run_database_storage_backup'.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives (e.g., 'coolify_run_database_storage_backup' for immediate execution vs. scheduling). It does not mention prerequisites, such as requiring existing storage or database UUIDs, or state when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/0xtlt/coolify-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server