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

ToolDefinitionConfig.md

84 lines2.0 KB

1---
2id: ToolDefinitionConfig
3title: ToolDefinitionConfig
4---
5​
6# Interface: ToolDefinitionConfig\<TInput, TOutput, TName\>
7​
8Defined in: [activities/chat/tools/tool-definition.ts:88](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L88)
9​
10Tool definition configuration
11​
12## Type Parameters
13​
14### TInput
15​
16`TInput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = `z.ZodType`
17​
18### TOutput
19​
20`TOutput` *extends* [`SchemaInput`](../type-aliases/SchemaInput.md) = `z.ZodType`
21​
22### TName
23​
24`TName` *extends* `string` = `string`
25​
26## Properties
27​
28### description
29​
30```ts
31description: string;
32```
33​
34Defined in: [activities/chat/tools/tool-definition.ts:94](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L94)
35​
36***
37​
38### inputSchema?
39​
40```ts
41optional inputSchema: TInput;
42```
43​
44Defined in: [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)
45​
46***
47​
48### metadata?
49​
50```ts
51optional metadata: Record<string, any>;
52```
53​
54Defined in: [activities/chat/tools/tool-definition.ts:98](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L98)
55​
56***
57​
58### name
59​
60```ts
61name: TName;
62```
63​
64Defined in: [activities/chat/tools/tool-definition.ts:93](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L93)
65​
66***
67​
68### needsApproval?
69​
70```ts
71optional needsApproval: boolean;
72```
73​
74Defined in: [activities/chat/tools/tool-definition.ts:97](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L97)
75​
76***
77​
78### outputSchema?
79​
80```ts
81optional outputSchema: TOutput;
82```
83​
84Defined in: [activities/chat/tools/tool-definition.ts:96](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L96)