Skip to main content
Glama

coolify_servers

Manage servers in Coolify infrastructure: list, create, retrieve, update, and delete server configurations with SSH details and metadata.

Instructions

Server CRUD operations - list, create, get, update, and delete servers

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesAction to perform: list (list all servers), create (create new server), get (get server by UUID), update (update server), delete (delete server)
uuidNoServer UUID (required for get, update, delete actions)
nameNoServer name (required for create, optional for update)
descriptionNoServer description (optional for create and update)
ipNoServer IP address (required for create, optional for update)
portNoSSH port (optional for create and update, default: 22)
userNoSSH user (optional for create and update, default: root)
private_key_idNoPrivate key ID (optional for create action)
pageNoPage number (optional for list action)
per_pageNoItems per page (optional for list action)

Implementation Reference

  • Handler function implementing the logic for the 'coolify_servers' tool. It handles CRUD operations (list, create, get, update, delete) for servers by making API calls to Coolify endpoints.
    async servers(action: string, args: any) {
      switch (action) {
        case 'list':
          const queryString = this.apiClient.buildQueryString(args);
          const response = await this.apiClient.get(`/servers?${queryString}`);
          return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] };
        case 'create':
          const createResponse = await this.apiClient.post('/servers', {
            name: args.name,
            description: args.description,
            ip: args.ip,
            port: args.port || 22,
            user: args.user || 'root',
            private_key_id: args.private_key_id,
          });
          return { content: [{ type: 'text', text: JSON.stringify(createResponse.data, null, 2) }] };
        case 'get':
          if (!args.uuid) throw new Error('Server UUID is required for get action');
          const getResponse = await this.apiClient.get(`/servers/${args.uuid}`);
          return { content: [{ type: 'text', text: JSON.stringify(getResponse.data, null, 2) }] };
        case 'update':
          if (!args.uuid) throw new Error('Server UUID is required for update action');
          const updateResponse = await this.apiClient.patch(`/servers/${args.uuid}`, {
            name: args.name,
            description: args.description,
            ip: args.ip,
            port: args.port,
            user: args.user,
          });
          return { content: [{ type: 'text', text: JSON.stringify(updateResponse.data, null, 2) }] };
        case 'delete':
          if (!args.uuid) throw new Error('Server UUID is required for delete action');
          await this.apiClient.delete(`/servers/${args.uuid}`);
          return { content: [{ type: 'text', text: 'Server deleted successfully' }] };
        default:
          throw new Error(`Unknown servers action: ${action}`);
      }
    }
  • Input schema definition for the 'coolify_servers' tool, specifying parameters for server CRUD operations.
    {
      name: 'coolify_servers',
      description: 'Server CRUD operations - list, create, get, update, and delete servers',
      inputSchema: {
        type: 'object',
        properties: {
          action: { 
            type: 'string', 
            enum: ['list', 'create', 'get', 'update', 'delete'],
            description: 'Action to perform: list (list all servers), create (create new server), get (get server by UUID), update (update server), delete (delete server)'
          },
          uuid: { 
            type: 'string', 
            description: 'Server UUID (required for get, update, delete actions)' 
          },
          name: { 
            type: 'string', 
            description: 'Server name (required for create, optional for update)' 
          },
          description: { 
            type: 'string', 
            description: 'Server description (optional for create and update)' 
          },
          ip: { 
            type: 'string', 
            description: 'Server IP address (required for create, optional for update)' 
          },
          port: { 
            type: 'number', 
            description: 'SSH port (optional for create and update, default: 22)' 
          },
          user: { 
            type: 'string', 
            description: 'SSH user (optional for create and update, default: root)' 
          },
          private_key_id: { 
            type: 'string', 
            description: 'Private key ID (optional for create action)' 
          },
          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:122-123 (registration)
    Registration of the 'coolify_servers' tool handler in the MCP server's tool call dispatcher switch statement.
    case 'coolify_servers':
      return await this.handlers.servers(args.action, args);
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 mentions CRUD operations but doesn't specify authentication requirements, rate limits, side effects (e.g., what happens when deleting a server), or response formats. For a tool with 10 parameters and multiple actions including destructive ones like 'delete,' this leaves significant gaps in understanding how the tool behaves in practice.

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—a single sentence that efficiently lists all five actions. It's front-loaded with the core purpose and wastes no words. Every part of the description earns its place by clearly communicating the scope of operations.

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 (10 parameters, multiple actions including destructive ones), lack of annotations, and no output schema, the description is insufficient. It doesn't cover behavioral aspects like authentication, error handling, or what the tool returns. For a CRUD tool with 'delete' action and no structured safety hints, more context is needed to ensure safe and correct usage by an AI agent.

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 schema description coverage is 100%, with each parameter well-documented in the schema itself (e.g., action enum values, required conditions for uuid). The description adds no additional parameter semantics beyond stating it handles CRUD operations, which is already implied by the action parameter. This meets the baseline of 3 since the schema does the heavy lifting, but the description doesn't enhance understanding of parameter usage beyond what's in the schema.

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 'Server CRUD operations - list, create, get, update, and delete servers,' which is a specific verb+resource combination. It distinguishes itself from sibling tools like 'coolify_application_deployments' or 'coolify_projects' by focusing specifically on servers rather than applications, databases, or projects. However, it doesn't explicitly differentiate from 'coolify_server_management' which might have overlapping functionality.

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. There's no mention of prerequisites, when to choose specific actions (like 'list' vs 'get'), or how it relates to sibling tools such as 'coolify_server_management' or other server-related operations. The agent must infer usage solely from the action parameter description in the schema.

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