Skip to main content
Glama

Deploy a block as an HTTP endpoint

deploy_endpoint
Destructive

Publishes a workspace block as a live HTTP API endpoint or site page in a domain; preview first, then confirm to deploy, with isAnonymous for public access.

Instructions

Publishes a workspace's block as a live HTTP API endpoint — or a page of a site — in the given domain. Powerful: requires confirm=true — first call WITHOUT confirm to preview, then again with confirm:true. Anything meant to be publicly reachable needs isAnonymous:true.

An endpoint serves the workspace AUTO-SAVE — the canvas, live — under the version label "head". Editing a block changes what the URL answers immediately: no redeploy, and committing does not freeze it. That is the OPPOSITE of create_schedule, which pins a committed version and keeps running it, so one block can serve new code over HTTP while a cron on the same block still runs the old one. Name which of the two you mean whenever a user asks why a change "did not take". (commit_workspace_version does archive a copy of each deployed path at its own version label, but those copies are created disabled — nothing changes at the live URL.)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspaceId": "<workspaceId>",
      "blockId": "<blockId>",
      "domainId": "<domainId>",
      "path": "<path>"
    },
    "name": "deploy_endpoint"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesEndpoint path, e.g. "orders". A path may be a FILE NAME ("index.html", "sitemap.xml"), and "/" deploys at the domain ROOT — https://api.qu4zr.io/{slug}/ — which is where a site's home page belongs. Avoid a first folder that looks like a version label ("v1", "latest", "dev"…): the gateway reads that segment as a version, not a folder.
notesNo
blockIdYes
confirmNoMust be true to deploy. Omit/false returns a preview only.
domainIdYesTarget API domain id — call list_domains to find it (owned by the workspace owner).
isAnonymousNo
workspaceIdYes
allowedVerbsNo
detailedOutputNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.53.0

TDQS

A4.3/5.0
Behavior5/5

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

Annotations only declare destructiveHint=true, yet the description discloses the safety pattern (preview-then-confirm), the durability model (the endpoint serves the live AUTO-SAVE, edits take effect with no redeploy), and how paths are archived disabled by commit_workspace_version. It also warns that commit does not freeze the URL, which is exactly the kind of consequence an agent needs before a destructive publish.

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?

Front-loads the action in the first clause, then layers the confirm protocol and the versioning contrast. Dense but largely earned; the long parenthetical on commit_workspace_version is the one segment that runs past what a caller needs at selection time.

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 destructive publish with no output schema, the description supplies the operational model, the confirmation ritual and the public-exposure rule. The remaining shortfall is the undocumented optional knobs (allowedVerbs, detailedOutput, notes), which affect behavior and are covered by neither schema nor prose.

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 only 33% across 9 parameters, and the description compensates for the two most consequential ones (confirm, isAnonymous) plus the head/auto-save meaning of the deployed path. Parameters such as notes, allowedVerbs and detailedOutput receive no explanation anywhere, leaving real gaps for a 9-parameter call.

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 — 'Publishes a workspace's block as a live HTTP API endpoint — or a page of a site — in the given domain.' It then explicitly distinguishes the tool from create_schedule and commit_workspace_version, so an agent can separate the three without opening their schemas.

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?

Gives a clear two-step protocol (call without confirm for a preview, then with confirm:true) and a conditional rule ('anything meant to be publicly reachable needs isAnonymous:true'). What is missing is routing guidance against the direct siblings update_endpoint, toggle_endpoint and delete_endpoint, which a caller could plausibly confuse with this tool.

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