Struct ResourceMetadata 

pub struct ResourceMetadata { /* private fields */ }

An RFC 9728 protected-resource metadata document.

What an MCP server publishes to tell a client which authorization servers can issue tokens for it, and which scopes those tokens should carry.

Wire form

Field names are the snake_case ones RFC 9728 §2 defines — unlike the rest of MCP’s wire types, so this one derives Serialize rather than renaming to camelCase. skip_serializing_if is not an optimisation: §3.2 says a parameter with zero values MUST be omitted, so an empty authorization_servers is absent rather than []. resource is the one field that is always present.

Implementations

impl ResourceMetadata

pub fn new(resource: ResourceUri) -> Self

A document for resource, with the mandatory resource field and nothing optional.

Examples

use protocol_droid::domain::mcp::{ResourceMetadata, ResourceUri};

let metadata = ResourceMetadata::new(ResourceUri::new("https://example.com/mcp")?);
assert_eq!(metadata.resource().as_str(), "https://example.com/mcp");
assert!(metadata.authorization_servers().is_empty());

pub fn with_authorization_server(self, issuer: impl Into<Arc<str>>) -> Self

Names an authorization server that can issue tokens for this resource.

pub fn with_scope(self, scope: impl Into<Arc<str>>) -> Self

Declares a scope a token may carry.

pub fn with_name(self, name: impl Into<Arc<str>>) -> Self

Sets the human-readable name.

pub const fn resource(&self) -> &ResourceUri

The canonical resource identifier, and the audience a token must carry.

pub fn authorization_servers(&self) -> &[Arc<str>]

The authorization servers this resource names.

pub fn scopes_supported(&self) -> &[Arc<str>]

The scopes this resource declares.

pub fn bearer_methods_supported(&self) -> &[BearerMethod]

How a bearer token may be presented.

pub fn challenge(&self) -> Result<String, ResourceUriError>

The WWW-Authenticate challenge for a request that was refused.

RFC 9728 §5.1: the challenge carries resource_metadata so the client knows where to discover the authorization server, which is the whole reason a server publishes the document.

Errors

ResourceUriError::NoOrigin when the resource identifier has no origin, which the constructor rules out.

Examples

use protocol_droid::domain::mcp::{ResourceMetadata, ResourceUri};

let metadata = ResourceMetadata::new(ResourceUri::new("https://example.com/mcp")?);
assert_eq!(
    metadata.challenge()?,
    "Bearer resource_metadata=\"https://example.com/.well-known/oauth-protected-resource/mcp\"",
);

Trait Implementations

impl Clone for ResourceMetadata

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 ResourceMetadata

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

Formats the value using the given formatter.

impl Eq for ResourceMetadata

impl PartialEq for ResourceMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResourceMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResourceMetadata