Skip to main content

CallToolResult

Struct CallToolResult 

Source
pub struct CallToolResult {
    pub content: Vec<Content>,
    pub is_error: bool,
    pub structured_content: Option<Value>,
}
Expand description

Result of a tool invocation.

This is the return type for tool handlers. Use the convenience constructors like CallToolResult::text, CallToolResult::json, or CallToolResult::error to create results easily.

§Example

use tower_mcp::CallToolResult;

// Simple text result
let result = CallToolResult::text("Hello, world!");

// JSON result with structured content
let result = CallToolResult::json(serde_json::json!({"key": "value"}));

// Error result
let result = CallToolResult::error("Something went wrong");

Fields§

§content: Vec<Content>

The content items returned by the tool.

§is_error: bool

Whether this result represents an error.

§structured_content: Option<Value>

Optional structured content for programmatic access.

Implementations§

Source§

impl CallToolResult

Source

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

Create a text result.

This is the most common result type for tools that return plain text.

Source

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

Create an error result.

Use this when the tool encounters an error during execution. The is_error flag will be set to true.

Source

pub fn json(value: Value) -> Self

Create a JSON result with structured content from a serde_json::Value.

The JSON value is serialized to pretty-printed text for display, and also stored in structured_content for programmatic access.

If you have a type that implements serde::Serialize, use from_serialize instead to avoid manual to_value() calls.

Source

pub fn from_serialize(value: &impl Serialize) -> Result<Self, Error>

Create a JSON result from any serializable value.

This is a fallible alternative to json that accepts any serde::Serialize type and handles serialization errors gracefully. The value is serialized to a serde_json::Value, then delegated to json(), so structured_content is populated correctly.

§Errors

Returns an error if the value cannot be serialized to JSON.

§Example
use tower_mcp::CallToolResult;
use serde::Serialize;

#[derive(Serialize)]
struct SearchResult {
    title: String,
    score: f64,
}

let result = SearchResult {
    title: "Example".to_string(),
    score: 0.95,
};
let tool_result = CallToolResult::from_serialize(&result).unwrap();
assert!(!tool_result.is_error);
assert!(tool_result.structured_content.is_some());
Source

pub fn image(data: impl Into<String>, mime_type: impl Into<String>) -> Self

Create a result with an image

Source

pub fn audio(data: impl Into<String>, mime_type: impl Into<String>) -> Self

Create a result with audio

Create a result with a resource link

Create a result with a resource link including metadata

Source

pub fn resource(resource: ResourceContent) -> Self

Create a result with an embedded resource

Source

pub fn all_text(&self) -> String

Concatenate all text content items into a single string.

Non-text content items are skipped. Multiple text items are joined without a separator.

§Example
use tower_mcp::CallToolResult;

let result = CallToolResult::text("hello world");
assert_eq!(result.all_text(), "hello world");
Source

pub fn first_text(&self) -> Option<&str>

Get the text from the first Content::Text item.

Returns None if there are no text content items.

§Example
use tower_mcp::CallToolResult;

let result = CallToolResult::text("hello");
assert_eq!(result.first_text(), Some("hello"));

Trait Implementations§

Source§

impl Clone for CallToolResult

Source§

fn clone(&self) -> CallToolResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CallToolResult

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CallToolResult

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CallToolResult

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,