HtmlWidgetPayload Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The JSON payload for an HTML widget, sent inside a ```html-widget code block within a Markdown message.
public class HtmlWidgetPayloadtype HtmlWidgetPayload = classPublic Class HtmlWidgetPayload- Inheritance
-
HtmlWidgetPayload
Constructors
| Name | Description |
|---|---|
| HtmlWidgetPayload() | |
Properties
| Name | Description |
|---|---|
| Description |
A description of the MCP app. |
| Domain |
The domain associated with the widget, applied to sandbox metadata. Must be a valid domain URL (e.g. 'https://example.com'). This is informational metadata, not a verified identity claim. The platform does not authenticate this value. |
| Html |
The HTML content that makes up the widget. |
| Name |
The display name of the MCP app. |
| Permissions |
Optional permissions the widget requests from the host. |
| SecurityPolicy |
Optional security policy controlling allowed origins. |
| ToolInput |
Optional data that was passed as input to the tool that produced this widget. |
| ToolOutput |
Optional data that the tool produced alongside this widget. |
| Type |
The widget type identifier. Currently only "widget/mcp-ui" is supported. |