agentskit.js

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?

optional category?: string

Defined in: packages/core/src/types/tool.ts:81


#description?

optional description?: string

Defined in: packages/core/src/types/tool.ts:71


#dispose?

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

Defined in: packages/core/src/types/tool.ts:79

#Returns

MaybePromise<void>


#execute?

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

Defined in: packages/core/src/types/tool.ts:74

#Parameters

args

TArgs

context

ToolExecutionContext

#Returns

unknown


#init?

optional init?: () => 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?

optional requiresConfirmation?: boolean

Defined in: packages/core/src/types/tool.ts:73


#schema?

optional schema?: JSONSchema7

Defined in: packages/core/src/types/tool.ts:72


#tags?

optional tags?: string[]

Defined in: packages/core/src/types/tool.ts:80

Explore nearby

✎ Edit this page on GitHub·Found a problem? Open an issue →·How to contribute →

On this page