Skip to main content
Glama

deploy

Launch a service and wait for completion, returning the release status and final log output; set wait=false to return immediately.

Instructions

Deploy a service and wait for the result (set wait=false to return immediately). Returns the deploy and the end of its log.

Input Schema

NameRequiredDescriptionDefault
refNoBranch, tag or commit (Git services)
waitNo
serviceYesService id or `project.service`, e.g. `shop.api`
no_cacheNoBuild without the layer cache and pull base images again

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It does disclose the blocking-by-default behavior and what is returned ('the deploy and the end of its log'), but says nothing about permissions, what happens to a running service during deploy, failure behavior, or the effect of no_cache/ref.

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 short sentences, front-loaded with the action and then the wait behavior; nothing is wasted, though the return-value sentence could be folded in more tightly.

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 deployment mutation with no annotations and no output schema, the description covers the essentials of invocation and return shape but omits failure modes, blocking duration expectations, and cache/ref implications that an agent would need to call it confidently.

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?

Schema coverage is 75%, covering service, ref, and no_cache; the description adds the missing semantics for wait, explaining that it controls blocking versus immediate return, which the bare default in the schema does not convey.

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?

States a specific verb and resource ('Deploy a service') plus the key scope modifier (waits for result by default). It is distinguishable from list_deploys/get_deploy, though it never contrasts itself with the closely related restart or rollback siblings.

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 parenthetical '(set wait=false to return immediately)' gives one concrete usage condition, but there is no guidance on when to use deploy versus restart, rollback, or promote_replica, and no prerequisites are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.