0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/ClientTool.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

3.9 KiB

id title
ClientTool ClientTool

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

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

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


[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:129


description

description: string;

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


execute?

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

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


inputSchema?

optional inputSchema?: TInput;

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


lazy?

optional lazy?: boolean;

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


metadata?

optional metadata?: Record<string, unknown>;

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


name

name: TName;

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


needsApproval?

optional needsApproval?: TNeedsApproval;

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


outputSchema?

optional outputSchema?: TOutput;

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