Docs
CodeRabbit
Cloudflare
Railway
SerpAPI
Clerk
WorkOS
Netlify
OpenRouter
AG Grid
Electric
Prisma
Unkey
Sentry
CodeRabbit
Cloudflare
Railway
SerpAPI
Clerk
WorkOS
Netlify
OpenRouter
AG Grid
Electric
Prisma
Unkey
Sentry
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

ToolDefinitionConfig

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

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

Tool definition configuration

Type Parameters

TInput

TInput extends SchemaInput = SchemaInput

TOutput

TOutput extends SchemaInput = SchemaInput

TName

TName extends string = string

Properties

description

ts
description: string;
description: string;

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


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

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


lazy?

ts
optional lazy: boolean;
optional lazy: boolean;

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


metadata?

ts
optional metadata: Record<string, unknown>;
optional metadata: Record<string, unknown>;

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


name

ts
name: TName;
name: TName;

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


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

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


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

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