Skip to main content
Glama

deploy

Deploy applications or services using tags or UUIDs to update versions and implement changes through the Coolify MCP Server.

Instructions

Deploy an application or service using a tag or UUID. This allows you to deploy new versions or updates to your applications.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNoTag name(s). Comma separated list is accepted
uuidNoResource UUID(s). Comma separated list is accepted
forceNoForce rebuild (without cache)

Implementation Reference

  • The handler function for the 'deploy' tool. It parses the input arguments using DeploySchema, builds query parameters for tag, uuid, and force, calls the Coolify API endpoint `/deploy` with those parameters, and returns the result as formatted JSON text.
    case "deploy": {
      const params = DeploySchema.parse(request.params.arguments);
      const queryParams = new URLSearchParams();
      if (params.tag) queryParams.append('tag', params.tag);
      if (params.uuid) queryParams.append('uuid', params.uuid);
      if (params.force) queryParams.append('force', 'true');
    
      const result = await coolifyApiCall(`/deploy?${queryParams.toString()}`);
      return {
        content: [{
          type: "text",
          text: JSON.stringify(result, null, 2)
        }]
      };
    }
  • Zod schema defining the input parameters for the 'deploy' tool: optional tag (comma-separated), uuid (comma-separated), and force boolean flag.
    const DeploySchema = z.object({
      tag: z.string().optional().describe("Tag name(s). Comma separated list is accepted"),
      uuid: z.string().optional().describe("Resource UUID(s). Comma separated list is accepted"),
      force: z.boolean().optional().describe("Force rebuild (without cache)"),
    });
  • src/index.ts:128-132 (registration)
    The registration of the 'deploy' tool in the tools list provided by the ListToolsRequestHandler. Specifies the tool name, description, and references the input schema.
    {
      name: "deploy",
      description: "Deploy an application or service using a tag or UUID. This allows you to deploy new versions or updates to your applications.",
      inputSchema: zodToJsonSchema(DeploySchema),
    },
Behavior2/5

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

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It implies a write operation ('deploy') but doesn't disclose permissions needed, whether it's destructive, rate limits, or what happens on success/failure. The mention of 'force rebuild' in the schema hints at potential side effects, but the description doesn't elaborate.

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 two concise sentences that efficiently state the tool's purpose and high-level usage. It's front-loaded with the core action and avoids unnecessary details, though it could be slightly more structured by explicitly separating purpose from context.

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 deployment tool with no annotations and no output schema, the description is incomplete. It lacks critical context like what 'deploy' entails (e.g., rollout strategy, downtime), expected outcomes, error handling, or how it differs from similar tools like update-application, leaving significant gaps for an 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?

Schema description coverage is 100%, so parameters are well-documented in the schema. The description adds marginal value by mentioning 'tag or UUID' and the purpose of deployment, but doesn't explain parameter interactions (e.g., tag vs. uuid, when force is needed) beyond what the schema provides.

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 action ('deploy') and target ('application or service'), and specifies the mechanism ('using a tag or UUID') and purpose ('deploy new versions or updates'). It distinguishes from siblings like restart/start/stop by focusing on deployment rather than lifecycle management, though it doesn't explicitly contrast with update-application.

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 like update-application or restart-application. It mentions deploying 'new versions or updates' but doesn't clarify when deployment is preferred over updating, nor does it mention prerequisites or exclusions.

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