vibedeploy

Begin a multi-call deploy session

begin_deploy

Opens a staging session for a multi-call deploy. Use when the site is too large to fit in a single deploy_site/update_site call. Pair with add_files (one or more times) OR a single tarball upload to the returned uploadUrl, then commit_deploy. Active session limit per token: 5. Default TTL: 1 hour.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`mode`	Yes	How 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).
`name`	Yes	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.

Output Schema

TableJSON Schema

Name	Required	Description
`mode`	Yes
`siteId`	Yes
`status`	Yes
`deployId`	Yes	Pass this id to add_files / commit_deploy / abort_deploy / list_deploys.
`siteName`	Yes
`expiresAt`	Yes	ISO timestamp. The session will be auto-expired and the scratch dir cleaned at this time.
`uploadUrl`	Yes	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.
`uploadToken`	Yes	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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedSep 6, 2026

removedOutput schema / properties / request_id

Removed value: -{
-  "description": "Server-assigned request correlation id. Quote it when contacting support.",
-  "type": "string"
-}

Changed1 schema field changedJul 20, 2026

addedOutput schema / properties / request_id

Added value: +{
+  "description": "Server-assigned request correlation id. Quote it when contacting support.",
+  "type": "string"
+}

First observedJun 29, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already indicate non-read-only, non-idempotent, and non-destructive behavior. The description adds valuable operational details beyond these: the active session limit of 5 per token and the default TTL of 1 hour. It also frames the tool as opening a staging session, implying changes are staged rather than immediately applied, which enriches the annotation context.

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?

The description is compact and front-loaded: the primary purpose appears in the first sentence, followed by a clear usage condition, pairing workflow, and relevant limits. Every sentence contributes meaningful information, and nothing is redundant with the schema or annotations.

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?

For a two-parameter tool with a rich schema and an output schema available, the description covers the essential context: when to use it, how to complete the workflow, and operational constraints like session limits and TTL. No critical guidance for calling the tool correctly is missing.

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 the parameters name and mode are already fully documented, including mode semantics and the constraint that name must refer to an existing site. The description itself adds no additional parameter-level explanation, so the baseline score of 3 is appropriate.

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?

The description clearly identifies the tool's function as opening a staging session for multi-call deploys, distinguishing it from single-call tools like deploy_site and update_site. It also explicitly maps the workflow with add_files or tarball upload, so the agent knows exactly what begin_deploy is for.

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?

The description gives an explicit usage condition: use when the site is too large for a single deploy_site/update_site call. It also spells out the required pairing sequence (add_files or tarball upload, then commit_deploy), leaving no ambiguity about when and how to use the tool.

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

All vibedeploy tools Inspect

Try in Browser

Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.