Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ToolDefinitionConfig.md

94 lines2.5 KB

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

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

Tool definition configuration

Type Parameters

TInput

TInput extends SchemaInput = SchemaInput

TOutput

TOutput extends SchemaInput = SchemaInput

TName

TName extends string = string

Properties

description

description: string;

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


inputSchema?

optional inputSchema: TInput;

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


lazy?

optional lazy: boolean;

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


metadata?

optional metadata: Record<string, unknown>;

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


name

name: TName;

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


needsApproval?

optional needsApproval: boolean;

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


outputSchema?

optional outputSchema: TOutput;

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