pub struct McpRequestMetadata(pub MetaObject);Expand description
The official SDK’s typed stable per-request metadata map.
The _meta map carried by requests (spec RequestMetaObject).
In addition to arbitrary extension keys, requests reserve:
progressTokenfor progress trackingio.modelcontextprotocol/protocolVersion(SEP-2575)io.modelcontextprotocol/clientInfo(SEP-2575)io.modelcontextprotocol/clientCapabilities(SEP-2575)io.modelcontextprotocol/logLevel(SEP-2575)
The 2026-07-28 draft schema requires the protocol-version and
client-capabilities keys; client-info is optional. Earlier protocol versions
do not know them. All keys therefore stay optional at runtime and in the
generated (version-shared) JSON schema — use
RequestMetaObject::missing_required_keys to validate a request against
the negotiated protocol version.
This type dereferences to MetaObject (and transitively to the underlying
map), so general helpers such as the SEP-414 trace-context accessors remain
available.
Tuple Fields§
§0: MetaObjectImplementations§
Source§impl RequestMetaObject
impl RequestMetaObject
Sourcepub const DRAFT_REQUIRED_KEYS: [&'static str; 2]
pub const DRAFT_REQUIRED_KEYS: [&'static str; 2]
Request _meta keys the 2026-07-28 draft schema marks as required.
Sourcepub fn new() -> RequestMetaObject
pub fn new() -> RequestMetaObject
Create an empty request metadata map.
Sourcepub fn with_progress_token(token: ProgressToken) -> RequestMetaObject
pub fn with_progress_token(token: ProgressToken) -> RequestMetaObject
Create a new request meta with a progress token set
Sourcepub fn with_client_context(
protocol_version: ProtocolVersion,
client_info: Implementation,
client_capabilities: ClientCapabilities,
) -> RequestMetaObject
pub fn with_client_context( protocol_version: ProtocolVersion, client_info: Implementation, client_capabilities: ClientCapabilities, ) -> RequestMetaObject
Create request metadata with the client context SEP-2575 requires on every request.
Sourcepub fn get_progress_token(&self) -> Option<ProgressToken>
pub fn get_progress_token(&self) -> Option<ProgressToken>
Get the progress token carried in _meta, if present and valid.
Sourcepub fn set_progress_token(&mut self, token: ProgressToken)
pub fn set_progress_token(&mut self, token: ProgressToken)
Set the progress token carried in _meta.
Sourcepub fn protocol_version(&self) -> Option<ProtocolVersion>
pub fn protocol_version(&self) -> Option<ProtocolVersion>
Get the MCP protocol version carried in _meta, if present and valid.
Sourcepub fn set_protocol_version(&mut self, protocol_version: ProtocolVersion)
pub fn set_protocol_version(&mut self, protocol_version: ProtocolVersion)
Set the MCP protocol version carried in _meta.
Sourcepub fn client_info(&self) -> Option<Implementation>
pub fn client_info(&self) -> Option<Implementation>
Get the client implementation identity carried in _meta, if present and valid.
Sourcepub fn set_client_info(&mut self, client_info: Implementation)
pub fn set_client_info(&mut self, client_info: Implementation)
Set the client implementation identity carried in _meta.
Sourcepub fn client_capabilities(&self) -> Option<ClientCapabilities>
pub fn client_capabilities(&self) -> Option<ClientCapabilities>
Get the client capabilities carried in _meta, if present and valid.
Sourcepub fn set_client_capabilities(
&mut self,
client_capabilities: ClientCapabilities,
)
pub fn set_client_capabilities( &mut self, client_capabilities: ClientCapabilities, )
Set the client capabilities carried in _meta.
Sourcepub fn log_level(&self) -> Option<LoggingLevel>
pub fn log_level(&self) -> Option<LoggingLevel>
Get the requested per-request log level carried in _meta, if present and valid.
Sourcepub fn set_log_level(&mut self, log_level: LoggingLevel)
pub fn set_log_level(&mut self, log_level: LoggingLevel)
Set the requested per-request log level carried in _meta.
Sourcepub fn missing_required_keys(
&self,
protocol_version: &ProtocolVersion,
) -> Vec<&'static str>
pub fn missing_required_keys( &self, protocol_version: &ProtocolVersion, ) -> Vec<&'static str>
Return the Self::DRAFT_REQUIRED_KEYS whose values are absent or
invalid in this map, if protocol_version requires them.
A key counts as missing when it is not present or when its value does
not decode into the expected type (e.g. a numeric protocolVersion or
a string clientInfo), matching what the typed accessors return.
Protocol versions before 2026-07-28 have no required request metadata, so this always returns an empty list for them.
§Examples
use rmcp::model::{ProtocolVersion, RequestMetaObject};
let meta = RequestMetaObject::new();
// Older protocols have no required request metadata.
assert!(
meta.missing_required_keys(&ProtocolVersion::V_2025_11_25)
.is_empty()
);
// The 2026-07-28 protocol requires per-request context.
assert_eq!(
meta.missing_required_keys(&ProtocolVersion::V_2026_07_28),
RequestMetaObject::DRAFT_REQUIRED_KEYS.to_vec(),
);Sourcepub fn extend(&mut self, other: RequestMetaObject)
pub fn extend(&mut self, other: RequestMetaObject)
Insert every entry of other, overwriting existing keys on conflict.
Methods from Deref<Target = MetaObject>§
Sourcepub fn get_traceparent(&self) -> Option<&str>
pub fn get_traceparent(&self) -> Option<&str>
Get the W3C traceparent value (SEP-414), if present.
Sourcepub fn set_traceparent(&mut self, value: impl Into<String>)
pub fn set_traceparent(&mut self, value: impl Into<String>)
Set the W3C traceparent value (SEP-414).
use rmcp::model::MetaObject;
let mut meta = MetaObject::new();
meta.set_traceparent("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01");
assert_eq!(
meta.get_traceparent(),
Some("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"),
);Sourcepub fn get_tracestate(&self) -> Option<&str>
pub fn get_tracestate(&self) -> Option<&str>
Get the W3C tracestate value (SEP-414), if present.
Sourcepub fn set_tracestate(&mut self, value: impl Into<String>)
pub fn set_tracestate(&mut self, value: impl Into<String>)
Set the W3C tracestate value (SEP-414).
Sourcepub fn get_baggage(&self) -> Option<&str>
pub fn get_baggage(&self) -> Option<&str>
Get the W3C baggage value (SEP-414), if present.
Sourcepub fn set_baggage(&mut self, value: impl Into<String>)
pub fn set_baggage(&mut self, value: impl Into<String>)
Set the W3C baggage value (SEP-414).
Sourcepub fn extend(&mut self, other: MetaObject)
pub fn extend(&mut self, other: MetaObject)
Insert every entry of other, overwriting existing keys on conflict.
Methods from Deref<Target = Map<String, Value>>§
Sourcepub fn get<Q>(&self, key: &Q) -> Option<&Value>
pub fn get<Q>(&self, key: &Q) -> Option<&Value>
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
Sourcepub fn contains_key<Q>(&self, key: &Q) -> bool
pub fn contains_key<Q>(&self, key: &Q) -> bool
Returns true if the map contains a value for the specified key.
The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.
Trait Implementations§
Source§impl Clone for RequestMetaObject
impl Clone for RequestMetaObject
Source§fn clone(&self) -> RequestMetaObject
fn clone(&self) -> RequestMetaObject
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RequestMetaObject
impl Debug for RequestMetaObject
Source§impl Default for RequestMetaObject
impl Default for RequestMetaObject
Source§fn default() -> RequestMetaObject
fn default() -> RequestMetaObject
Source§impl Deref for RequestMetaObject
impl Deref for RequestMetaObject
Source§type Target = MetaObject
type Target = MetaObject
Source§impl DerefMut for RequestMetaObject
impl DerefMut for RequestMetaObject
Source§impl<'de> Deserialize<'de> for RequestMetaObject
impl<'de> Deserialize<'de> for RequestMetaObject
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<RequestMetaObject, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<RequestMetaObject, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl From<MetaObject> for RequestMetaObject
impl From<MetaObject> for RequestMetaObject
Source§fn from(meta: MetaObject) -> RequestMetaObject
fn from(meta: MetaObject) -> RequestMetaObject
Source§impl PartialEq for RequestMetaObject
impl PartialEq for RequestMetaObject
Source§impl Serialize for RequestMetaObject
impl Serialize for RequestMetaObject
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for RequestMetaObject
Auto Trait Implementations§
impl Freeze for RequestMetaObject
impl RefUnwindSafe for RequestMetaObject
impl Send for RequestMetaObject
impl Sync for RequestMetaObject
impl Unpin for RequestMetaObject
impl UnsafeUnpin for RequestMetaObject
impl UnwindSafe for RequestMetaObject
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);