Skip to main content
Glama

deploy

Upload a previewed plan to an SFTP host, backing up every overwritten file on the server so it can be undone with restore. Refuses if the plan changed since preview.

Instructions

Upload the previewed plan. Every file it overwrites is backed up on the server first, and the whole deploy can be undone with restore. Never deletes server files. Refuses if the plan changed since preview_deploy.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYesSite name from sites.json (see list_sites)
planIdYesplanId from preview_deploy
localDirNoLocal folder to deploy from / compare with. Defaults to the site's localDir.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full safety burden and does so well: it discloses automatic server-side backups of overwritten files, full undo via restore, that server files are never deleted, and a staleness guard against a changed plan. It omits permissions/auth requirements and any indication of the return/confirmation format, which keeps it out of the top band.

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?

Four short sentences, front-loaded with the action, then the safety guarantees, then the blocking precondition. Every sentence carries distinct, relevant information with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description adequately covers backup, rollback, deletion behavior, and staleness refusal. The main remaining gap is what a successful deploy returns (confirmation/result shape), which is left entirely implicit.

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 site, planId, and localDir are already documented in the schema. The description reinforces the planId's origin ('the previewed plan') but adds no format, constraint, or default detail beyond the structured fields; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Upload the previewed plan') and implicitly scopes it apart from preview_deploy (which produces the plan) and restore (which undoes it). An agent can identify this as the commit step of a preview/commit workflow without opening the schema.

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

Usage Guidelines4/5

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

Establishes the prerequisite ('the previewed plan' from preview_deploy) and a hard precondition ('Refuses if the plan changed since preview_deploy'), and points to restore as the rollback path. It stops short of an explicit 'use X instead of Y' routing statement, but the workflow context is clear.

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