UIResourceEvent

Defined in: packages/ai/src/types.ts:1857

Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into a UIResourcePart on the assistant UIMessage. Never enters model input.

Extends#

• CustomEvent

Properties#

metadata?#

optional metadata?: Record<string, any>;

Defined in: packages/ai/src/types.ts:1814

Extra information attached to this event.

Inherited from#

CustomEvent.metadata

name#

name: "ui-resource";

Defined in: packages/ai/src/types.ts:1858

What this custom event is. Required: without it a consumer cannot route the value.

Overrides#

CustomEvent.name

type#

type: "CUSTOM";

Defined in: packages/ai/src/types.ts:1813

Inherited from#

CustomEvent.type

value#

value: object;

Defined in: packages/ai/src/types.ts:1859

The payload. Any JSON value, and required.

meta?#

optional meta?: Record<string, unknown>;

resource#

resource: object;

resource.blob?#

optional blob?: string;

resource.mimeType#

mimeType: string;

resource.text?#

optional text?: string;

resource.uri#

uri: string;

serverId?#

optional serverId?: string;

toolCallId#

toolCallId: string;

toolName#

toolName: string;

Overrides#

CustomEvent.value