Struct ToolOutput 

pub struct ToolOutput {
    pub content: Vec<ContentPart>,
    pub structured_content: Option<Value>,
    pub metadata: BTreeMap<String, Value>,
    pub is_error: bool,
    pub model_visible: bool,
}

Successful canonical tool output.

Fields

content: Vec<ContentPart>

Ordered model-visible presentation content.

structured_content: Option<Value>

Optional structured output value used for contract validation and by protocols that support a separate structured result channel.

metadata: BTreeMap<String, Value>

Namespaced host metadata retained across Agent and protocol bridges.

is_error: bool

Whether execution completed with a model-visible application error.

model_visible: bool

Whether the value is safe to expose verbatim to a model.

Implementations

impl ToolOutput

pub fn model_visible(value: Value) -> Self

Creates model-visible output from a JSON value.

JSON values are retained as structured content and mirrored as text for providers that only accept textual function results.

pub fn rich(content: Vec<ContentPart>) -> Self

Creates a model-visible rich result.

pub fn with_structured_content(self, value: Value) -> Self

Attaches a structured value alongside the presentation content.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Adds namespaced host metadata.

pub fn host_only(content: Vec<ContentPart>) -> Self

Creates host-only output that must not be exposed to a model.

pub fn model_error(content: Vec<ContentPart>) -> Self

Creates a rich, model-visible application error result.

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 PartialEq for ToolOutput

fn eq(&self, other: &ToolOutput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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.

impl StructuralPartialEq for ToolOutput