Skip to main content
Glama

Get preview build status

get_preview
Read-only

Use this after start_build. If status is ready, send reply_template verbatim. Do not send a Stripe link, a plan, or mention a bar on the preview. If keep_polling is true or preview_url is null, call get_preview again. Do not start_build again.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
waitNoIf false, return the current snapshot immediately (progress card). Default true.
tokenYesToken returned by start_build. Pass the same token to get_preview and get_live_site.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
errorYes
tokenYes
statusYes
messageYes
preview_urlYes
keep_pollingYes
progress_pctYes
progress_labelYes
reply_templateYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / token / description
      Previous value: -"Token returned by start_build. Pass the same token to get_preview, create_checkout, and get_live_site."New value: +"Token returned by start_build. Pass the same token to get_preview and get_live_site."
  2. Changed2 schema fields changed
    • addedOutput schema / properties / reply_template
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "ok",
      -  "token",
      -  "status",
      -  "preview_url",
      -  "progress_label",
      -  "progress_pct",
      -  "error",
      -  "keep_polling",
      -  "message"
      -]New value: +[
      +  "ok",
      +  "token",
      +  "status",
      +  "preview_url",
      +  "progress_label",
      +  "progress_pct",
      +  "error",
      +  "keep_polling",
      +  "message",
      +  "reply_template"
      +]
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only and non-destructive behavior; the description adds useful operational context such as the ready-status handoff, verbatim reply_template, polling conditions, and forbidden follow-up content. It does not contradict the 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?

Five short sentences deliver the workflow in order: when to use, what to do when ready, what to avoid, when to retry, and what not to restart. Front-loading 'Use this after start_build' immediately grounds the agent; every sentence contributes.

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?

With a full output schema, detailed schema descriptions, and annotations, the description covers the essential workflow, polling condition, and post-return behavior. The only gap is that it never explains when to switch to the get_live_site sibling, which would make the surrounding context fully complete.

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?

The input schema already describes both wait and token in full (100% coverage), so the description does not need to repeat parameter details. It adds only the general 'after start_build' context rather than explaining wait or token semantics, 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.

Purpose4/5

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

The title and description make it clear this retrieves preview build status after start_build, and the status drives the next action. It is not a tautology and is distinct from start_build, though it never explicitly contrasts itself with get_live_site.

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?

The description gives explicit workflow guidance: use after start_build, poll again when keep_polling is true or preview_url is null, and do not start_build again. It does not mention get_live_site as a possible alternative, so the when-not-to-use guidance is incomplete for sibling differentiation.

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.

Resources