ToolInvocation

@codebolt/codeboltjs

---

Interface: ToolInvocation<TParams, TResult>

Defined in: packages/codeboltjs/src/tools/types.ts:278

Represents a validated and ready-to-execute tool call

Type Parameters

Type Parameter
TParams extends object
TResult extends ToolFrameworkResult

Properties

Property	Type	Description	Defined in
params	TParams	The validated parameters for this specific invocation	packages/codeboltjs/src/tools/types.ts:283

Methods

execute()

execute(signal: AbortSignal, updateOutput?: (output: string) => void): Promise<TResult>;

Defined in: packages/codeboltjs/src/tools/types.ts:294

Executes the tool with the validated parameters

Parameters

Parameter	Type
signal	AbortSignal
updateOutput?	(output: string) => void

Returns

Promise<TResult>

---

shouldConfirmExecute()

shouldConfirmExecute(abortSignal: AbortSignal): Promise<
  | false
| ToolCallConfirmationDetails>;

Defined in: packages/codeboltjs/src/tools/types.ts:289

Determines if the tool should prompt for confirmation before execution

Parameters

Parameter	Type
abortSignal	AbortSignal

Returns

Promise< | false | ToolCallConfirmationDetails>

---

toolLocations()

toolLocations(): ToolLocation[];

Defined in: packages/codeboltjs/src/tools/types.ts:286

Determines what file system paths the tool will affect

Returns

ToolLocation[]