Show preferences panel MCP response
MCP tool response returned by the Show preferences panel MCP tool.
- Returned by: Show preferences panel MCP tool
- Response type: Structured app payload
Response Shape
The response includes the validated preferences-panel definition plus initial submitted-state fields.
Presentation identifiers are supplied in the normalized response even when omitted from the call. They are display identifiers; preserve any returned interactionId separately for Interaction state MCP tool.
| Field | Type | Notes |
|---|---|---|
id | string | Caller-provided or generated preferences-panel presentation identifier. |
| Preferences definition fields | mixed | Validated fields, sections, defaults, and labels from the live tool schema. |
interactionId | string | Generated preferences-panel interaction identifier. |
kind | string | preferences_panel. |
status | string | Initial interaction status, usually pending. |
isInteractive | boolean | Whether the user can submit preferences. |
submitted_state | string or null | saved after Save submits choices; historical receipts may contain cancelled. Starts as null. |
values | object or null | Submitted preference values. Starts as null. |
delivery | object, null, or absent | Optional canonical receipt after a new Save: version, transport, phase, message_id, attempt_id, and an acknowledgment source when available. Internal delivery state is not a render argument. Historical receipts omit it. |
Follow-up Behavior
Use Interaction state MCP response after Save. Changing controls alone does not create a submission. New panels have no Cancel action; historical cancellation receipts remain available.
Save records submitted_state: "saved" and normalized values, then the interaction waits in submitted for downstream handling. This receipt confirms recorded choices, not application of actual settings. Even completed means the interaction finished; verify any actual settings change through the authorized operation that performs it. A failed canonical save must not be reported as saved.
New submissions retain delivery state across panel reloads. In GovTribe, Retry sending resumes unfinished delivery without saving the choices again, and the server acknowledges its guarded assistant-turn start or confirmed message consumption without creating another message. Delivery acknowledgment does not confirm that settings changed. For an external host whose message outcome is unknown, the receipt asks the user to follow up manually in chat instead of offering an unsafe resend. Historical saved and cancelled receipts remain read-only and do not start a new delivery.
Example
{
"id": "capture-preferences",
"title": "Capture preferences",
"sections": [
{
"id": "notifications",
"label": "Notifications"
}
],
"interactionId": "preferences_panel:INTERACTION_ID",
"kind": "preferences_panel",
"status": "pending",
"isInteractive": true,
"submitted_state": null,
"values": null
}