Skip to main content
Glama

deploy_application

DestructiveIdempotent

Publish the workspace to its bots — the API equivalent of the dashboard's Deploy button. This is the step that makes edits live. apply_actions writes to the DRAFT graph. Until this runs the connected bots keep serving the previously published version, so a change that looks applied has no effect for real users. Deploy after a batch of edits (and after run_flow_autotest passes), not after every single action. Publishes the ACTIVE version to every active bot of the application; pass botIds to publish to a subset. Every publish is kept as a release (list_releases); restore_release puts an earlier one back. Delivery is asynchronous: a bot listed as "queued" was handed to the deploy queue, not confirmed restarted. Returns { deployed, versionId, bots[], queuedCount, failedCount, error } — check error and each bot's status, because a version can be marked published while no runtime received it. Safe to repeat: deploying twice republishes the same version rather than duplicating anything. It does change what real users see, so confirm with the user before publishing edits they have not reviewed. Requires the manage_automation permission.

Input Schema

NameRequiredDescriptionDefault
botIdsNoPublish only to these bots. Omit to publish to every active bot of the application (the dashboard default). Ids that are not active, non-preview bots of this application are reported back in unknownBotIds and otherwise ignored.
applicationIdNoApplication (workspace) id. Optional: an application-scoped key (app_...) defaults to its own application, but a personal key (usr_...) has no default and omitting it fails with MCP_APPLICATION_REQUIRED. Call list_applications to get the id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description discloses that delivery is asynchronous, that a status of queued does not mean a runtime was restarted, that a version can be marked published while no runtime received it, and that callers must check error and per-bot status. It also explains idempotent repeat behavior and states the required manage_automation permission. These details are consistent with the destructiveHint=true and idempotentHint=true annotations.

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?

Although the description is longer than average, it is front-loaded with the core action and every sentence contributes operational value for a destructive, asynchronous deploy operation. There is no filler.

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?

With no output schema, the description supplies the return shape, key fields to inspect, asynchronous status caveats, and permission requirements. Combined with annotations, it gives an agent everything needed to invoke and interpret the tool 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 description coverage is 100%, so both parameters are already well documented in the schema. The description reinforces botIds subset publishing and default all-active-bot behavior, but adds little beyond what the schema provides for applicationId.

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 states a specific verb and resource: publishing the workspace to its bots, explicitly framed as the API equivalent of the dashboard Deploy button. It also distinguishes the tool from apply_actions by explaining that apply_actions writes to the draft graph while this makes edits live.

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?

It gives explicit timing guidance: deploy after a batch of edits and after run_flow_autotest passes, not after every action. It names related tools and alternatives (apply_actions, run_flow_autotest, list_releases, restore_release) and advises confirming with the user before publishing unreviewed edits.

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.