ToolError

An intentional, model-visible tool error.

Never include secret values or internal stack traces in the message — it is visible to the model and potentially the user. Describe the problem at the level of the tool’s semantics, not the implementation.

Example

throw new ToolError(`Order ${orderId} not found`, { retryable: false });

Extends

• Error

Constructors

Constructor

new ToolError(message: string, options?: ToolErrorOptions): ToolError;

Parameters

Parameter	Type	Description
message	string	Human-readable, model-safe error message.
options?	ToolErrorOptions	Optional retryable hint and structured data.

Returns

ToolError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from
cause?	public	unknown	-	Error.cause
data	readonly	unknown	Optional structured data attached to the error.	-
message	public	string	-	Error.message
name	public	string	-	Error.name
retryable	readonly	boolean	Whether the model should consider retrying the call.	-
stack?	public	string	-	Error.stack