Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions crates/rmcp/src/model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1267,6 +1267,9 @@ pub struct CallToolResult {
/// Whether this result represents an error condition
#[serde(skip_serializing_if = "Option::is_none")]
pub is_error: Option<bool>,
/// Optional protocol-level metadata for this result
#[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
pub meta: Option<Meta>,
}

impl CallToolResult {
Expand All @@ -1276,6 +1279,7 @@ impl CallToolResult {
content,
structured_content: None,
is_error: Some(false),
meta: None,
}
}
/// Create an error tool result with unstructured content
Expand All @@ -1284,6 +1288,7 @@ impl CallToolResult {
content,
structured_content: None,
is_error: Some(true),
meta: None,
}
}
/// Create a successful tool result with structured content
Expand All @@ -1305,6 +1310,7 @@ impl CallToolResult {
content: vec![Content::text(value.to_string())],
structured_content: Some(value),
is_error: Some(false),
meta: None,
}
}
/// Create an error tool result with structured content
Expand All @@ -1330,6 +1336,7 @@ impl CallToolResult {
content: vec![Content::text(value.to_string())],
structured_content: Some(value),
is_error: Some(true),
meta: None,
}
}

Expand Down Expand Up @@ -1377,13 +1384,17 @@ impl<'de> Deserialize<'de> for CallToolResult {
structured_content: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
is_error: Option<bool>,
/// Accept `_meta` during deserialization
#[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
meta: Option<Meta>,
}

let helper = CallToolResultHelper::deserialize(deserializer)?;
let result = CallToolResult {
content: helper.content.unwrap_or_default(),
structured_content: helper.structured_content,
is_error: helper.is_error,
meta: helper.meta,
};

// Validate mutual exclusivity
Expand Down
9 changes: 8 additions & 1 deletion crates/rmcp/src/model/content.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ pub type ImageContent = Annotated<RawImageContent>;
#[serde(rename_all = "camelCase")]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct RawEmbeddedResource {
#[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
pub meta: Option<super::Meta>,
pub resource: ResourceContents,
}
pub type EmbeddedResource = Annotated<RawEmbeddedResource>;
Expand Down Expand Up @@ -88,15 +90,20 @@ impl RawContent {
}

pub fn resource(resource: ResourceContents) -> Self {
RawContent::Resource(RawEmbeddedResource { resource })
RawContent::Resource(RawEmbeddedResource {
meta: None,
resource,
})
}

pub fn embedded_text<S: Into<String>, T: Into<String>>(uri: S, content: T) -> Self {
RawContent::Resource(RawEmbeddedResource {
meta: None,
resource: ResourceContents::TextResourceContents {
uri: uri.into(),
mime_type: Some("text".to_string()),
text: content.into(),
meta: None,
},
})
}
Expand Down
3 changes: 2 additions & 1 deletion crates/rmcp/src/model/meta.rs
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ variant_extension! {
PromptListChangedNotification
}
}
#[derive(Debug, Serialize, Deserialize, Clone, Default)]
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[serde(transparent)]
pub struct Meta(pub JsonObject);
const PROGRESS_TOKEN_FIELD: &str = "progressToken";
Expand Down
2 changes: 2 additions & 0 deletions crates/rmcp/src/model/prompt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,14 @@ impl PromptMessage {
uri,
mime_type: Some(mime_type),
text: text.unwrap_or_default(),
meta: None,
};

Self {
role,
content: PromptMessageContent::Resource {
resource: RawEmbeddedResource {
meta: None,
resource: resource_contents,
}
.optional_annotate(annotations),
Expand Down
8 changes: 7 additions & 1 deletion crates/rmcp/src/model/resource.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use serde::{Deserialize, Serialize};

use super::Annotated;
use super::{Annotated, Meta};

/// Represents a resource in the extension with metadata
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
Expand Down Expand Up @@ -51,13 +51,17 @@ pub enum ResourceContents {
#[serde(skip_serializing_if = "Option::is_none")]
mime_type: Option<String>,
text: String,
#[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
meta: Option<Meta>,
},
#[serde(rename_all = "camelCase")]
BlobResourceContents {
uri: String,
#[serde(skip_serializing_if = "Option::is_none")]
mime_type: Option<String>,
blob: String,
#[serde(rename = "_meta", skip_serializing_if = "Option::is_none")]
meta: Option<Meta>,
},
}

Expand All @@ -67,6 +71,7 @@ impl ResourceContents {
uri: uri.into(),
mime_type: Some("text".into()),
text: text.into(),
meta: None,
}
}
}
Expand Down Expand Up @@ -114,6 +119,7 @@ mod tests {
uri: "file:///test.txt".to_string(),
mime_type: Some("text/plain".to_string()),
text: "Hello world".to_string(),
meta: None,
};

let json = serde_json::to_string(&text_contents).unwrap();
Expand Down
122 changes: 122 additions & 0 deletions crates/rmcp/tests/test_embedded_resource_meta.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
use rmcp::model::{AnnotateAble, Content, Meta, RawContent, ResourceContents};
use serde_json::json;

#[test]
fn serialize_embedded_text_resource_with_meta() {
// Inner contents meta
let mut inner_meta = Meta::new();
inner_meta.insert("inner".to_string(), json!(2));

// Top-level embedded resource meta
let mut top_meta = Meta::new();
top_meta.insert("top".to_string(), json!(1));

let content: Content = RawContent::Resource(rmcp::model::RawEmbeddedResource {
meta: Some(top_meta),
resource: ResourceContents::TextResourceContents {
uri: "str://example".to_string(),
mime_type: Some("text/plain".to_string()),
text: "hello".to_string(),
meta: Some(inner_meta),
},
})
.no_annotation();

let v = serde_json::to_value(&content).unwrap();

let expected = json!({
"type": "resource",
"_meta": {"top": 1},
"resource": {
"uri": "str://example",
"mimeType": "text/plain",
"text": "hello",
"_meta": {"inner": 2}
}
});

assert_eq!(v, expected);
}

#[test]
fn serialize_embedded_text_resource_without_meta_omits_fields() {
let content: Content = RawContent::Resource(rmcp::model::RawEmbeddedResource {
meta: None,
resource: ResourceContents::TextResourceContents {
uri: "str://no-meta".to_string(),
mime_type: Some("text/plain".to_string()),
text: "hi".to_string(),
meta: None,
},
})
.no_annotation();

let v = serde_json::to_value(&content).unwrap();

assert_eq!(v.get("_meta"), None);
let inner = v.get("resource").and_then(|r| r.as_object()).unwrap();
assert_eq!(inner.get("_meta"), None);
}

#[test]
fn deserialize_embedded_text_resource_with_meta() {
let raw = json!({
"type": "resource",
"_meta": {"x": true},
"resource": {
"uri": "str://from-json",
"text": "ok",
"_meta": {"y": 42}
}
});

let content: Content = serde_json::from_value(raw).unwrap();

let raw = match &content.raw {
RawContent::Resource(er) => er,
_ => panic!("expected resource"),
};

// top-level _meta
let top = raw.meta.as_ref().expect("top-level meta missing");
assert_eq!(top.get("x").unwrap(), &json!(true));

// inner contents _meta
match &raw.resource {
ResourceContents::TextResourceContents {
meta, uri, text, ..
} => {
assert_eq!(uri, "str://from-json");
assert_eq!(text, "ok");
let inner = meta.as_ref().expect("inner meta missing");
assert_eq!(inner.get("y").unwrap(), &json!(42));
}
_ => panic!("expected text resource contents"),
}
}

#[test]
fn serialize_embedded_blob_resource_with_meta() {
let mut inner_meta = Meta::new();
inner_meta.insert("blob_inner".to_string(), json!(true));

let mut top_meta = Meta::new();
top_meta.insert("blob_top".to_string(), json!("t"));

let content: Content = RawContent::Resource(rmcp::model::RawEmbeddedResource {
meta: Some(top_meta),
resource: ResourceContents::BlobResourceContents {
uri: "str://blob".to_string(),
mime_type: Some("application/octet-stream".to_string()),
blob: "Zm9v".to_string(),
meta: Some(inner_meta),
},
})
.no_annotation();

let v = serde_json::to_value(&content).unwrap();

assert_eq!(v.get("_meta").unwrap(), &json!({"blob_top": "t"}));
let inner = v.get("resource").unwrap();
assert_eq!(inner.get("_meta").unwrap(), &json!({"blob_inner": true}));
}
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,13 @@
"RawEmbeddedResource": {
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"resource": {
"$ref": "#/definitions/ResourceContents"
}
Expand Down Expand Up @@ -1252,6 +1259,13 @@
{
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"mimeType": {
"type": [
"string",
Expand All @@ -1273,6 +1287,13 @@
{
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"blob": {
"type": "string"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,13 @@
"RawEmbeddedResource": {
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"resource": {
"$ref": "#/definitions/ResourceContents"
}
Expand Down Expand Up @@ -1252,6 +1259,13 @@
{
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"mimeType": {
"type": [
"string",
Expand All @@ -1273,6 +1287,13 @@
{
"type": "object",
"properties": {
"_meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"blob": {
"type": "string"
},
Expand Down
Loading