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

ClientTool.md

122 lines2.9 KB

Interface: ClientTool<TInput, TOutput, TName, TContext, TNeedsApproval>

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

TNeedsApproval

TNeedsApproval extends boolean = false

Properties

__toolSide

__toolSide: "client";

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


description

description: string;

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


execute?

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

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


inputSchema?

optional inputSchema: TInput;

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


lazy?

optional lazy: boolean;

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


metadata?

optional metadata: Record<string, unknown>;

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


name

name: TName;

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


needsApproval?

optional needsApproval: TNeedsApproval;

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


outputSchema?

optional outputSchema: TOutput;

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