Struct ResourceTemplate

pub struct ResourceTemplate {
    pub annotations: Option<Annotations>,
    pub description: Option<String>,
    pub meta: Option<Map<String, Value>>,
    pub mime_type: Option<String>,
    pub name: String,
    pub title: Option<String>,
    pub uri_template: String,
}

A template description for resources available on the server.

JSON schema

{
 "description": "A template description for resources available on the server.",
 "type": "object",
 "required": [
   "name",
   "uriTemplate"
 ],
 "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 template is for.\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 for all resources that match this template. This should only be included if all resources matching this template have the same type.",
     "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"
   },
   "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"
   },
   "uriTemplate": {
     "description": "A URI template (according to RFC 6570) that can be used to construct resource URIs.",
     "type": "string",
     "format": "uri-template"
   }
 }
}

Fields

annotations: Option<Annotations>

Optional annotations for the client.

description: Option<String>

A description of what this template is for. 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 for all resources that match this template. This should only be included if all resources matching this template have the same type.

name: String

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

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_template: String

A URI template (according to RFC 6570) that can be used to construct resource URIs.

Trait Implementations

impl Clone for ResourceTemplate

fn clone(&self) -> ResourceTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceTemplate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResourceTemplate

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.