Struct ResourceDef 

pub struct ResourceDef { /* private fields */ }

A registered resource or resource template.

Implementations

impl ResourceDef

pub fn app(self, ui: AppUi) -> Self

Makes this an MCP Apps interface: an HTML5 page served with the text/html;profile=mcp-app MIME type at a ui:// URI, sandboxed as ui describes. Tools show it with ToolDef::ui.

pub fn is_app(&self) -> bool

Whether this is an MCP Apps interface.

pub fn scopes<I, S>(self, scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Declares the OAuth scopes a caller needs (all of them). Enforced when the HTTP transport requires OAuth; the client gets 403 with an insufficient_scope challenge listing these scopes.

pub fn required_scopes(&self) -> &[String]

The OAuth scopes declared with scopes.

pub fn new(resource: Resource, read: ReadFn) -> Self

A resource with a fixed URI (listed by resources/list).

pub fn template(template: ResourceTemplate, read: ReadFn) -> Self

A resource template (listed by resources/templates/list). The uriTemplate must use the supported RFC 6570 subset (see UriTemplate).

pub fn require_state<T: Send + Sync + 'static>(self) -> Self

Declares that the resource needs shared state of type T.

pub fn ttl(self, ttl: Duration) -> Self

Freshness hint (ttlMs) of read results. Default: zero (always re-fetch).

pub fn cache_scope(self, scope: CacheScope) -> Self

cacheScope of read results. Default: private, since contents often depend on the caller. Use public for data identical for everyone.

pub fn complete(self, variable: impl Into<String>, complete: CompleteFn) -> Self

Attaches a completion provider to a template variable.

pub fn uri(&self) -> &str

The URI (static resources) or URI template.

pub fn is_template(&self) -> bool

Whether this is a resource template.

Trait Implementations

impl Clone for ResourceDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceDef

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

Formats the value using the given formatter.