Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

UIResourceEvent.md

123 lines1.6 KB

Interface: UIResourceEvent

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

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

Extends

Indexable

[k: string]: unknown

Properties

model?

optional model: string;

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

Model identifier for multi-model support

Inherited from

CustomEvent.model


name

name: "ui-resource";

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

Overrides

CustomEvent.name

value

value: object;

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

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