Interface: ClientTool\#

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:24

Marker type for client-side tools

Type Parameters#

TInput#

TInput extends SchemaInput = SchemaInput

TOutput#

TOutput extends SchemaInput = SchemaInput

TName#

TName extends string = string

TContext#

TContext = unknown

Properties#

__toolSide#

__toolSide: "client";

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:30

description#

description: string;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:32

execute?#

optional execute: ToolExecuteFunction<TInput, TOutput, TContext>;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:43

inputSchema?#

optional inputSchema: TInput;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:38

lazy?#

optional lazy: boolean;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:41

metadata?#

optional metadata: Record<string, unknown>;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:42

name#

name: TName;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:31

needsApproval?#

optional needsApproval: boolean;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:40

outputSchema?#

optional outputSchema: TOutput;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:39