Struct WidgetResponseMeta 

pub struct WidgetResponseMeta {
    pub close_widget: Option<bool>,
    pub widget_session_id: Option<String>,
}

Available on crate feature mcp-apps only.

Metadata for tool responses in ChatGPT Apps.

These fields control widget behavior after a tool response is received. They are included in the _meta field of CallToolResult.

Example

use pmcp::types::mcp_apps::WidgetResponseMeta;

// Close the widget after this response
let meta = WidgetResponseMeta::new()
    .close_widget(true)
    .widget_session_id("session-abc123");

Fields

close_widget: Option<bool>

Close the widget when this response arrives.

When set to true, ChatGPT will hide the widget after processing this tool response. Useful for “done” or “cancel” actions.

widget_session_id: Option<String>

Widget session ID for correlating tool calls.

This ID is unique per widget instance and can be used to correlate multiple tool calls from the same widget session for logging or analytics.

Implementations

impl WidgetResponseMeta

pub fn new() -> Self

Create empty response metadata.

pub fn close_widget(self, close: bool) -> Self

Set whether to close the widget.

pub fn widget_session_id(self, id: impl Into<String>) -> Self

Set the widget session ID.

pub fn to_meta_map(&self) -> Map<String, Value>

Convert to a serde_json::Map for merging into tool result _meta.

pub fn is_empty(&self) -> bool

Check if the metadata is empty (all fields are None).

Trait Implementations

impl Clone for WidgetResponseMeta

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetResponseMeta

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WidgetResponseMeta

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WidgetResponseMeta

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WidgetResponseMeta

Available on crate feature schema-generation only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for WidgetResponseMeta

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for WidgetResponseMeta

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WidgetResponseMeta