Struct Resource 

#[non_exhaustive]
pub struct Resource {
    pub uri: String,
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub size: Option<u64>,
    pub icons: Option<Vec<Icon>>,
    pub meta: Option<MetaObject>,
    pub annotations: Option<Annotations>,
}

Available on crate feature tools only.

A known resource that the server is capable of reading (spec Resource).

Also used as the inner type of ContentBlock::ResourceLink (spec ResourceLink extends Resource).

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.

uri: String

The URI of this resource (e.g. file:///path/to/file).

name: String

The programmatic name of the resource.

title: Option<String>

Optional human-readable display title.

description: Option<String>

Optional description of what this resource represents.

mime_type: Option<String>

The MIME type of this resource, if known.

size: Option<u64>

The size of the raw resource content in bytes (before base64/tokenization), if known.

icons: Option<Vec<Icon>>

Optional set of icons the client may display for this resource.

meta: Option<MetaObject>

Optional protocol-level metadata for this resource.

annotations: Option<Annotations>

Optional annotations describing how the client should use this resource.

Implementations

impl Resource

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

Available on crate feature mcp only.

pub fn with_title(self, title: impl Into<String>) -> Resource

Available on crate feature mcp only.

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

Available on crate feature mcp only.

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

Available on crate feature mcp only.

pub fn with_size(self, size: u64) -> Resource

Available on crate feature mcp only.

pub fn with_icons(self, icons: Vec<Icon>) -> Resource

Available on crate feature mcp only.

pub fn with_meta(self, meta: MetaObject) -> Resource

Available on crate feature mcp only.

pub fn with_annotations(self, annotations: Annotations) -> Resource

Available on crate feature mcp only.

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Resource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Resource

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 Resource

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Resource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Resource