ToolDefinition
Auto-generated API reference for ToolDefinition.
Interface: ToolDefinition<TArgs>
Defined in: packages/core/src/types/tool.ts:69
#Type Parameters
#TArgs
TArgs = Record<string, unknown>
#Properties
#category?
optionalcategory?:string
Defined in: packages/core/src/types/tool.ts:81
#description?
optionaldescription?:string
Defined in: packages/core/src/types/tool.ts:71
#dispose?
optionaldispose?: () =>MaybePromise<void>
Defined in: packages/core/src/types/tool.ts:79
#Returns
MaybePromise<void>
#execute?
optionalexecute?: (args,context) =>unknown
Defined in: packages/core/src/types/tool.ts:74
#Parameters
args
TArgs
context
#Returns
unknown
#init?
optionalinit?: () =>MaybePromise<void>
Defined in: packages/core/src/types/tool.ts:78
#Returns
MaybePromise<void>
#name
name:
string
Defined in: packages/core/src/types/tool.ts:70
#requiresConfirmation?
optionalrequiresConfirmation?:boolean
Defined in: packages/core/src/types/tool.ts:73
#schema?
optionalschema?:JSONSchema7
Defined in: packages/core/src/types/tool.ts:72
#tags?
optionaltags?:string[]
Defined in: packages/core/src/types/tool.ts:80