Struct ToolResult 

pub struct ToolResult {
    pub output: String,
    pub media: Vec<Attachment>,
    pub is_error: bool,
}

Result of a tool execution returned to the LLM.

Use ToolResult::success for normal output and ToolResult::error for recoverable errors the LLM should see.

Fields

output: String

Output text returned to the LLM.

media: Vec<Attachment>

Structured media attachments produced by this tool.

Attachments are delivered by Cortex transports independently from the text the model sees, so tools do not need transport-specific protocols.

is_error: bool

Whether this result represents an error condition.

When true, the LLM sees this as a failed tool call and may retry with different parameters or switch strategy.

Implementations

impl ToolResult

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

Create a successful result.

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

Create an error result (tool ran but failed).

Use this for recoverable errors — the LLM sees the output and can decide how to proceed. For example: “file not found”, “permission denied”, “rate limit exceeded”.

pub fn with_media(self, attachment: Attachment) -> Self

Attach one media item to the result.

pub fn with_media_many( self, media: impl IntoIterator<Item = Attachment>, ) -> Self

Attach multiple media items to the result.

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> ToolResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.