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#

__toolSide: "client";

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

[toolApprovalCapability]?#

readonly optional [toolApprovalCapability]?: object;

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

approvalSchema#

approvalSchema: TApprovalSchema;

needsApproval#

needsApproval: TNeedsApproval;

Inherited from#

ToolApprovalCapabilityMarker.[toolApprovalCapability]

approvalSchema?#

optional approvalSchema?: TApprovalSchema;

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

description#

description: string;

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

execute?#

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

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

execution?#

optional execution?: "task";

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

inputSchema?#

optional inputSchema?: TInput;

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

lazy?#

optional lazy?: boolean;

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

metadata?#

optional metadata?: Record<string, unknown>;

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

name#

name: TName;

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

needsApproval?#

optional needsApproval?: TNeedsApproval;

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

outputSchema?#

optional outputSchema?: TOutput;

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

replay?#

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

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