Struct ToolResult 

#[non_exhaustive]
pub struct ToolResult {
    pub text: String,
    pub structured: Option<Value>,
}

What a tool answered: the text the model is shown, and the structured value beside it when the tool’s source returned one (MCP’s structuredContent).

The model gets a string either way — into_model_text — because that is what every chat-completion API takes for a tool message. The structured value is for whoever holds the result: a consumer that wants to check it against the tool’s output_schema or render it, without re-parsing prose.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

The text content, joined. Empty when the tool returned only structure.

structured: Option<Value>

The structured result, where the source gave one.

Implementations

impl ToolResult

pub fn new(text: impl Into<String>) -> Self

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

pub fn into_model_text(self) -> String

The string the model is told. The text when there is any; otherwise the structured value serialized, so a tool that answered only in structure is not reported as having said nothing.

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> Self

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 Default for ToolResult

fn default() -> Self

Returns the “default value” for a type.

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

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

Equality operator ==.

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

Inequality operator !=.

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.

impl StructuralPartialEq for ToolResult