pub struct RequestMetaObject(pub MetaObject);Expand description
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: [&str; 2]
pub const DRAFT_REQUIRED_KEYS: [&str; 2]
Request _meta keys the 2026-07-28 draft schema marks as required.
Sourcepub fn with_progress_token(token: ProgressToken) -> Self
pub fn with_progress_token(token: ProgressToken) -> Self
Create a new request meta with a progress token set
Sourcepub fn with_client_context(
protocol_version: ProtocolVersion,
client_info: Implementation,
client_capabilities: ClientCapabilities,
) -> Self
pub fn with_client_context( protocol_version: ProtocolVersion, client_info: Implementation, client_capabilities: ClientCapabilities, ) -> Self
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 = JsonObject>§
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.
Sourcepub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>
pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>
Returns a mutable 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 get_key_value<Q>(&self, key: &Q) -> Option<(&String, &Value)>
pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&String, &Value)>
Returns the key-value pair matching the given 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 insert(&mut self, k: String, v: Value) -> Option<Value>
pub fn insert(&mut self, k: String, v: Value) -> Option<Value>
Inserts a key-value pair into the map.
If the map did not have this key present, None is returned.
If the map did have this key present, the value is updated, and the old value is returned.
Sourcepub fn remove<Q>(&mut self, key: &Q) -> Option<Value>
pub fn remove<Q>(&mut self, key: &Q) -> Option<Value>
Removes a key from the map, returning the value at the key if the key was previously in the map.
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.
If serde_json’s “preserve_order” is enabled, .remove(key) is
equivalent to [.swap_remove(key)][Self::swap_remove], replacing this
entry’s position with the last element. If you need to preserve the
relative order of the keys in the map, use
[.shift_remove(key)][Self::shift_remove] instead.
Sourcepub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>
pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>
Removes a key from the map, returning the stored key and value if the key was previously in the map.
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.
If serde_json’s “preserve_order” is enabled, .remove_entry(key) is
equivalent to [.swap_remove_entry(key)][Self::swap_remove_entry],
replacing this entry’s position with the last element. If you need to
preserve the relative order of the keys in the map, use
[.shift_remove_entry(key)][Self::shift_remove_entry] instead.
Sourcepub fn append(&mut self, other: &mut Map<String, Value>)
pub fn append(&mut self, other: &mut Map<String, Value>)
Moves all elements from other into self, leaving other empty.
Sourcepub fn entry<S>(&mut self, key: S) -> Entry<'_>
pub fn entry<S>(&mut self, key: S) -> Entry<'_>
Gets the given key’s corresponding entry in the map for in-place manipulation.
Sourcepub fn iter_mut(&mut self) -> IterMut<'_> ⓘ
pub fn iter_mut(&mut self) -> IterMut<'_> ⓘ
Gets a mutable iterator over the entries of the map.
Sourcepub fn values_mut(&mut self) -> ValuesMut<'_> ⓘ
pub fn values_mut(&mut self) -> ValuesMut<'_> ⓘ
Gets an iterator over mutable values of the map.
Sourcepub fn retain<F>(&mut self, f: F)
pub fn retain<F>(&mut self, f: F)
Retains only the elements specified by the predicate.
In other words, remove all pairs (k, v) such that f(&k, &mut v)
returns false.
Sourcepub fn sort_keys(&mut self)
pub fn sort_keys(&mut self)
Sorts this map’s entries in-place using str’s usual ordering.
If serde_json’s “preserve_order” feature is not enabled, this method does no work because all JSON maps are always kept in a sorted state.
If serde_json’s “preserve_order” feature is enabled, this method destroys the original source order or insertion order of this map in favor of an alphanumerical order that matches how a BTreeMap with the same contents would be ordered. This takes O(n log n + c) time where n is the length of the map and c is the capacity.
Other maps nested within the values of this map are not sorted. If you
need the entire data structure to be sorted at all levels, you must also
call
map.values_mut().for_each(Value::sort_all_objects).
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§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<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl From<Map<String, Value>> for RequestMetaObject
impl From<Map<String, Value>> for RequestMetaObject
Source§fn from(object: JsonObject) -> Self
fn from(object: JsonObject) -> Self
Source§impl From<MetaObject> for RequestMetaObject
impl From<MetaObject> for RequestMetaObject
Source§fn from(meta: MetaObject) -> Self
fn from(meta: MetaObject) -> Self
Source§impl<C> FromContextPart<C> for RequestMetaObjectwhere
C: AsRequestContext,
Available on crate feature server only.
impl<C> FromContextPart<C> for RequestMetaObjectwhere
C: AsRequestContext,
server only.Source§impl JsonSchema for RequestMetaObject
Available on crate feature schemars only.
impl JsonSchema for RequestMetaObject
schemars only.Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read more