Skip to main content

Interface: ToolDisplay<TInput>

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

How hosts show a tool's calls. Every member is optional: a host without one shows the tool's name in a generic card.

Type Parameters​

TInput​

TInput = unknown

Properties​

kind?​

optional kind?: ToolDisplayKind

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

Which renderer shows the call (see ToolDisplayKind).


title?​

optional title?: string

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

A human name for the tool, such as 'Read file'.

Methods​

headline()?​

optional headline(input): string | undefined

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

One line about a call, from its input, such as the path it reads.

Parameters​

input​

TInput

Returns​

string | undefined