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

ToolDefinitionConfig.md

94 lines2.5 KB

1---
2id: ToolDefinitionConfig
3title: ToolDefinitionConfig
4---
5​
6# Interface: ToolDefinitionConfig\<TInput, TOutput, TName\>
7​
8Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:95](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L95)
9​
10Tool definition configuration
11​
12## Type Parameters
13​
14### TInput
15​
16`TInput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = [`SchemaInput`](../type-aliases/SchemaInput.md)
17​
18### TOutput
19​
20`TOutput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = [`SchemaInput`](../type-aliases/SchemaInput.md)
21​
22### TName
23​
24`TName` *extends* `string` = `string`
25​
26## Properties
27​
28### description
29​
30```ts
31description: string;
32```
33​
34Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:101](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L101)
35​
36***
37​
38### inputSchema?
39​
40```ts
41optional inputSchema: TInput;
42```
43​
44Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:102](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L102)
45​
46***
47​
48### lazy?
49​
50```ts
51optional lazy: boolean;
52```
53​
54Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:105](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L105)
55​
56***
57​
58### metadata?
59​
60```ts
61optional metadata: Record<string, unknown>;
62```
63​
64Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:106](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L106)
65​
66***
67​
68### name
69​
70```ts
71name: TName;
72```
73​
74Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:100](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L100)
75​
76***
77​
78### needsApproval?
79​
80```ts
81optional needsApproval: boolean;
82```
83​
84Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:104](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L104)
85​
86***
87​
88### outputSchema?
89​
90```ts
91optional outputSchema: TOutput;
92```
93​
94Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:103](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L103)