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

ClientTool.md

127 lines3.3 KB

1---
2id: ClientTool
3title: ClientTool
4---
5​
6# Interface: ClientTool\<TInput, TOutput, TName\>
7​
8Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:24](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L24)
9​
10Marker type for client-side tools
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### \_\_toolSide
29​
30```ts
31__toolSide: "client";
32```
33​
34Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:29](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L29)
35​
36***
37​
38### description
39​
40```ts
41description: string;
42```
43​
44Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:31](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L31)
45​
46***
47​
48### execute()?
49​
50```ts
51optional execute: (args) =>
52 | InferSchemaType<TOutput>
53| Promise<InferSchemaType<TOutput>>;
54```
55​
56Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:42](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L42)
57​
58#### Parameters
59​
60##### args
61​
62[`InferSchemaType`](../type-aliases/InferSchemaType.md)\<`TInput`\>
63​
64#### Returns
65​
66 \| [`InferSchemaType`](../type-aliases/InferSchemaType.md)\<`TOutput`\>
67 \| `Promise`\<[`InferSchemaType`](../type-aliases/InferSchemaType.md)\<`TOutput`\>\>
68​
69***
70​
71### inputSchema?
72​
73```ts
74optional inputSchema: TInput;
75```
76​
77Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:37](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L37)
78​
79***
80​
81### lazy?
82​
83```ts
84optional lazy: boolean;
85```
86​
87Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:40](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L40)
88​
89***
90​
91### metadata?
92​
93```ts
94optional metadata: Record<string, unknown>;
95```
96​
97Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:41](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L41)
98​
99***
100​
101### name
102​
103```ts
104name: TName;
105```
106​
107Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:30](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L30)
108​
109***
110​
111### needsApproval?
112​
113```ts
114optional needsApproval: boolean;
115```
116​
117Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:39](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L39)
118​
119***
120​
121### outputSchema?
122​
123```ts
124optional outputSchema: TOutput;
125```
126​
127Defined in: [packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:38](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L38)