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

ToolDefinitionConfig

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

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

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/typescript/ai/src/activities/chat/tools/tool-definition.ts:101


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

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


lazy?

ts
optional lazy: boolean;
optional lazy: boolean;

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


metadata?

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

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


name

ts
name: TName;
name: TName;

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


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

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


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

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