Skip to main content
Glama

coolify_database_lifecycle

Manage database states by starting, stopping, or restarting databases using their unique identifiers within the Coolify infrastructure platform.

Instructions

Database lifecycle management - start, stop, and restart databases

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesAction to perform: start (start database), stop (stop database), restart (restart database)
uuidYesDatabase UUID (required for all actions)

Implementation Reference

  • The handler function that executes the tool logic for starting, stopping, or restarting a database using Coolify API endpoints.
    async databaseLifecycle(action: string, uuid: string) {
      if (!uuid) throw new Error('Database UUID is required for all lifecycle actions');
      
      switch (action) {
        case 'start':
          const startResponse = await this.apiClient.post(`/databases/${uuid}/start`);
          return { content: [{ type: 'text', text: JSON.stringify(startResponse.data, null, 2) }] };
        case 'stop':
          const stopResponse = await this.apiClient.post(`/databases/${uuid}/stop`);
          return { content: [{ type: 'text', text: JSON.stringify(stopResponse.data, null, 2) }] };
        case 'restart':
          const restartResponse = await this.apiClient.post(`/databases/${uuid}/restart`);
          return { content: [{ type: 'text', text: JSON.stringify(restartResponse.data, null, 2) }] };
        default:
          throw new Error(`Unknown database lifecycle action: ${action}`);
      }
    }
  • Input schema defining the parameters for the coolify_database_lifecycle tool: action (start/stop/restart) and uuid.
    {
      name: 'coolify_database_lifecycle',
      description: 'Database lifecycle management - start, stop, and restart databases',
      inputSchema: {
        type: 'object',
        properties: {
          action: { 
            type: 'string', 
            enum: ['start', 'stop', 'restart'],
            description: 'Action to perform: start (start database), stop (stop database), restart (restart database)'
          },
          uuid: { 
            type: 'string', 
            description: 'Database UUID (required for all actions)' 
          },
        },
        required: ['action', 'uuid'],
      },
    },
  • src/index.ts:116-117 (registration)
    The switch case that registers and dispatches to the databaseLifecycle handler for this tool.
    case 'coolify_database_lifecycle':
      return await this.handlers.databaseLifecycle(args.action, args.uuid);
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the actions (start, stop, restart) but doesn't cover critical aspects like required permissions, side effects (e.g., downtime during stop/restart), error handling, or response format. For a lifecycle management tool with potential destructive operations, this is a significant gap in transparency.

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 extremely concise and front-loaded, using a single sentence that efficiently lists all actions and the resource. Every word earns its place, with no redundant or vague language, making it easy to parse quickly.

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?

Given the complexity of lifecycle management (potentially destructive operations) and the lack of annotations and output schema, the description is incomplete. It doesn't address safety considerations, expected outcomes, or error scenarios, which are crucial for an agent to use this tool correctly in a production environment.

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?

The input schema has 100% description coverage, clearly documenting both parameters (action with enum values and uuid as required). The description adds no additional parameter semantics beyond what's in the schema, such as format details for UUID or action-specific behaviors. Baseline 3 is appropriate since the schema does the heavy lifting.

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 purpose with specific verbs (start, stop, restart) and resource (databases), making it easy to understand what it does. However, it doesn't explicitly differentiate from sibling tools like 'coolify_application_lifecycle' or 'coolify_service_lifecycle', which likely manage different resource types but share similar lifecycle operations.

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. It doesn't mention prerequisites, dependencies, or comparisons to sibling tools (e.g., 'coolify_databases' for listing databases or 'coolify_application_lifecycle' for applications), leaving the agent to infer usage context from the tool name alone.

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/HowieDuhzit/CoolifyMCP'

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