Struct UiResource 

pub struct UiResource {
    pub uri: String,
    pub name: String,
    pub mime_type: String,
    pub description: Option<String>,
}

A UI resource declaration.

UI resources use the ui:// URI scheme and contain HTML content that can be rendered in sandboxed iframes.

Fields

uri: String

The UI resource URI (e.g., ui://charts/bar-chart).

name: String

Human-readable name for the UI.

mime_type: String

MIME type (typically “text/html” or “text/html+mcp”).

description: Option<String>

Optional description of the UI.

Implementations

impl UiResource

pub fn new(uri: impl Into<String>, name: impl Into<String>) -> Self

Create a new UI resource.

Arguments

• uri - The UI resource URI (should use ui:// scheme)
• name - Human-readable name

Example

use mcpkit_core::extension::apps::UiResource;

let ui = UiResource::new("ui://widgets/counter", "Counter Widget");
assert!(ui.uri.starts_with("ui://"));

pub fn with_mime_type(self, mime_type: impl Into<String>) -> Self

Set the MIME type.

Arguments

• mime_type - The MIME type (e.g., “text/html+mcp”)

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description.

Arguments

• description - Human-readable description

pub fn is_mcp_html(&self) -> bool

Check if this resource uses the MCP-enhanced HTML MIME type.

pub fn has_valid_scheme(&self) -> bool

Validate the URI scheme.

Returns true if the URI uses the ui:// scheme.

Trait Implementations

impl Clone for UiResource

fn clone(&self) -> UiResource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiResource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiResource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UiResource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UiResource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UiResource

impl StructuralPartialEq for UiResource