Skip to main content
Glama

Compose Preview Catalogs

ui_builder_await_design

Wait for somebody else to change a design and return what they changed, rather than asking again whether they have. Returns the moment a designer in the browser or another agent commits an edit, as the same update frame the browser's own live socket receives; returns a timedOut reply if nothing happens within waitSeconds, which you answer by calling again with the same cursor. Quote as afterSequence the throughSequence of the delta you last received, or the lastSequence of the last snapshot; a cursor the server no longer retains is answered with a whole snapshot instead of the operations you missed. waitSeconds: 0 checks without blocking. Nothing is lost between calls — the cursor is replayed when you call again — so somebody merely looking at the design does not wake you, and only a committed change does.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenNoA grant token from poll_access, when you cannot set the X-Compose-Preview-Token header yourself — an MCP client fixes its headers at connect time, so this is how a token approved during this session is used in it. Prefer the header where you control it.
designIdYes
waitSecondsNoUp to 120. Defaults to 25.
afterSequenceYesThe `lastSequence` you last saw, from ui_builder_get_design or a previous wait.
includeCatalogNoWhen the reply is a whole snapshot, embed the pinned catalog in it. Defaults to false.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so well: it discloses the `timedOut` reply, that a non-retained cursor yields a whole snapshot instead of missed ops, that nothing is lost between calls via cursor replay, and that mere viewing does not trigger a wake. These are exactly the behavioral traits an agent needs for a blocking/long-poll tool.

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?

The purpose is front-loaded in the first clause, and nearly every sentence adds actionable detail. It is a dense, somewhat run-on paragraph of many chained clauses, but the information density is warranted rather than padding.

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 not be explained, yet the description still covers the timeout, snapshot fallback, and cursor-replay edge cases an agent must handle. Nothing needed to drive the polling loop correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 80%, so the baseline is 3, and the description adds real semantics beyond the schema: it clarifies that `afterSequence` should be the delta's `throughSequence` or a snapshot's `lastSequence`, and that `waitSeconds: 0` is a non-blocking poll. It does less for `includeCatalog` and `token`, which the schema already documents.

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 ('Wait for somebody else to change a design and return what they changed') and immediately contrasts it with the alternative behavior ('rather than asking again whether they have'). An agent can distinguish this long-poll from ui_builder_get_design or ui_builder_await_comments without opening a 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?

Gives explicit operational guidance: call again with the same cursor after a timeout, use `waitSeconds: 0` for a non-blocking check, and quote `afterSequence` from the delta's `throughSequence` or a snapshot's `lastSequence`. It also covers the stale-cursor case and the fact that only committed changes wake the caller, so the when/when-not conditions are spelled out rather than inferred.

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.