Skip to main content
Glama

list-resources

Retrieve a comprehensive list of all resources managed by Coolify, including applications, services, databases, and deployments.

Instructions

Retrieve a comprehensive list of all resources managed by Coolify. This includes applications, services, databases, and deployments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler for the 'list-resources' tool. It calls the Coolify API at '/resources' using the helper function and returns the JSON-formatted list of resources as text content.
    case "list-resources": {
      const resources = await coolifyApiCall('/resources');
      return {
        content: [{
          type: "text",
          text: JSON.stringify(resources, null, 2)
        }]
      };
    }
  • src/index.ts:83-87 (registration)
    Registration of the 'list-resources' tool in the list of available tools, including its name, description, and empty input schema (no parameters required).
    {
      name: "list-resources",
      description: "Retrieve a comprehensive list of all resources managed by Coolify. This includes applications, services, databases, and deployments.",
      inputSchema: zodToJsonSchema(z.object({})),
    },
  • Input schema for 'list-resources' tool: an empty object, indicating no input parameters are required.
    inputSchema: zodToJsonSchema(z.object({})),
  • Helper function 'coolifyApiCall' used by the 'list-resources' handler (and others) to make authenticated API calls to the Coolify server.
    async function coolifyApiCall(endpoint: string, method: string = 'GET', body?: any): Promise<any> {
      const baseUrl = process.env.COOLIFY_BASE_URL?.replace(/\/$/, '') || 'https://coolify.stuartmason.co.uk';
      const url = `${baseUrl}/api/v1${endpoint}`;
    
      const response = await fetch(url, {
        method,
        headers: {
          'Authorization': `Bearer ${process.env.COOLIFY_ACCESS_TOKEN}`,
          'Content-Type': 'application/json',
        },
        body: body ? JSON.stringify(body) : undefined,
      });
    
      if (!response.ok) {
        const errorBody = await response.json().catch(() => ({}));
        throw new Error(JSON.stringify({
          error: `Coolify API error: ${response.status} ${response.statusText}`,
          status: response.status,
          details: errorBody
        }));
      }
    
      return await response.json();
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states what the tool retrieves but doesn't describe format, pagination, sorting, rate limits, authentication needs, or what 'comprehensive' means operationally. For a list tool with zero annotation coverage, this leaves significant behavioral gaps.

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?

Two sentences that efficiently convey the tool's purpose and scope. The first sentence states the core action, the second provides clarifying examples. No wasted words, though it could be slightly more structured with explicit differentiation from siblings.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate but incomplete. It explains what's retrieved but not how it's returned (format, structure, limitations). For a list tool without output schema, more detail about return values would improve completeness.

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

Parameters4/5

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

The tool has 0 parameters with 100% schema description coverage, so the schema already fully documents the lack of inputs. The description appropriately doesn't discuss parameters, maintaining focus on what the tool does rather than inputs. Baseline for 0 params is 4.

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 verb ('retrieve') and resource ('list of all resources managed by Coolify'), with specific examples of what's included (applications, services, databases, deployments). It doesn't explicitly differentiate from sibling tools like 'list-applications' or 'list-databases', but the comprehensive scope is implied.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for getting a broad overview of all resources, but doesn't explicitly state when to use this vs. more specific sibling tools like 'list-applications' or 'list-databases'. No explicit alternatives or exclusions are provided, leaving usage context somewhat implied rather than clearly defined.

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

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