agentskit.js

ToolDefinition

Auto-generated API reference for ToolDefinition.

Interface: ToolDefinition<TArgs>

Defined in: core/dist/message-BYnZOrx0.d.ts:126

#Type Parameters

#TArgs

TArgs = Record<string, unknown>

#Properties

#category?

optional category?: string

Defined in: core/dist/message-BYnZOrx0.d.ts:135


#description?

optional description?: string

Defined in: core/dist/message-BYnZOrx0.d.ts:128


#dispose?

optional dispose?: () => MaybePromise<void>

Defined in: core/dist/message-BYnZOrx0.d.ts:133

#Returns

MaybePromise<void>


#execute?

optional execute?: (args, context) => unknown

Defined in: core/dist/message-BYnZOrx0.d.ts:131

#Parameters

args

TArgs

context

ToolExecutionContext

#Returns

unknown


#init?

optional init?: () => MaybePromise<void>

Defined in: core/dist/message-BYnZOrx0.d.ts:132

#Returns

MaybePromise<void>


#name

name: string

Defined in: core/dist/message-BYnZOrx0.d.ts:127


#requiresConfirmation?

optional requiresConfirmation?: boolean

Defined in: core/dist/message-BYnZOrx0.d.ts:130


#schema?

optional schema?: JSONSchema7

Defined in: core/dist/message-BYnZOrx0.d.ts:129


#tags?

optional tags?: string[]

Defined in: core/dist/message-BYnZOrx0.d.ts:134

Explore nearby

✎ Edit this page on GitHubΒ·Found a problem? Open an issue β†’Β·How to contribute β†’

On this page