.end().
All setter methods return this, so you can chain calls:
Required
Create tool call
Create a tool call from a run:| Parameter | Required | Description |
|---|---|---|
name | Yes | The name of the tool |
Set name
The name is required before calling.end(). If you didn’t provide it when creating the tool call, set it with:
| Parameter | Required | Description |
|---|---|---|
toolName | Yes | The name of the tool |
End tool call
End the tool call. A tool call must have a name set before calling.end(). The tool call cannot be modified after calling .end().
Optional tool call data
Set arguments
Set the arguments passed to the tool. Values are automatically serialized to JSON if an object is provided.| Parameter | Required | Description |
|---|---|---|
value | Yes | Arguments passed to the tool (string or object) |
Set result
Set the result returned by the tool. Values are automatically serialized to JSON if an object is provided.| Parameter | Required | Description |
|---|---|---|
value | Yes | Result returned by the tool (string or object) |
Mark tool call as failed
Sets the status code to error. The tool call cannot be modified after calling.error(). Unlike .end(), calling .error() does not require a name to be set.
| Parameter | Required | Description |
|---|---|---|
statusMessage | No | A description of the error |
Factory pattern
If you have all tool call data available upfront, use thesendToolCall function:
