Struct UIResource 

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

UI Resource declaration

UI resources are pre-declared interface templates that can be rendered by MCP hosts. They use the ui:// URI scheme and are typically associated with tools via metadata.

Example

use pmcp::types::ui::UIResource;

let resource = UIResource {
    uri: "ui://settings/form".to_string(),
    name: "Settings Form".to_string(),
    description: Some("Configure application settings".to_string()),
    mime_type: "text/html;profile=mcp-app".to_string(),
};

Fields

uri: String

URI with ui:// scheme

Must start with “ui://” followed by a path-like identifier. Example: ui://charts/bar-chart

name: String

Human-readable name for the UI resource

description: Option<String>

Optional description of what this UI resource provides

mime_type: String

MIME type of the UI resource

Standard: "text/html;profile=mcp-app" (recommended for all hosts) Legacy: "text/html+mcp" (still accepted by some hosts)

Implementations

impl UIResource

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

Create a new UI resource

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

Create a new HTML UI resource with the standard MCP Apps MIME type (text/html;profile=mcp-app).

This is the recommended constructor for widget resources that work across Claude Desktop, ChatGPT, and other MCP hosts.

Example

use pmcp::types::ui::UIResource;

let resource = UIResource::html_mcp_app(
    "ui://settings/form",
    "Settings Form",
);
assert_eq!(resource.mime_type, "text/html;profile=mcp-app");

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

👎Deprecated since 1.16.1:

Use html_mcp_app() which produces text/html;profile=mcp-app recognized by Claude Desktop

Create a new HTML UI resource with legacy MCP mime type (text/html+mcp).

Deprecated: Prefer html_mcp_app() which uses text/html;profile=mcp-app — the standard MIME type recognized by Claude Desktop and other MCP hosts.

Example

#[allow(deprecated)]
let resource = pmcp::types::ui::UIResource::html_mcp(
    "ui://settings/form",
    "Settings Form",
);

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

Create a new HTML UI resource with ChatGPT Skybridge mime type.

Example

use pmcp::types::ui::UIResource;

let resource = UIResource::html_skybridge(
    "ui://chess/board",
    "Chess Board",
);

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

Set the description

pub fn validate_uri(&self) -> Result<()>

Validate that the URI starts with “ui://”

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 Eq for UIResource

impl JsonSchema for UIResource

Available on crate feature schema-generation only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for UIResource

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for UIResource