Skip to main content
Glama

Compose Preview Catalogs

ui_builder_get_design

Read one design: its whole document — nodes, slots, properties, modifiers, state variables and catalog pin — plus the revision to quote as baseRevision when editing it. The catalog the design pins is left out unless includeCatalog is true: it is the same for every design on the pin, ui_builder_list_catalogs serves it, and it is most of the bytes. On hosts with design discussions, unacknowledgedComments is the number of comment threads this actor has not acknowledged; a nonzero count also carries the bounded comments notice.

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
revisionNoA past revision. Omit for the current one.
includeCatalogNoEmbed the pinned catalog's whole CatalogCapabilityV1 in the snapshot, as the released shape does. 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.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the default omission of the catalog, the size cost, the presence of unacknowledgedComments on discussion hosts, and that a nonzero count carries a bounded comments notice. It stops short of stating permissions/auth needs or pagination/limits, so it is strong but not exhaustive.

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-loaded with the core purpose and return contents, then conditional behavior. Dense but every clause carries information; a couple of the later sentences are long, though none are filler.

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?

An output schema exists, so return values need not be detailed, yet the description still names the returned document parts and the conditional comments field, making the tool callable and interpretable. The only missing element is auth/permission context for a read against designs.

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 75%, and the description adds real meaning beyond it: it explains why includeCatalog defaults to false and where the catalog is served instead, and it frames the revision parameter by tying it to baseRevision quoting for edits. designId is trivial and token is documented in the schema, so the remaining gap is minor.

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 ('Read one design') and enumerates exactly what the read returns — nodes, slots, properties, modifiers, state variables, catalog pin, and the revision for baseRevision. This distinguishes it cleanly from ui_builder_list_designs and ui_builder_view without needing to open 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear conditional guidance for includeCatalog (omit the catalog by default because it is identical per pin and byte-heavy; use ui_builder_list_catalogs instead) and explains the baseRevision purpose for subsequent edits. It does not explicitly contrast against ui_builder_view or ui_builder_await_design, so no hard when-not guidance.

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.