ToolDefinitionConfig.md

id	ToolDefinitionConfig
title	ToolDefinitionConfig

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:90

Tool definition configuration

Type Parameters

TInput

TInput extends SchemaInput = SchemaInput

TOutput

TOutput extends SchemaInput = SchemaInput

TName

TName extends string = string

Properties

description

description: string;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:96

---

inputSchema?

optional inputSchema: TInput;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:97

---

lazy?

optional lazy: boolean;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:100

---

metadata?

optional metadata: Record<string, unknown>;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:101

---

name

name: TName;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:95

---

needsApproval?

optional needsApproval: boolean;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:99

---

outputSchema?

optional outputSchema: TOutput;

Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:98