Skip to main content

ResourceTemplate

Struct ResourceTemplate 

Source
pub struct ResourceTemplate {
    pub uri_template: String,
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub mime_type: Option<String>,
    pub icons: Option<Vec<ToolIcon>>,
    pub annotations: Option<ContentAnnotations>,
    /* private fields */
}
Expand description

A parameterized resource template

Resource templates use URI template syntax (RFC 6570) to match multiple URIs and extract variable values. This allows servers to expose dynamic resources like file systems or database records.

§Example

use tower_mcp::resource::ResourceTemplateBuilder;
use tower_mcp::protocol::{ReadResourceResult, ResourceContent};
use std::collections::HashMap;

let template = ResourceTemplateBuilder::new("file:///{path}")
    .name("Project Files")
    .handler(|uri: String, vars: HashMap<String, String>| async move {
        let path = vars.get("path").unwrap_or(&String::new()).clone();
        Ok(ReadResourceResult {
            contents: vec![ResourceContent {
                uri,
                mime_type: Some("text/plain".to_string()),
                text: Some(format!("Contents of {}", path)),
                blob: None,
                meta: None,
            }],
            meta: None,
            ..Default::default()
        })
    });

Fields§

§uri_template: String

The URI template pattern (e.g., file:///{path})

§name: String

Human-readable name

§title: Option<String>

Human-readable title for display purposes

§description: Option<String>

Optional description

§mime_type: Option<String>

Optional MIME type hint

§icons: Option<Vec<ToolIcon>>

Optional icons for display in user interfaces

§annotations: Option<ContentAnnotations>

Optional annotations (audience, priority hints)

Implementations§

Source§

impl ResourceTemplate

Source

pub fn builder(uri_template: impl Into<String>) -> ResourceTemplateBuilder

Create a new resource template builder

Source

pub fn definition(&self) -> ResourceTemplateDefinition

Get the template definition for resources/templates/list

Source

pub fn match_uri(&self, uri: &str) -> Option<HashMap<String, String>>

Check if a URI matches this template and extract variables

Returns Some(HashMap) with extracted variables if the URI matches, None if it doesn’t match.

Source

pub fn read( &self, uri: &str, variables: HashMap<String, String>, ) -> BoxFuture<'_, Result<ReadResourceResult>>

Read a resource at the given URI using this template’s handler

§Arguments
  • uri - The actual URI being read
  • variables - Variables extracted from matching the URI against the template
Source

pub fn read_outcome_with_context( &self, ctx: RequestContext, uri: &str, variables: HashMap<String, String>, ) -> BoxFuture<'_, Result<RequestOutcome<ReadResourceResult>>>

Read a matched resource while preserving an SEP-2322 continuation.

Trait Implementations§

Source§

impl Clone for ResourceTemplate

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResourceTemplate

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more