Skip to main content
Glama

Compose Preview Catalogs

ui_builder_create_design

Create a design, either from a whole document you supply or by copying an existing design named by fromDesignId. Copying is usually right: a document's catalogPin must match a catalog revision this server serves, and a copy carries one that does. A document whose home is an existing design on this server is refused with a compose-preview-decision/v1 choice to put to the person — or, when your client supports form elicitation on this connection, the person is asked in a form and the call acts on their answer.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNo
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.
designIdYesThe id for the new design.
documentNoA whole DesignDocumentV1.
fromDesignIdNoCopy this design's document instead.
includeCatalogNoEmbed the pinned catalog in the returned snapshot. 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 refusal behavior for documents whose home is an existing design, the `compose-preview-decision/v1` choice returned to the person, and the form-elicitation fallback path. It does not mention permissions/auth requirements beyond what the `token` param schema covers.

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 action is front-loaded and each sentence adds information (mode choice, copy rationale, refusal/elicitation behavior). It is somewhat dense with backtick-heavy phrasing, but nothing is wasted.

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 no explanation, and the description covers the creation semantics, the catalogPin constraint, and the refusal/elicitation behavior for a mutation tool with no annotations. Adequate for correct invocation, though auth/permission context is left implicit.

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 high (83%), so the baseline is 3, but the description adds genuine semantic value: it explains the relationship and trade-off between `document` and `fromDesignId` (the catalogPin constraint) that the schema merely names, guiding correct parameter choice.

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 (Create) and resource (a design), and immediately distinguishes its two modes of creation via `document` vs `fromDesignId`. This separates it from siblings like ui_builder_replace_design_document and ui_builder_get_design without the agent needing to open any 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?

It gives explicit guidance that 'Copying is usually right' and explains why a supplied document can be refused when its `home` is an existing design on the server. It provides clear conditions for choosing a path, though it does not name sibling alternatives (e.g., replace_design_document) for the update case.

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.