Docs
CodeRabbit
Cloudflare
Railway
Netlify
WorkOS
OpenRouter
SerpAPI
Clerk
AG Grid
Prisma
Electric
Unkey
Sentry
CodeRabbit
Cloudflare
Railway
Netlify
WorkOS
OpenRouter
SerpAPI
Clerk
AG Grid
Prisma
Electric
Unkey
Sentry
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

ClientTool

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

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

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

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


description

ts
description: string;
description: string;

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


execute?

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

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


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

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


lazy?

ts
optional lazy: boolean;
optional lazy: boolean;

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


metadata?

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

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


name

ts
name: TName;
name: TName;

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


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

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


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

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