Interface: UIResourceEvent#

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

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#

model?#

optional model?: string;

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

Model identifier for multi-model support

Inherited from#

CustomEvent.model

name#

name: "ui-resource";

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

Overrides#

CustomEvent.name

runId?#

optional runId?: string;

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

Inherited from#

CustomEvent.runId

threadId?#

optional threadId?: string;

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

Routing metadata the TanStack engine attaches when emitting CUSTOM events that need to be correlated with a specific thread/run. Stripped by strip-to-spec-middleware before going on the wire so the AG-UI consumer never sees them (when that middleware is enabled).

Inherited from#

CustomEvent.threadId

type#

type: "CUSTOM";

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

Inherited from#

CustomEvent.type

value#

value: object;

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

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