Plan UI states for a surface
get_ui_state_planPlan required UI states for any surface including data-table, form, checkout, chat, and developer-console. Get triggers, accessibility, motion guidance, and implementation order for non-happy-path conditions.
Instructions
For a surface (data-table, form, checkout, chat, developer-console), return required / recommended / domain-specific states with triggers, must-show, must-not, accessibility and motion guidance, plus an implementation order. Covers the non-happy-path.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"surfaceId": "<surfaceId>"
},
"name": "get_ui_state_plan"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locale | No | ||
| styleId | No | optional catalog style id (see webstylebook://styles) to tailor state guidance | |
| surfaceId | Yes | surface id — one of: data-table | form | checkout | chat | developer-console | |
| criticalOnly | No | ||
| domainSignals | No | ||
| productContext | No | ||
| includeCategories | No |