ui_builder_branch_design
Fork a design at a revision into a branch to explore an alternative, or to change it without trampling somebody editing it live. A branch is a design with its own id: edit it with ui_builder_apply, look at it with ui_builder_view or ui_builder_get_design, compare it with ui_builder_diff_designs, then bring it back with ui_builder_merge_branch or drop it with ui_builder_archive_branch. Branch N times from the same revision to try N alternatives: merging one archives the others. Branches of a branch are refused; so are asset uploads, restores and document replacements on a branch. Needs write access to the design.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | What this alternative is, e.g. `compact header`. | |
| token | No | A 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. | |
| branchId | No | The branch's design id. Defaults to one minted from the parent's; naming one makes a retry idempotent. | |
| designId | Yes | The design to branch. | |
| revision | No | A retained revision to fork at. Omit for the current one. | |
| agentName | No | Optional agent/client name shown to design viewers; self-reported. | |
| agentModel | No | Optional current model name shown to design viewers; self-reported. Omit when unknown. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| branch | Yes | ||
| schema | Yes | ||
| summary | Yes |