Content

pulseengine_mcp_protocol::model

Enum Content

pub enum Content {
    Text {
        text: String,
        _meta: Option<Meta>,
    },
    Image {
        data: String,
        mime_type: String,
        _meta: Option<Meta>,
    },
    Resource {
        resource: String,
        text: Option<String>,
        _meta: Option<Meta>,
    },
}

Expand description

Content types for tool responses

Variants§

Text

Fields

§text: String

§_meta: Option<Meta>

Image

Fields

§data: String

§mime_type: String

§_meta: Option<Meta>

Resource

Fields

§resource: String

§text: Option<String>

§_meta: Option<Meta>

Implementations§

impl Content

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

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

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

pub fn ui_html(uri: impl Into<String>, html: impl Into<String>) -> Self

Create a UI HTML resource content (for MCP Apps Extension / MCP-UI)

This helper simplifies creating HTML UI resources by automatically formatting the resource JSON according to the MCP-UI specification.

§Example

use pulseengine_mcp_protocol::Content;

let html = r#"<html><body><h1>Hello!</h1></body></html>"#;
let content = Content::ui_html("ui://greetings/interactive", html);

This is equivalent to but much more concise than:

let resource_json = serde_json::json!({
    "uri": "ui://greetings/interactive",
    "mimeType": "text/html",
    "text": html
});
Content::Resource {
    resource: resource_json.to_string(),
    text: None,
    _meta: None,
}

pub fn ui_resource( uri: impl Into<String>, mime_type: impl Into<String>, content: impl Into<String>, ) -> Self

Create a UI resource content with custom MIME type (for MCP Apps Extension / MCP-UI)

This helper allows you to create UI resources with any MIME type and content.

§Example

use pulseengine_mcp_protocol::Content;

let json_data = r#"{"message": "Hello, World!"}"#;
let content = Content::ui_resource(
    "ui://data/greeting",
    "application/json",
    json_data
);

pub fn as_text(&self) -> Option<&Self>

Get text content if this is a text content type

impl Content

pub fn as_text_content(&self) -> Option<TextContent>

Get text content as TextContent struct for compatibility

Trait Implementations§

impl Clone for Content

fn clone(&self) -> Content

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

impl Debug for Content

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Content

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Content

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§

impl Freeze for Content

impl RefUnwindSafe for Content

impl Send for Content

impl Sync for Content

impl Unpin for Content

impl UnwindSafe for Content

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<T> ErasedDestructor for T
where T: 'static,