Skip to main content
Glama

coolify_services

Manage services in Coolify infrastructure: create, list, retrieve, update, or delete services using Docker Compose configurations.

Instructions

Service CRUD operations - list, create, get, update, and delete services

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesAction to perform: list (list all services), create (create new service), get (get service by UUID), update (update service), delete (delete service)
uuidNoService UUID (required for get, update, delete actions)
nameNoService name (required for create, optional for update)
descriptionNoService description (optional for create and update)
server_uuidNoServer UUID (required for create action)
project_uuidNoProject UUID (required for create action)
environment_nameNoEnvironment name (required for create action)
docker_compose_rawNoDocker Compose configuration (required for create, optional for update)
pageNoPage number (optional for list action)
per_pageNoItems per page (optional for list action)

Implementation Reference

  • Main handler function implementing CRUD operations for services (list, create, get, update, delete) using Coolify API client.
    async services(action: string, args: any) {
      switch (action) {
        case 'list':
          const queryString = this.apiClient.buildQueryString(args);
          const response = await this.apiClient.get(`/services?${queryString}`);
          return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] };
        case 'create':
          const createResponse = await this.apiClient.post('/services', {
            name: args.name,
            description: args.description,
            server_uuid: args.server_uuid,
            project_uuid: args.project_uuid,
            environment_name: args.environment_name,
            docker_compose_raw: args.docker_compose_raw,
          });
          return { content: [{ type: 'text', text: JSON.stringify(createResponse.data, null, 2) }] };
        case 'get':
          if (!args.uuid) throw new Error('Service UUID is required for get action');
          const getResponse = await this.apiClient.get(`/services/${args.uuid}`);
          return { content: [{ type: 'text', text: JSON.stringify(getResponse.data, null, 2) }] };
        case 'update':
          if (!args.uuid) throw new Error('Service UUID is required for update action');
          const updateResponse = await this.apiClient.patch(`/services/${args.uuid}`, {
            name: args.name,
            description: args.description,
            docker_compose_raw: args.docker_compose_raw,
          });
          return { content: [{ type: 'text', text: JSON.stringify(updateResponse.data, null, 2) }] };
        case 'delete':
          if (!args.uuid) throw new Error('Service UUID is required for delete action');
          await this.apiClient.delete(`/services/${args.uuid}`);
          return { content: [{ type: 'text', text: 'Service deleted successfully' }] };
        default:
          throw new Error(`Unknown services action: ${action}`);
      }
    }
  • Tool definition including name, description, and detailed input schema for validating parameters across all CRUD actions.
    {
      name: 'coolify_services',
      description: 'Service CRUD operations - list, create, get, update, and delete services',
      inputSchema: {
        type: 'object',
        properties: {
          action: { 
            type: 'string', 
            enum: ['list', 'create', 'get', 'update', 'delete'],
            description: 'Action to perform: list (list all services), create (create new service), get (get service by UUID), update (update service), delete (delete service)'
          },
          uuid: { 
            type: 'string', 
            description: 'Service UUID (required for get, update, delete actions)' 
          },
          name: { 
            type: 'string', 
            description: 'Service name (required for create, optional for update)' 
          },
          description: { 
            type: 'string', 
            description: 'Service description (optional for create and update)' 
          },
          server_uuid: { 
            type: 'string', 
            description: 'Server UUID (required for create action)' 
          },
          project_uuid: { 
            type: 'string', 
            description: 'Project UUID (required for create action)' 
          },
          environment_name: { 
            type: 'string', 
            description: 'Environment name (required for create action)' 
          },
          docker_compose_raw: { 
            type: 'string', 
            description: 'Docker Compose configuration (required for create, optional for update)' 
          },
          page: { 
            type: 'number', 
            description: 'Page number (optional for list action)' 
          },
          per_page: { 
            type: 'number', 
            description: 'Items per page (optional for list action)' 
          },
        },
        required: ['action'],
      },
    },
  • src/index.ts:128-129 (registration)
    Switch case in handleToolCall that registers and dispatches 'coolify_services' tool calls to the appropriate handler method.
    case 'coolify_services':
      return await this.handlers.services(args.action, args);
Behavior2/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 mentions CRUD operations but doesn't disclose behavioral traits like authentication requirements, rate limits, side effects, or what happens during deletion. For a multi-action tool with destructive operations, this leaves significant gaps in understanding how the tool behaves.

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, efficient sentence that front-loads the core functionality. It wastes no words but could be slightly more structured by separating the different action types for better readability.

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 complex multi-action tool with 10 parameters, no annotations, and no output schema, the description is inadequate. It doesn't explain return values, error conditions, or behavioral implications of different actions. The agent must rely entirely on the input schema without guidance on how to interpret results or handle different operation types.

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?

With 100% schema description coverage, the schema already documents all 10 parameters thoroughly. The description adds no additional parameter semantics beyond what's in the schema - it doesn't explain relationships between parameters, provide examples, or clarify edge cases. The baseline of 3 is appropriate when 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 performs 'Service CRUD operations' with specific verbs (list, create, get, update, delete) and resource (services). It distinguishes from siblings like coolify_servers or coolify_projects by focusing on services, but doesn't explicitly differentiate from other service-related tools like coolify_service_lifecycle.

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 guidance is provided on when to use this tool versus alternatives. With 16 sibling tools including service-specific ones like coolify_service_lifecycle and coolify_service_envs, the description offers no context about use cases, prerequisites, or relationships to other tools.

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