Skip to main content
Glama

create_database_backup

Set up automated database backups with configurable frequency and retention. Schedule backups to protect your data.

Instructions

Create a backup configuration for a database

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesDatabase UUID
enabledNoEnable scheduled backups
frequencyNoBackup frequency (e.g., daily, weekly)
retentionNoNumber of backups to retain

Implementation Reference

  • Handler for create_database_backup tool. Requires 'uuid' parameter, then sends a POST request to /databases/{uuid}/backups with all args as the request body.
    case 'create_database_backup':
      requireParam(args, 'uuid');
      return client.post(`/databases/${args.uuid}/backups`, args);
  • Input schema definition for create_database_backup. Accepts 'uuid' (required), 'enabled' (boolean, default true), 'frequency' (string, e.g. daily/weekly), and 'retention' (number).
    {
      name: 'create_database_backup',
      description: 'Create a backup configuration for a database',
      inputSchema: {
        type: 'object',
        properties: {
          uuid: { type: 'string', description: 'Database UUID' },
          enabled: { type: 'boolean', description: 'Enable scheduled backups', default: true },
          frequency: { type: 'string', description: 'Backup frequency (e.g., daily, weekly)' },
          retention: { type: 'number', description: 'Number of backups to retain' }
        },
        required: ['uuid']
      }
    },
  • src/tools/index.ts:2-2 (registration)
    Tool handler function handleTool is exported from handlers.ts and used by the MCP server via CallToolRequestSchema handling in index.ts (line 57).
    export { handleTool } from './handlers.js';
  • The CoolifyClient.post method used by the handler to make the actual POST request to the Coolify API.
    async post<T>(endpoint: string, data?: Record<string, unknown>): Promise<T> {
      const response = await this.client.post<T>(endpoint, data);
      return response.data;
    }
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavior. It only states 'Create a backup configuration' without mentioning side effects (e.g., does it override existing config?), prerequisites (e.g., database must exist), or whether it triggers an immediate backup. This lacks sufficient detail.

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, front-loaded sentence with no extraneous words. While concise, it sacrifices informativeness; however, for conciseness alone it scores well.

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?

For a creation tool with no output schema and no annotations, the description should explain what a backup configuration entails, any constraints (e.g., one per database?), and return behavior. It fails to provide this context, making it incomplete.

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

Parameters3/5

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

Input schema has 100% coverage with descriptions for all 4 parameters. The tool description adds no additional meaning beyond what the schema already provides, such as clarifying that 'retention' is the count of backups to keep or that 'enabled' defaults to true. Baseline score of 3 is appropriate.

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 uses a specific verb 'Create' and resource 'backup configuration for a database', clearly distinguishing it from sibling tools like 'create_database' or 'get_database_backups'. However, it could be more precise by saying 'backup schedule' instead of 'backup configuration'.

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?

No explicit guidance on when to use this tool versus alternatives like 'update_database' or 'create_database'. The description implies usage for setting up backups but does not provide context, exclusions, or prerequisites.

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/kof70/coolify-mcp-server'

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