TanStack
Interface References

ClientTool

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

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

TResultMetadataSchema

TResultMetadataSchema extends SchemaInput | undefined = SchemaInput | undefined

Properties

__toolSide

ts
__toolSide: "client";

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


[toolApprovalCapability]?

ts
readonly optional [toolApprovalCapability]?: object;

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

approvalSchema

ts
approvalSchema: TApprovalSchema;

needsApproval

ts
needsApproval: TNeedsApproval;

Inherited from

ts
ToolApprovalCapabilityMarker.[toolApprovalCapability]

approvalSchema?

ts
optional approvalSchema?: TApprovalSchema;

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


description

ts
description: string;

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


execute?

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

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


execution?

ts
optional execution?: "task";

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


inputSchema?

ts
optional inputSchema?: TInput;

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


lazy?

ts
optional lazy?: boolean;

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


metadata?

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

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


name

ts
name: TName;

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


needsApproval?

ts
optional needsApproval?: TNeedsApproval;

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


outputSchema?

ts
optional outputSchema?: TOutput;

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


replay?

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

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


resultMetadataSchema?

ts
optional resultMetadataSchema?: TResultMetadataSchema;

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