Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Persistence (Advanced)
Embeddings
Reranking
Evaluate
Sandboxes (Advanced)
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

ClientTool

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

Marker type for client-side tools

Extends

  • ToolApprovalCapabilityMarker<TNeedsApproval, TApprovalSchema>

Type Parameters

TInput

TInput extends SchemaInput | undefined = undefined

TOutput

TOutput extends SchemaInput | undefined = undefined

TName

TName extends string = string

TContext

TContext = unknown

TNeedsApproval

TNeedsApproval extends boolean = false

TApprovalSchema

TApprovalSchema extends | ApprovalSchemaConfig | undefined = undefined

Properties

__toolSide

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

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


[toolApprovalCapability]?

ts
readonly optional [toolApprovalCapability]?: object;
readonly optional [toolApprovalCapability]?: object;

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

approvalSchema

ts
approvalSchema: TApprovalSchema;
approvalSchema: TApprovalSchema;

needsApproval

ts
needsApproval: TNeedsApproval;
needsApproval: TNeedsApproval;

Inherited from

ts
ToolApprovalCapabilityMarker.[toolApprovalCapability]
ToolApprovalCapabilityMarker.[toolApprovalCapability]

approvalSchema?

ts
optional approvalSchema?: TApprovalSchema;
optional approvalSchema?: TApprovalSchema;

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


description

ts
description: string;
description: string;

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


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:135


execution?

ts
optional execution?: "task";
optional execution?: "task";

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


inputSchema?

ts
optional inputSchema?: TInput;
optional inputSchema?: TInput;

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


lazy?

ts
optional lazy?: boolean;
optional lazy?: boolean;

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


metadata?

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

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


name

ts
name: TName;
name: TName;

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


needsApproval?

ts
optional needsApproval?: TNeedsApproval;
optional needsApproval?: TNeedsApproval;

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


outputSchema?

ts
optional outputSchema?: TOutput;
optional outputSchema?: TOutput;

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


replay?

ts
optional replay?: "safe" | "never";
optional replay?: "safe" | "never";

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