Struct ToolOutput 

pub struct ToolOutput {
    pub content: String,
    pub success: bool,
    pub metadata: Option<Value>,
    pub images: Vec<Attachment>,
    pub error_kind: Option<ToolErrorKind>,
}

Tool execution output

Fields

content: String

Output content (text or base64 for binary)

success: bool

Whether execution was successful

metadata: Option<Value>

Optional metadata

images: Vec<Attachment>

Optional image attachments from tool execution (e.g., screenshots).

When present, these are included in the tool result message sent to the LLM as multi-modal content blocks alongside the text content.

error_kind: Option<ToolErrorKind>

Optional structured discriminant for tool failures. Populated by tools that can map their failure into a typed ToolErrorKind (e.g. edit / patch on a WorkspaceError::VersionConflict). Surfaced through ToolResult and ToolCallResult so SDK callers can react programmatically without parsing the content string.

Implementations

impl ToolOutput

pub fn success(content: impl Into<String>) -> Self

pub fn error(message: impl Into<String>) -> Self

pub fn with_metadata(self, metadata: Value) -> Self

pub fn with_images(self, images: Vec<Attachment>) -> Self

Attach images to the tool output.

These will be included as multi-modal content blocks in the tool result message sent to the LLM.

pub fn with_error_kind(self, kind: ToolErrorKind) -> Self

Attach a typed error kind. Used by built-in tools when they can map a backend failure (e.g. WorkspaceError::VersionConflict) into a programmatically actionable ToolErrorKind.

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolOutput> for ToolResult

fn from(output: ToolOutput) -> Self

Converts to this type from the input type.

impl Serialize for ToolOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.