Struct ResourceLink

pub struct ResourceLink {
    pub annotations: Option<Annotations>,
    pub description: Option<String>,
    pub meta: Option<Map<String, Value>>,
    pub mime_type: Option<String>,
    pub name: String,
    pub size: Option<i64>,
    pub title: Option<String>,
    pub uri: String,
    /* private fields */
}

A resource that the server is capable of reading, included in a prompt or tool call result. Note: resource links returned by tools are not guaranteed to appear in the results of resources/list requests.

JSON schema

{
 "description": "A resource that the server is capable of reading, included in a prompt or tool call result.\n\nNote: resource links returned by tools are not guaranteed to appear in the results of resources/list requests.",
 "type": "object",
 "required": [
   "name",
   "type",
   "uri"
 ],
 "properties": {
   "_meta": {
     "description": "See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.",
     "type": "object",
     "additionalProperties": {}
   },
   "annotations": {
     "description": "Optional annotations for the client.",
     "$ref": "#/definitions/Annotations"
   },
   "description": {
     "description": "A description of what this resource represents.\n\nThis can be used by clients to improve the LLM's understanding of available resources. It can be thought of like a \"hint\" to the model.",
     "type": "string"
   },
   "mimeType": {
     "description": "The MIME type of this resource, if known.",
     "type": "string"
   },
   "name": {
     "description": "Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).",
     "type": "string"
   },
   "size": {
     "description": "The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known.\n\nThis can be used by Hosts to display file sizes and estimate context window usage.",
     "type": "integer"
   },
   "title": {
     "description": "Intended for UI and end-user contexts — optimized to be human-readable and easily understood,\neven by those unfamiliar with domain-specific terminology.\n\nIf not provided, the name should be used for display (except for Tool,\nwhere annotations.title should be given precedence over using name,\nif present).",
     "type": "string"
   },
   "type": {
     "type": "string",
     "const": "resource_link"
   },
   "uri": {
     "description": "The URI of this resource.",
     "type": "string",
     "format": "uri"
   }
 }
}

Fields

annotations: Option<Annotations>

Optional annotations for the client.

description: Option<String>

A description of what this resource represents. This can be used by clients to improve the LLM’s understanding of available resources. It can be thought of like a “hint” to the model.

meta: Option<Map<String, Value>>

See [specification/2025-06-18/basic/index#general-fields] for notes on _meta usage.

mime_type: Option<String>

The MIME type of this resource, if known.

name: String

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

size: Option<i64>

The size of the raw resource content, in bytes (i.e., before base64 encoding or any tokenization), if known. This can be used by Hosts to display file sizes and estimate context window usage.

title: Option<String>

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology. If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

uri: String

The URI of this resource.

Implementations

impl ResourceLink

pub fn new( name: String, uri: String, annotations: Option<Annotations>, description: Option<String>, meta: Option<Map<String, Value>>, mime_type: Option<String>, size: Option<i64>, title: Option<String>, ) -> Self

pub fn type_(&self) -> &String

pub fn type_name() -> String

Trait Implementations

impl Clone for ResourceLink

fn clone(&self) -> ResourceLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceLink

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceLink

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResourceLink> for ContentBlock

fn from(value: ResourceLink) -> Self

Converts to this type from the input type.

impl Serialize for ResourceLink

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

where __S: Serializer,

Serialize this value into the given Serde serializer.