Tool
Defined in: core/src/tools.ts:69
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
I |
unknown |
O |
unknown |
Properties
Section titled “Properties”description
Section titled “description”readonly description: string;Defined in: core/src/tools.ts:71
inputSchema
Section titled “inputSchema”readonly inputSchema: JsonObjectSchema;Defined in: core/src/tools.ts:72
isConcurrencySafe
Section titled “isConcurrencySafe”readonly isConcurrencySafe: boolean;Defined in: core/src/tools.ts:76
isReadOnly
Section titled “isReadOnly”readonly isReadOnly: boolean;Defined in: core/src/tools.ts:74
isTerminal
Section titled “isTerminal”readonly isTerminal: boolean;Defined in: core/src/tools.ts:77
readonly name: string;Defined in: core/src/tools.ts:70
needsApproval
Section titled “needsApproval”readonly needsApproval: boolean;Defined in: core/src/tools.ts:75
timeoutMs
Section titled “timeoutMs”readonly timeoutMs: number;Defined in: core/src/tools.ts:73
Methods
Section titled “Methods”call()
Section titled “call()”call(input, ctx?): Promise<O>;Defined in: core/src/tools.ts:82
The typed path for internal callers: throws on failure.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input |
I |
ctx? |
ToolContext |
Returns
Section titled “Returns”Promise<O>
definition()
Section titled “definition()”definition(): ToolDefinition;Defined in: core/src/tools.ts:78
Returns
Section titled “Returns”invoke()
Section titled “invoke()”invoke(rawArgs, ctx?): Promise<ToolOutcome<O>>;Defined in: core/src/tools.ts:80
Validate, run, and report the outcome. Never throws except on abort.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
rawArgs |
unknown |
ctx? |
ToolContext |
Returns
Section titled “Returns”Promise<ToolOutcome<O>>