Skip to main content
Glama

coolify_system

Check system health, retrieve API version, and get system information for infrastructure management through the Coolify platform.

Instructions

System management operations - health check, version, and system information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYesAction to perform: health (check system health), version (get API version), info (get system information)

Implementation Reference

  • The handler function that implements the logic for the 'coolify_system' tool. It handles 'health', 'version', and 'info' actions by making API calls to the Coolify server and returning formatted responses.
    async system(action: string) {
      switch (action) {
        case 'health':
          const healthResponse = await this.apiClient.get('/health');
          return { content: [{ type: 'text', text: JSON.stringify(healthResponse.data, null, 2) }] };
        case 'version':
          const versionResponse = await this.apiClient.get('/version');
          return { content: [{ type: 'text', text: JSON.stringify(versionResponse.data, null, 2) }] };
        case 'info':
          const [health, version] = await Promise.all([
            this.apiClient.get('/health'),
            this.apiClient.get('/version')
          ]);
          const systemInfo = {
            health: health.data,
            version: version.data,
            timestamp: new Date().toISOString()
          };
          return { content: [{ type: 'text', text: JSON.stringify(systemInfo, null, 2) }] };
        default:
          throw new Error(`Unknown system action: ${action}`);
      }
    }
  • The tool definition including name, description, and input schema for validating parameters (action: health|version|info).
    {
      name: 'coolify_system',
      description: 'System management operations - health check, version, and system information',
      inputSchema: {
        type: 'object',
        properties: {
          action: { 
            type: 'string', 
            enum: ['health', 'version', 'info'],
            description: 'Action to perform: health (check system health), version (get API version), info (get system information)'
          },
        },
        required: ['action'],
      },
    },
  • src/index.ts:88-90 (registration)
    The switch case in handleToolCall that registers and dispatches the 'coolify_system' tool call to its handler.
    case 'coolify_system':
      return await this.handlers.system(args.action);
  • src/index.ts:60-64 (registration)
    The ListTools handler that registers the tool by including it in the exported tools list from getTools().
    this.server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools: getTools(),
      };
    });
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 'operations' but doesn't disclose whether these are read-only queries or potentially disruptive actions, what permissions are required, rate limits, or what format the information returns. For a system management tool with zero annotation coverage, this leaves significant behavioral questions unanswered.

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 perfectly concise - a single sentence that efficiently communicates the core functionality. Every word earns its place with no redundancy or unnecessary elaboration. It's appropriately sized for a tool with one parameter and clear scope.

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?

For a single-parameter tool with 100% schema coverage but no annotations or output schema, the description provides adequate but minimal context. It covers what the tool does but lacks behavioral details (permissions, side effects) and doesn't explain what information each action returns. Given the simplicity of the tool, this is minimally viable but has clear gaps.

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?

Schema description coverage is 100%, with the single parameter 'action' fully documented in the schema with enum values and descriptions. The description mentions the three operations (health, version, info) but adds no additional semantic context beyond what the schema already provides. Baseline 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's purpose as 'System management operations' with specific functions listed (health check, version, system information). It distinguishes from siblings by focusing on system-level operations rather than application/database/project management. However, it doesn't explicitly contrast with 'coolify_server_management' which might have overlapping scope.

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. With siblings like 'coolify_server_management' that might handle similar system operations, there's no indication of scope boundaries or prerequisites. The description only lists what the tool does, not when it's appropriate.

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