Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:113
Marker type for client-side tools
TInput extends SchemaInput | undefined = undefined
TOutput extends SchemaInput | undefined = undefined
TName extends string = string
TContext = unknown
TNeedsApproval extends boolean = false
TApprovalSchema extends | ApprovalSchemaConfig | undefined = undefined
TResultMetadataSchema extends SchemaInput | undefined = SchemaInput | undefined
__toolSide: "client";Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:127
readonly optional [toolApprovalCapability]?: object;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:27
approvalSchema: TApprovalSchema;needsApproval: TNeedsApproval;ToolApprovalCapabilityMarker.[toolApprovalCapability]optional approvalSchema?: TApprovalSchema;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:138
description: string;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:129
optional execute?: ToolExecuteFunction<TInput, TOutput, TContext, never>;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:146
optional execution?: "task";Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:139
optional inputSchema?: TInput;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:135
optional lazy?: boolean;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:140
optional metadata?: Record<string, unknown>;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:142
name: TName;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:128
optional needsApproval?: TNeedsApproval;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:137
optional outputSchema?: TOutput;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:136
optional replay?: "safe" | "never";Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:141
optional resultMetadataSchema?: TResultMetadataSchema;Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:143