ToolUseBlock

Defined in: src/types/messages.ts:211

Tool use content block.

Implements

• ToolUseBlockData
• JSONSerializable<{ toolUse: ToolUseBlockData; }>

Constructors

Constructor

new ToolUseBlock(data): ToolUseBlock;

Defined in: src/types/messages.ts:239

Parameters

Parameter	Type
data	ToolUseBlockData

Returns

ToolUseBlock

Properties

type

readonly type: "toolUseBlock";

Defined in: src/types/messages.ts:215

Discriminator for tool use content.

---

name

readonly name: string;

Defined in: src/types/messages.ts:220

The name of the tool to execute.

Implementation of

ToolUseBlockData.name

---

toolUseId

readonly toolUseId: string;

Defined in: src/types/messages.ts:225

Unique identifier for this tool use instance.

Implementation of

ToolUseBlockData.toolUseId

---

input

readonly input: JSONValue;

Defined in: src/types/messages.ts:231

The input parameters for the tool. This can be any JSON-serializable value.

Implementation of

ToolUseBlockData.input

---

reasoningSignature?

readonly optional reasoningSignature: string;

Defined in: src/types/messages.ts:237

Reasoning signature from thinking models (e.g., Gemini). Must be preserved and sent back to the model for multi-turn tool use.

Implementation of

ToolUseBlockData.reasoningSignature

Methods

toJSON()

toJSON(): {
  toolUse: ToolUseBlockData;
};

Defined in: src/types/messages.ts:252

Serializes the ToolUseBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify().

Returns

{
  toolUse: ToolUseBlockData;
}

Name	Type	Defined in
toolUse	ToolUseBlockData	src/types/messages.ts:252

Implementation of

JSONSerializable.toJSON

---

fromJSON()

static fromJSON(data): ToolUseBlock;

Defined in: src/types/messages.ts:269

Creates a ToolUseBlock instance from its wrapped data format.

Parameters

Parameter	Type	Description
data	{ toolUse: ToolUseBlockData; }	Wrapped ToolUseBlockData to deserialize
data.toolUse	ToolUseBlockData	-

Returns

ToolUseBlock

ToolUseBlock instance