Open History to see the last commit
1---
2id: ClientTool
3title: ClientTool
4---
5
6# Interface: ClientTool\<TInput, TOutput, TName\>
7
8Defined in: [activities/chat/tools/tool-definition.ts:23](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L23)
9
10Marker type for client-side tools
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### \_\_toolSide
29
30```ts
31__toolSide: "client";
32```
33
34Defined in: [activities/chat/tools/tool-definition.ts:28](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L28)
35
36***
37
38### description
39
40```ts
41description: string;
42```
43
44Defined in: [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)
45
46***
47
48### execute()?
49
50```ts
51optional execute: (args) =>
52 | InferSchemaType<TOutput>
53| Promise<InferSchemaType<TOutput>>;
54```
55
56Defined in: [activities/chat/tools/tool-definition.ts:35](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L35)
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: [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)
78
79***
80
81### metadata?
82
83```ts
84optional metadata: Record<string, any>;
85```
86
87Defined in: [activities/chat/tools/tool-definition.ts:34](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L34)
88
89***
90
91### name
92
93```ts
94name: TName;
95```
96
97Defined in: [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)
98
99***
100
101### needsApproval?
102
103```ts
104optional needsApproval: boolean;
105```
106
107Defined in: [activities/chat/tools/tool-definition.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L33)
108
109***
110
111### outputSchema?
112
113```ts
114optional outputSchema: TOutput;
115```
116
117Defined in: [activities/chat/tools/tool-definition.ts:32](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/tools/tool-definition.ts#L32)