Open History to see the last commit
1---
2id: ClientTool
3title: ClientTool
4---
5
6# Interface: ClientTool\<TInput, TOutput, TName, TContext, TNeedsApproval\>
7
8Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:24](https://github.com/TanStack/ai/blob/main/packages/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### TContext
27
28`TContext` = `unknown`
29
30### TNeedsApproval
31
32`TNeedsApproval` *extends* `boolean` = `false`
33
34## Properties
35
36### \_\_toolSide
37
38```ts
39__toolSide: "client";
40```
41
42Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L34)
43
44***
45
46### description
47
48```ts
49description: string;
50```
51
52Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L36)
53
54***
55
56### execute?
57
58```ts
59optional execute: ToolExecuteFunction<TInput, TOutput, TContext>;
60```
61
62Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L47)
63
64***
65
66### inputSchema?
67
68```ts
69optional inputSchema: TInput;
70```
71
72Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L42)
73
74***
75
76### lazy?
77
78```ts
79optional lazy: boolean;
80```
81
82Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L45)
83
84***
85
86### metadata?
87
88```ts
89optional metadata: Record<string, unknown>;
90```
91
92Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L46)
93
94***
95
96### name
97
98```ts
99name: TName;
100```
101
102Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L35)
103
104***
105
106### needsApproval?
107
108```ts
109optional needsApproval: TNeedsApproval;
110```
111
112Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L44)
113
114***
115
116### outputSchema?
117
118```ts
119optional outputSchema: TOutput;
120```
121
122Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L43)