Skip to main content

Function: toolDisplayMetadata()

toolDisplayMetadata(tool): { display: ToolCallDisplay; } | undefined

Defined in: packages/core/src/utils/tools.ts:274

The tool's display in AI SDK's tool metadata shape. AI SDK copies a tool's metadata onto every part of its calls (toolMetadata), UI message parts included, so a host that renders AI SDK parts reads the title and kind from there. The headline depends on the call, so it is not included.

Parameters​

tool​

unknown

Returns​

{ display: ToolCallDisplay; } | undefined