Skip to main content
Glama

Begin a multi-call deploy session

begin_deploy

Open a staging session for a deploy that is too large for one call: stage files with add_files (repeatable), add_file_chunk, or one tar(.gz) POST to the returned uploadUrl, then publish with commit_deploy. Use begin_deploy only when the files do not fit in one deploy_site or update_site call. Up to 5 open sessions per token; a session expires after 1 hour.

Input Schema

NameRequiredDescriptionDefault
modeYesHow commit_deploy will apply the staged files. 'replace' wipes the live site and atomic-renames the staged set into place. 'patch' layers staged files on top of the live site (kept files = live + staged; deletes via commit_deploy's `delete` array).
nameYesName of an existing site (see list_sites). Sessions do not create sites; deploy_site does.

Output Schema

NameRequiredDescriptionDefault
modeYes
siteIdYes
statusYes
deployIdYesPass this id to add_files / commit_deploy / abort_deploy / list_deploys.
siteNameYes
expiresAtYesISO timestamp. The session will be auto-expired and the scratch dir cleaned at this time.
uploadUrlYesPOST a tar(.gz) archive here to stage many files in one HTTP call, outside the tool-call output budget. The URL embeds a token scoped to this session, so no Authorization header is needed. Example: `tar -czf - -C dist . | curl --data-binary @- -H "Content-Type: application/octet-stream" "<uploadUrl>"`. Body limit 100 MB (gzipped). Then call commit_deploy.
uploadTokenYesThe token embedded in uploadUrl, for an Authorization: Bearer header instead. Valid only for POST /upload/<this deployId>, not for tool calls or other sessions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Site name to deploy to. Must already exist; multi-call sessions don't auto-create sites — use deploy_site for that, or call this against an existing site."New value: +"Name of an existing site (see list_sites). Sessions do not create sites; deploy_site does."
    • changedOutput schema / properties / uploadToken / description
      Previous value: -"Same single-purpose token already embedded in uploadUrl, exposed separately if you'd rather pass it via Authorization: Bearer header than as a query parameter. Valid only for POST /upload/<this deployId>. Cannot be used for /mcp tool calls or any other deploy session."New value: +"The token embedded in uploadUrl, for an Authorization: Bearer header instead. Valid only for POST /upload/<this deployId>, not for tool calls or other sessions."
    • changedOutput schema / properties / uploadUrl / description
      Previous value: -"POST a tar(.gz) archive to this URL to stage many files in one HTTP call — bypasses the per-tool-call output budget that bounds add_files. The URL already embeds a single-purpose upload_token narrowly scoped to THIS staging session, so no Authorization header is needed when using it. Example: `tar -czf - -C dist . | curl --data-binary @- -H \"Content-Type: application/octet-stream\" \"<uploadUrl>\"`. After upload, call commit_deploy normally. Body limit: 100 MB (gzipped). TIP: pair with list_file_hashes BEFORE staging, so you can skip files that haven't changed."New value: +"POST a tar(.gz) archive here to stage many files in one HTTP call, outside the tool-call output budget. The URL embeds a token scoped to this session, so no Authorization header is needed. Example: `tar -czf - -C dist . | curl --data-binary @- -H \"Content-Type: application/octet-stream\" \"<uploadUrl>\"`. Body limit 100 MB (gzipped). Then call commit_deploy."
  2. Changed1 schema field changed
    • removedOutput schema / properties / request_id
      Removed value: -{
      -  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      -  "type": "string"
      -}
  3. Changed1 schema field changed
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      +  "type": "string"
      +}
  4. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, idempotentHint=false and destructiveHint=false, and the description adds genuinely non-obvious operational constraints the annotations do not carry: a 5-open-session quota per token and a 1-hour expiry. It stops short of stating auth requirements or what happens to an expired/aborted session's staged files, so 4 rather than 5.

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?

Three dense sentences, front-loaded with purpose then the routing rule then the limits. No filler; every clause carries an actionable fact.

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

Completeness5/5

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

An output schema exists, so return values need no explanation, yet the description still signals the key returned artifact (uploadUrl). With annotations, a complete workflow chain, quota and expiry all present, an agent has everything needed to invoke correctly.

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 coverage is 100% and the schema itself fully documents both `mode` (replace vs patch semantics) and `name` (existing site, see list_sites). The description adds no parameter-level detail beyond what the schema already states, so the 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 ('open a staging session for a deploy') and immediately scopes it against the common case, naming the sibling flow to use instead. An agent can distinguish this from deploy_site/update_site without opening either schema.

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

Usage Guidelines5/5

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

Explicit when-to-use rule ('only when the files do not fit in one deploy_site or update_site call'), plus the full follow-on workflow (add_files/add_file_chunk/tar POST, then commit_deploy). Alternatives and the selecting condition are both named.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.