Documentation
Framework
Version
Class References
Function References
Interface References
Type Alias References
Variable References

ClientTool

Interface: ClientTool<TInput, TOutput, TName>

Defined in: tools/tool-definition.ts:18

Marker type for client-side tools

Type Parameters

TInput

TInput extends z.ZodType = z.ZodType

TOutput

TOutput extends z.ZodType = z.ZodType

TName

TName extends string = string

Properties

__toolSide

ts
__toolSide: "client";
__toolSide: "client";

Defined in: tools/tool-definition.ts:23


description

ts
description: string;
description: string;

Defined in: tools/tool-definition.ts:25


execute()?

ts
optional execute: (args) => output<TOutput> | Promise<output<TOutput>>;
optional execute: (args) => output<TOutput> | Promise<output<TOutput>>;

Defined in: tools/tool-definition.ts:30

Parameters

args

output<TInput>

Returns

output<TOutput> | Promise<output<TOutput>>


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

Defined in: tools/tool-definition.ts:26


metadata?

ts
optional metadata: Record<string, any>;
optional metadata: Record<string, any>;

Defined in: tools/tool-definition.ts:29


name

ts
name: TName;
name: TName;

Defined in: tools/tool-definition.ts:24


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

Defined in: tools/tool-definition.ts:28


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

Defined in: tools/tool-definition.ts:27