use crate::conversation::tool_result_serde; use crate::mcp_utils::{extract_text_from_resource, ToolResult}; use crate::utils::sanitize_unicode_tags; use chrono::Utc; use rmcp::model::{ AnnotateAble, CallToolRequestParams, CallToolResult, Content, ImageContent, JsonObject, PromptMessage, PromptMessageContent, PromptMessageRole, RawContent, RawImageContent, RawTextContent, Role, TextContent, }; use serde::{Deserialize, Deserializer, Serialize}; use std::collections::HashSet; use std::fmt; use utoipa::ToSchema; use uuid::Uuid; #[derive(ToSchema)] pub enum ToolCallResult { Success { value: T }, Error { error: String }, } /// Custom deserializer for MessageContent that sanitizes Unicode Tags in text content fn deserialize_sanitized_content<'de, D>(deserializer: D) -> Result, D::Error> where D: Deserializer<'de>, { use serde::de::Error; let raw: Vec = Vec::deserialize(deserializer)?; let mut migrated = Vec::with_capacity(raw.len()); for item in raw { match item.get("type").and_then(|v| v.as_str()) { // Filter out old "conversationCompacted" messages from pre-14.0 Some("conversationCompacted") => {} // Migrate old "reasoning" content to "thinking". Invalid legacy reasoning // blocks are dropped so they don't fail deserialization. Some("reasoning") => { if let Some(text) = item.get("text").and_then(|v| v.as_str()) { migrated.push(serde_json::json!({ "type": "thinking", "thinking": text, "signature": "" })); } } _ => migrated.push(item), } } let mut content: Vec = serde_json::from_value(serde_json::Value::Array(migrated)) .map_err(|e| Error::custom(format!("Failed to deserialize MessageContent: {}", e)))?; for message_content in &mut content { if let MessageContent::Text(text_content) = message_content { let original = &text_content.text; let sanitized = sanitize_unicode_tags(original); if *original != sanitized { tracing::info!( original = %original, sanitized = %sanitized, removed_count = original.len() - sanitized.len(), "Unicode Tags sanitized during Message deserialization" ); text_content.text = sanitized; } } } Ok(content) } /// Provider-specific metadata for tool requests/responses. /// Allows providers to store custom data without polluting the core model. pub type ProviderMetadata = serde_json::Map; #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] #[derive(ToSchema)] pub struct ToolRequest { pub id: String, #[serde(with = "tool_result_serde")] #[schema(value_type = Object)] pub tool_call: ToolResult, #[serde(skip_serializing_if = "Option::is_none")] #[schema(value_type = Object)] pub metadata: Option, #[serde(rename = "_meta", skip_serializing_if = "Option::is_none")] #[schema(value_type = Object)] pub tool_meta: Option, } impl ToolRequest { pub fn to_readable_string(&self) -> String { match &self.tool_call { Ok(tool_call) => { format!( "Tool: {}, Args: {}", tool_call.name, serde_json::to_string_pretty(&tool_call.arguments) .unwrap_or_else(|_| "<>".to_string()) ) } Err(e) => format!("Invalid tool call: {}", e), } } /// Returns true if this tool request was already executed externally /// (e.g. by an ACP provider's underlying SDK) and the agent loop must /// not redispatch it. See [`TOOL_META_EXTERNAL_DISPATCH_KEY`]. pub fn is_externally_dispatched(&self) -> bool { self.tool_meta .as_ref() .and_then(|v| v.get(TOOL_META_EXTERNAL_DISPATCH_KEY)) .and_then(|v| v.as_bool()) .unwrap_or(false) } } /// Marker key under `ToolRequest.tool_meta` indicating the tool was already /// executed externally; the agent loop must skip redispatch. pub const TOOL_META_EXTERNAL_DISPATCH_KEY: &str = "goose.external_dispatch"; #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] #[derive(ToSchema)] pub struct ToolResponse { pub id: String, #[serde(with = "tool_result_serde::call_tool_result")] #[schema(value_type = Object)] pub tool_result: ToolResult, #[serde(skip_serializing_if = "Option::is_none")] #[schema(value_type = Object)] pub metadata: Option, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] #[derive(ToSchema)] pub struct ToolConfirmationRequest { pub id: String, pub tool_name: String, pub arguments: JsonObject, pub prompt: Option, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] #[serde(tag = "actionType", rename_all = "camelCase")] pub enum ActionRequiredData { #[serde(rename_all = "camelCase")] ToolConfirmation { id: String, tool_name: String, arguments: JsonObject, prompt: Option, }, Elicitation { id: String, message: String, requested_schema: serde_json::Value, }, ElicitationResponse { id: String, user_data: serde_json::Value, }, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] #[serde(rename_all = "camelCase")] pub struct ActionRequired { pub data: ActionRequiredData, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] pub struct ThinkingContent { pub thinking: String, pub signature: String, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] pub struct RedactedThinkingContent { pub data: String, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] #[serde(rename_all = "camelCase")] pub struct FrontendToolRequest { pub id: String, #[serde(with = "tool_result_serde")] #[schema(value_type = Object)] pub tool_call: ToolResult, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] #[serde(rename_all = "camelCase")] pub enum SystemNotificationType { ThinkingMessage, InlineMessage, CreditsExhausted, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] #[serde(rename_all = "camelCase")] pub struct SystemNotificationContent { pub notification_type: SystemNotificationType, pub msg: String, #[serde(skip_serializing_if = "Option::is_none")] pub data: Option, } #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)] /// Content passed inside a message, which can be both simple content and tool content #[serde(tag = "type", rename_all = "camelCase")] pub enum MessageContent { Text(TextContent), Image(ImageContent), ToolRequest(ToolRequest), ToolResponse(ToolResponse), ToolConfirmationRequest(ToolConfirmationRequest), ActionRequired(ActionRequired), FrontendToolRequest(FrontendToolRequest), Thinking(ThinkingContent), RedactedThinking(RedactedThinkingContent), SystemNotification(SystemNotificationContent), } impl fmt::Display for MessageContent { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { MessageContent::Text(t) => write!(f, "{}", t.text), MessageContent::Image(i) => write!(f, "[Image: {}]", i.mime_type), MessageContent::ToolRequest(r) => { write!(f, "[ToolRequest: {}]", r.to_readable_string()) } MessageContent::ToolResponse(r) => write!( f, "[ToolResponse: {}]", match &r.tool_result { Ok(result) => format!("{} content item(s)", result.content.len()), Err(e) => format!("Error: {e}"), } ), MessageContent::ToolConfirmationRequest(r) => { write!(f, "[ToolConfirmationRequest: {}]", r.tool_name) } MessageContent::ActionRequired(a) => match &a.data { ActionRequiredData::ToolConfirmation { tool_name, .. } => { write!(f, "[ActionRequired: ToolConfirmation for {}]", tool_name) } ActionRequiredData::Elicitation { message, .. } => { write!(f, "[ActionRequired: Elicitation - {}]", message) } ActionRequiredData::ElicitationResponse { id, .. } => { write!(f, "[ActionRequired: ElicitationResponse for {}]", id) } }, MessageContent::FrontendToolRequest(r) => match &r.tool_call { Ok(tool_call) => write!(f, "[FrontendToolRequest: {}]", tool_call.name), Err(e) => write!(f, "[FrontendToolRequest: Error: {}]", e), }, MessageContent::Thinking(t) => write!(f, "[Thinking: {}]", t.thinking), MessageContent::RedactedThinking(_r) => write!(f, "[RedactedThinking]"), MessageContent::SystemNotification(r) => { write!(f, "[SystemNotification: {}]", r.msg) } } } } impl MessageContent { pub fn text>(text: S) -> Self { MessageContent::Text( RawTextContent { text: text.into(), meta: None, } .no_annotation(), ) } pub fn filter_for_audience(&self, audience: Role) -> Option { match self { MessageContent::Text(text) => { if text .audience() .map(|roles| roles.contains(&audience)) .unwrap_or(true) { Some(self.clone()) } else { None } } MessageContent::Image(img) => { if img .audience() .map(|roles| roles.contains(&audience)) .unwrap_or(true) { Some(self.clone()) } else { None } } MessageContent::ToolResponse(res) => { let Ok(result) = &res.tool_result else { return Some(self.clone()); }; let filtered_content: Vec = result .content .iter() .filter(|c| { c.audience() .map(|roles| roles.contains(&audience)) .unwrap_or(true) }) .cloned() .collect(); // Preserve ToolResponse even when content is empty - some providers // (like Google) need to handle empty tool responses specially let mut tool_result = result.clone(); tool_result.content = filtered_content; Some(MessageContent::ToolResponse(ToolResponse { id: res.id.clone(), tool_result: Ok(tool_result), metadata: res.metadata.clone(), })) } MessageContent::Thinking(_) | MessageContent::RedactedThinking(_) => None, _ => Some(self.clone()), } } pub fn image, T: Into>(data: S, mime_type: T) -> Self { MessageContent::Image( RawImageContent { data: data.into(), mime_type: mime_type.into(), meta: None, } .no_annotation(), ) } pub fn tool_request>( id: S, tool_call: ToolResult, ) -> Self { MessageContent::ToolRequest(ToolRequest { id: id.into(), tool_call, metadata: None, tool_meta: None, }) } pub fn tool_request_with_metadata>( id: S, tool_call: ToolResult, metadata: Option<&ProviderMetadata>, ) -> Self { MessageContent::ToolRequest(ToolRequest { id: id.into(), tool_call, metadata: metadata.cloned(), tool_meta: None, }) } pub fn tool_response>(id: S, tool_result: ToolResult) -> Self { MessageContent::ToolResponse(ToolResponse { id: id.into(), tool_result, metadata: None, }) } pub fn tool_response_with_metadata>( id: S, tool_result: ToolResult, metadata: Option<&ProviderMetadata>, ) -> Self { MessageContent::ToolResponse(ToolResponse { id: id.into(), tool_result, metadata: metadata.cloned(), }) } pub fn action_required>( id: S, tool_name: String, arguments: JsonObject, prompt: Option, ) -> Self { MessageContent::ActionRequired(ActionRequired { data: ActionRequiredData::ToolConfirmation { id: id.into(), tool_name, arguments, prompt, }, }) } pub fn action_required_elicitation>( id: S, message: String, requested_schema: serde_json::Value, ) -> Self { MessageContent::ActionRequired(ActionRequired { data: ActionRequiredData::Elicitation { id: id.into(), message, requested_schema, }, }) } pub fn action_required_elicitation_response>( id: S, user_data: serde_json::Value, ) -> Self { MessageContent::ActionRequired(ActionRequired { data: ActionRequiredData::ElicitationResponse { id: id.into(), user_data, }, }) } pub fn thinking, S2: Into>(thinking: S1, signature: S2) -> Self { MessageContent::Thinking(ThinkingContent { thinking: thinking.into(), signature: signature.into(), }) } pub fn redacted_thinking>(data: S) -> Self { MessageContent::RedactedThinking(RedactedThinkingContent { data: data.into() }) } pub fn frontend_tool_request>( id: S, tool_call: ToolResult, ) -> Self { MessageContent::FrontendToolRequest(FrontendToolRequest { id: id.into(), tool_call, }) } pub fn system_notification>( notification_type: SystemNotificationType, msg: S, ) -> Self { MessageContent::SystemNotification(SystemNotificationContent { notification_type, msg: msg.into(), data: None, }) } pub fn system_notification_with_data>( notification_type: SystemNotificationType, msg: S, data: serde_json::Value, ) -> Self { MessageContent::SystemNotification(SystemNotificationContent { notification_type, msg: msg.into(), data: Some(data), }) } pub fn as_system_notification(&self) -> Option<&SystemNotificationContent> { if let MessageContent::SystemNotification(ref notification) = self { Some(notification) } else { None } } pub fn as_tool_request(&self) -> Option<&ToolRequest> { if let MessageContent::ToolRequest(ref tool_request) = self { Some(tool_request) } else { None } } pub fn as_tool_response(&self) -> Option<&ToolResponse> { if let MessageContent::ToolResponse(ref tool_response) = self { Some(tool_response) } else { None } } pub fn as_action_required(&self) -> Option<&ActionRequired> { if let MessageContent::ActionRequired(ref action_required) = self { Some(action_required) } else { None } } pub fn as_tool_response_text(&self) -> Option { if let Some(tool_response) = self.as_tool_response() { if let Ok(result) = &tool_response.tool_result { let texts: Vec = result .content .iter() .filter_map(|content| content.as_text().map(|t| t.text.to_string())) .collect(); if !texts.is_empty() { return Some(texts.join("\n")); } } } None } /// Get the text content if this is a TextContent variant pub fn as_text(&self) -> Option<&str> { match self { MessageContent::Text(text) => Some(&text.text), _ => None, } } /// Get the thinking content if this is a ThinkingContent variant pub fn as_thinking(&self) -> Option<&ThinkingContent> { match self { MessageContent::Thinking(thinking) => Some(thinking), _ => None, } } /// Get the redacted thinking content if this is a RedactedThinkingContent variant pub fn as_redacted_thinking(&self) -> Option<&RedactedThinkingContent> { match self { MessageContent::RedactedThinking(redacted) => Some(redacted), _ => None, } } } impl From for MessageContent { fn from(content: Content) -> Self { match content.raw { RawContent::Text(text) => { MessageContent::Text(text.optional_annotate(content.annotations)) } RawContent::Image(image) => { MessageContent::Image(image.optional_annotate(content.annotations)) } RawContent::ResourceLink(_link) => MessageContent::text("[Resource link]"), RawContent::Resource(resource) => { MessageContent::text(extract_text_from_resource(&resource.resource)) } RawContent::Audio(_) => { MessageContent::text("[Audio content: not supported]".to_string()) } } } } impl From for Message { fn from(prompt_message: PromptMessage) -> Self { // Create a new message with the appropriate role let message = match prompt_message.role { PromptMessageRole::User => Message::user(), PromptMessageRole::Assistant => Message::assistant(), }; // Convert and add the content let content = match prompt_message.content { PromptMessageContent::Text { text } => MessageContent::text(text), PromptMessageContent::Image { image } => { MessageContent::image(image.data.clone(), image.mime_type.clone()) } PromptMessageContent::ResourceLink { .. } => MessageContent::text("[Resource link]"), PromptMessageContent::Resource { resource } => { MessageContent::text(extract_text_from_resource(&resource.resource)) } }; message.with_content(content) } } #[derive(ToSchema, Clone, Copy, PartialEq, Serialize, Deserialize, Debug)] /// Metadata for message visibility #[serde(rename_all = "camelCase")] pub struct MessageMetadata { /// Whether the message should be visible to the user in the UI pub user_visible: bool, /// Whether the message should be included in the agent's context window pub agent_visible: bool, } impl Default for MessageMetadata { fn default() -> Self { MessageMetadata { user_visible: true, agent_visible: true, } } } impl MessageMetadata { /// Create metadata for messages visible only to the agent pub fn agent_only() -> Self { MessageMetadata { user_visible: false, agent_visible: true, } } /// Create metadata for messages visible only to the user pub fn user_only() -> Self { MessageMetadata { user_visible: true, agent_visible: false, } } /// Create metadata for messages visible to neither user nor agent (archived) pub fn invisible() -> Self { MessageMetadata { user_visible: false, agent_visible: false, } } /// Return a copy with agent_visible set to false pub fn with_agent_invisible(self) -> Self { Self { agent_visible: false, ..self } } /// Return a copy with user_visible set to false pub fn with_user_invisible(self) -> Self { Self { user_visible: false, ..self } } /// Return a copy with agent_visible set to true pub fn with_agent_visible(self) -> Self { Self { agent_visible: true, ..self } } /// Return a copy with user_visible set to true pub fn with_user_visible(self) -> Self { Self { user_visible: true, ..self } } } #[derive(ToSchema, Clone, PartialEq, Serialize, Deserialize, Debug)] /// A message to or from an LLM #[serde(rename_all = "camelCase")] pub struct Message { pub id: Option, pub role: Role, pub created: i64, #[serde(deserialize_with = "deserialize_sanitized_content")] pub content: Vec, pub metadata: MessageMetadata, } impl Message { pub fn new(role: Role, created: i64, content: Vec) -> Self { Message { id: None, role, created, content, metadata: MessageMetadata::default(), } } pub fn debug(&self) -> String { format!("{:?}", self) } pub fn agent_visible_content(&self) -> Message { let filtered_content = self .content .iter() .filter_map(|c| c.filter_for_audience(Role::Assistant)) .collect(); Message { content: filtered_content, ..self.clone() } } /// Create a new user message with the current timestamp pub fn user() -> Self { Message { id: None, role: Role::User, created: Utc::now().timestamp(), content: Vec::new(), metadata: MessageMetadata::default(), } } /// Create a new assistant message with the current timestamp pub fn assistant() -> Self { Message { id: None, role: Role::Assistant, created: Utc::now().timestamp(), content: Vec::new(), metadata: MessageMetadata::default(), } } pub fn with_id>(mut self, id: S) -> Self { self.id = Some(id.into()); self } pub fn with_generated_id(self) -> Self { self.with_id(format!("msg_{}", Uuid::new_v4())) } /// Add any MessageContent to the message pub fn with_content(mut self, content: MessageContent) -> Self { self.content.push(content); self } /// Add text content to the message pub fn with_text>(self, text: S) -> Self { let raw_text = text.into(); let sanitized_text = sanitize_unicode_tags(&raw_text); self.with_content(MessageContent::Text( RawTextContent { text: sanitized_text, meta: None, } .no_annotation(), )) } /// Add image content to the message pub fn with_image, T: Into>(self, data: S, mime_type: T) -> Self { self.with_content(MessageContent::image(data, mime_type)) } /// Add a tool request to the message pub fn with_tool_request>( self, id: S, tool_call: ToolResult, ) -> Self { self.with_content(MessageContent::tool_request(id, tool_call)) } pub fn with_tool_request_with_metadata>( self, id: S, tool_call: ToolResult, metadata: Option<&ProviderMetadata>, tool_meta: Option, ) -> Self { self.with_content(MessageContent::ToolRequest(ToolRequest { id: id.into(), tool_call, metadata: metadata.cloned(), tool_meta, })) } pub fn with_tool_response>( self, id: S, result: ToolResult, ) -> Self { self.with_content(MessageContent::tool_response(id, result)) } pub fn add_tool_response_with_metadata>( &mut self, id: S, result: ToolResult, metadata: Option<&ProviderMetadata>, ) { self.content .push(MessageContent::tool_response_with_metadata( id, result, metadata, )); } /// Add an action required message for tool confirmation pub fn with_action_required>( self, id: S, tool_name: String, arguments: JsonObject, prompt: Option, ) -> Self { self.with_content(MessageContent::action_required( id, tool_name, arguments, prompt, )) } pub fn with_frontend_tool_request>( self, id: S, tool_call: ToolResult, ) -> Self { self.with_content(MessageContent::frontend_tool_request(id, tool_call)) } /// Add thinking content to the message pub fn with_thinking, S2: Into>( self, thinking: S1, signature: S2, ) -> Self { self.with_content(MessageContent::thinking(thinking, signature)) } /// Add redacted thinking content to the message pub fn with_redacted_thinking>(self, data: S) -> Self { self.with_content(MessageContent::redacted_thinking(data)) } /// Get the concatenated text content of the message, separated by newlines pub fn as_concat_text(&self) -> String { self.content .iter() .filter_map(|c| c.as_text()) .collect::>() .join("\n") } /// Check if the message is a tool call pub fn is_tool_call(&self) -> bool { self.content .iter() .any(|c| matches!(c, MessageContent::ToolRequest(_))) } /// Check if the message is a tool response pub fn is_tool_response(&self) -> bool { self.content .iter() .any(|c| matches!(c, MessageContent::ToolResponse(_))) } /// Retrieves all tool `id` from the message pub fn get_tool_ids(&self) -> HashSet<&str> { self.content .iter() .filter_map(|content| match content { MessageContent::ToolRequest(req) => Some(req.id.as_str()), MessageContent::ToolResponse(res) => Some(res.id.as_str()), _ => None, }) .collect() } /// Retrieves all tool `id` from ToolRequest messages pub fn get_tool_request_ids(&self) -> HashSet<&str> { self.content .iter() .filter_map(|content| { if let MessageContent::ToolRequest(req) = content { Some(req.id.as_str()) } else { None } }) .collect() } /// Retrieves all tool `id` from ToolResponse messages pub fn get_tool_response_ids(&self) -> HashSet<&str> { self.content .iter() .filter_map(|content| { if let MessageContent::ToolResponse(res) = content { Some(res.id.as_str()) } else { None } }) .collect() } /// Check if the message has only TextContent pub fn has_only_text_content(&self) -> bool { self.content .iter() .all(|c| matches!(c, MessageContent::Text(_))) } pub fn with_system_notification>( self, notification_type: SystemNotificationType, msg: S, ) -> Self { self.with_content(MessageContent::system_notification(notification_type, msg)) .with_metadata(MessageMetadata::user_only()) } pub fn with_system_notification_with_data>( self, notification_type: SystemNotificationType, msg: S, data: serde_json::Value, ) -> Self { self.with_content(MessageContent::system_notification_with_data( notification_type, msg, data, )) .with_metadata(MessageMetadata::user_only()) } pub fn with_visibility(mut self, user_visible: bool, agent_visible: bool) -> Self { self.metadata.user_visible = user_visible; self.metadata.agent_visible = agent_visible; self } pub fn with_metadata(mut self, metadata: MessageMetadata) -> Self { self.metadata = metadata; self } pub fn user_only(mut self) -> Self { self.metadata.user_visible = true; self.metadata.agent_visible = false; self } pub fn agent_only(mut self) -> Self { self.metadata.user_visible = false; self.metadata.agent_visible = true; self } pub fn is_user_visible(&self) -> bool { self.metadata.user_visible } pub fn is_agent_visible(&self) -> bool { self.metadata.agent_visible } } #[derive(Debug, Clone, Default, Serialize, Deserialize, ToSchema)] #[serde(rename_all = "camelCase")] pub struct TokenState { pub input_tokens: i32, pub output_tokens: i32, pub total_tokens: i32, pub accumulated_input_tokens: i32, pub accumulated_output_tokens: i32, pub accumulated_total_tokens: i32, } #[cfg(test)] mod tests { use crate::conversation::message::{Message, MessageContent, MessageMetadata}; use crate::conversation::*; use rmcp::model::{ AnnotateAble, CallToolRequestParams, PromptMessage, PromptMessageContent, PromptMessageRole, RawEmbeddedResource, RawImageContent, ResourceContents, }; use rmcp::model::{ErrorCode, ErrorData}; use rmcp::object; use serde_json::Value; #[test] fn test_sanitize_with_text() { let malicious = "Hello\u{E0041}\u{E0042}\u{E0043}world"; // Invisible "ABC" let message = Message::user().with_text(malicious); assert_eq!(message.as_concat_text(), "Helloworld"); } #[test] fn test_no_sanitize_with_text() { let clean_text = "Hello world 世界 🌍"; let message = Message::user().with_text(clean_text); assert_eq!(message.as_concat_text(), clean_text); } #[test] fn test_message_serialization() { let message = Message::assistant() .with_text("Hello, I'll help you with that.") .with_tool_request( "tool123", Ok(CallToolRequestParams::new("test_tool") .with_arguments(object!({"param": "value"}))), ); let json_str = serde_json::to_string_pretty(&message).unwrap(); println!("Serialized message: {}", json_str); // Parse back to Value to check structure let value: Value = serde_json::from_str(&json_str).unwrap(); // Check top-level fields assert_eq!(value["role"], "assistant"); assert!(value["created"].is_i64()); assert!(value["content"].is_array()); // Check content items let content = &value["content"]; // First item should be text assert_eq!(content[0]["type"], "text"); assert_eq!(content[0]["text"], "Hello, I'll help you with that."); // Second item should be toolRequest assert_eq!(content[1]["type"], "toolRequest"); assert_eq!(content[1]["id"], "tool123"); // Check tool_call serialization assert_eq!(content[1]["toolCall"]["status"], "success"); assert_eq!(content[1]["toolCall"]["value"]["name"], "test_tool"); assert_eq!( content[1]["toolCall"]["value"]["arguments"]["param"], "value" ); } #[test] fn test_error_serialization() { let message = Message::assistant().with_tool_request( "tool123", Err(ErrorData { code: ErrorCode::INTERNAL_ERROR, message: std::borrow::Cow::from("Something went wrong".to_string()), data: None, }), ); let json_str = serde_json::to_string_pretty(&message).unwrap(); println!("Serialized error: {}", json_str); // Parse back to Value to check structure let value: Value = serde_json::from_str(&json_str).unwrap(); // Check tool_call serialization with error let tool_call = &value["content"][0]["toolCall"]; assert_eq!(tool_call["status"], "error"); assert_eq!(tool_call["error"], "-32603: Something went wrong"); } #[test] fn test_deserialization() { // Create a JSON string with our new format let json_str = r#"{ "role": "assistant", "created": 1740171566, "content": [ { "type": "text", "text": "I'll help you with that." }, { "type": "toolRequest", "id": "tool123", "toolCall": { "status": "success", "value": { "name": "test_tool", "arguments": {"param": "value"} } } } ], "metadata": { "agentVisible": true, "userVisible": true } }"#; let message: Message = serde_json::from_str(json_str).unwrap(); assert_eq!(message.role, Role::Assistant); assert_eq!(message.created, 1740171566); assert_eq!(message.content.len(), 2); // Check first content item if let MessageContent::Text(text) = &message.content[0] { assert_eq!(text.text, "I'll help you with that."); } else { panic!("Expected Text content"); } // Check second content item if let MessageContent::ToolRequest(req) = &message.content[1] { assert_eq!(req.id, "tool123"); if let Ok(tool_call) = &req.tool_call { assert_eq!(tool_call.name, "test_tool"); assert_eq!(tool_call.arguments, Some(object!({"param": "value"}))) } else { panic!("Expected successful tool call"); } } else { panic!("Expected ToolRequest content"); } } #[test] fn test_deserialization_migrates_reasoning_to_thinking() { let json = serde_json::json!({ "role": "assistant", "created": 1740171566, "content": [ { "type": "reasoning", "text": "step by step" }, { "type": "text", "text": "final answer" } ], "metadata": { "agentVisible": true, "userVisible": true } }); let message: Message = serde_json::from_value(json).unwrap(); assert_eq!(message.content.len(), 2); let MessageContent::Thinking(thinking) = &message.content[0] else { panic!("Expected Thinking content"); }; assert_eq!(thinking.thinking, "step by step"); assert!(thinking.signature.is_empty()); } #[test] fn test_deserialization_drops_invalid_reasoning_blocks() { let json = serde_json::json!({ "role": "assistant", "created": 1740171566, "content": [ { "type": "reasoning" }, { "type": "reasoning", "text": 42 }, { "type": "text", "text": "still here" } ], "metadata": { "agentVisible": true, "userVisible": true } }); let message: Message = serde_json::from_value(json).unwrap(); assert_eq!(message.content.len(), 1); let MessageContent::Text(text) = &message.content[0] else { panic!("Expected Text content"); }; assert_eq!(text.text, "still here"); } #[test] fn test_from_prompt_message_text() { let prompt_content = PromptMessageContent::Text { text: "Hello, world!".to_string(), }; let prompt_message = PromptMessage::new(PromptMessageRole::User, prompt_content); let message = Message::from(prompt_message); if let MessageContent::Text(text_content) = &message.content[0] { assert_eq!(text_content.text, "Hello, world!"); } else { panic!("Expected MessageContent::Text"); } } #[test] fn test_from_prompt_message_image() { let prompt_content = PromptMessageContent::Image { image: RawImageContent { data: "base64data".to_string(), mime_type: "image/jpeg".to_string(), meta: None, } .no_annotation(), }; let prompt_message = PromptMessage::new(PromptMessageRole::User, prompt_content); let message = Message::from(prompt_message); if let MessageContent::Image(image_content) = &message.content[0] { assert_eq!(image_content.data, "base64data"); assert_eq!(image_content.mime_type, "image/jpeg"); } else { panic!("Expected MessageContent::Image"); } } #[test] fn test_from_prompt_message_text_resource() { let resource = ResourceContents::TextResourceContents { uri: "file:///test.txt".to_string(), mime_type: Some("text/plain".to_string()), text: "Resource content".to_string(), meta: None, }; let prompt_content = PromptMessageContent::Resource { resource: RawEmbeddedResource { resource, meta: None, } .no_annotation(), }; let prompt_message = PromptMessage::new(PromptMessageRole::User, prompt_content); let message = Message::from(prompt_message); if let MessageContent::Text(text_content) = &message.content[0] { assert_eq!(text_content.text, "Resource content"); } else { panic!("Expected MessageContent::Text"); } } #[test] fn test_from_prompt_message() { // Test user message conversion let prompt_message = PromptMessage::new( PromptMessageRole::User, PromptMessageContent::Text { text: "Hello, world!".to_string(), }, ); let message = Message::from(prompt_message); assert_eq!(message.role, Role::User); assert_eq!(message.content.len(), 1); assert_eq!(message.as_concat_text(), "Hello, world!"); // Test assistant message conversion let prompt_message = PromptMessage::new( PromptMessageRole::Assistant, PromptMessageContent::Text { text: "I can help with that.".to_string(), }, ); let message = Message::from(prompt_message); assert_eq!(message.role, Role::Assistant); assert_eq!(message.content.len(), 1); assert_eq!(message.as_concat_text(), "I can help with that."); } #[test] fn test_message_with_text() { let message = Message::user().with_text("Hello"); assert_eq!(message.as_concat_text(), "Hello"); } #[test] fn test_message_with_tool_request() { let tool_call = Ok(CallToolRequestParams::new("test_tool").with_arguments(object!({}))); let message = Message::assistant().with_tool_request("req1", tool_call); assert!(message.is_tool_call()); assert!(!message.is_tool_response()); let ids = message.get_tool_ids(); assert_eq!(ids.len(), 1); assert!(ids.contains("req1")); } #[test] fn test_message_deserialization_sanitizes_text_content() { // Create a test string with Unicode Tags characters let malicious_text = "Hello\u{E0041}\u{E0042}\u{E0043}world"; let malicious_json = format!( r#"{{ "id": "test-id", "role": "user", "created": 1640995200, "content": [ {{ "type": "text", "text": "{}" }}, {{ "type": "image", "data": "base64data", "mimeType": "image/png" }} ], "metadata": {{ "agentVisible": true, "userVisible": true }} }}"#, malicious_text ); let message: Message = serde_json::from_str(&malicious_json).unwrap(); // Text content should be sanitized assert_eq!(message.as_concat_text(), "Helloworld"); // Image content should be unchanged if let MessageContent::Image(img) = &message.content[1] { assert_eq!(img.data, "base64data"); assert_eq!(img.mime_type, "image/png"); } else { panic!("Expected ImageContent"); } } #[test] fn test_legitimate_unicode_preserved_during_message_deserialization() { let clean_json = r#"{ "id": "test-id", "role": "user", "created": 1640995200, "content": [{ "type": "text", "text": "Hello world 世界 🌍" }], "metadata": { "agentVisible": true, "userVisible": true } }"#; let message: Message = serde_json::from_str(clean_json).unwrap(); assert_eq!(message.as_concat_text(), "Hello world 世界 🌍"); } #[test] fn test_message_metadata_defaults() { let message = Message::user().with_text("Test"); // By default, messages should be both user and agent visible assert!(message.is_user_visible()); assert!(message.is_agent_visible()); } #[test] fn test_message_visibility_methods() { // Test user_only let user_only_msg = Message::user().with_text("User only").user_only(); assert!(user_only_msg.is_user_visible()); assert!(!user_only_msg.is_agent_visible()); // Test agent_only let agent_only_msg = Message::assistant().with_text("Agent only").agent_only(); assert!(!agent_only_msg.is_user_visible()); assert!(agent_only_msg.is_agent_visible()); // Test with_visibility let custom_msg = Message::user() .with_text("Custom visibility") .with_visibility(false, true); assert!(!custom_msg.is_user_visible()); assert!(custom_msg.is_agent_visible()); } #[test] fn test_message_metadata_serialization() { let message = Message::user() .with_text("Test message") .with_visibility(false, true); let json_str = serde_json::to_string(&message).unwrap(); let value: Value = serde_json::from_str(&json_str).unwrap(); assert_eq!(value["metadata"]["userVisible"], false); assert_eq!(value["metadata"]["agentVisible"], true); } #[test] fn test_message_metadata_deserialization() { // Test with explicit metadata let json_with_metadata = r#"{ "role": "user", "created": 1640995200, "content": [{ "type": "text", "text": "Test" }], "metadata": { "userVisible": false, "agentVisible": true } }"#; let message: Message = serde_json::from_str(json_with_metadata).unwrap(); assert!(!message.is_user_visible()); assert!(message.is_agent_visible()); } #[test] fn test_message_metadata_static_methods() { // Test MessageMetadata::agent_only() let agent_only_metadata = MessageMetadata::agent_only(); assert!(!agent_only_metadata.user_visible); assert!(agent_only_metadata.agent_visible); // Test MessageMetadata::user_only() let user_only_metadata = MessageMetadata::user_only(); assert!(user_only_metadata.user_visible); assert!(!user_only_metadata.agent_visible); // Test MessageMetadata::invisible() let invisible_metadata = MessageMetadata::invisible(); assert!(!invisible_metadata.user_visible); assert!(!invisible_metadata.agent_visible); // Test using them with messages let agent_msg = Message::assistant() .with_text("Agent only message") .with_metadata(MessageMetadata::agent_only()); assert!(!agent_msg.is_user_visible()); assert!(agent_msg.is_agent_visible()); let user_msg = Message::user() .with_text("User only message") .with_metadata(MessageMetadata::user_only()); assert!(user_msg.is_user_visible()); assert!(!user_msg.is_agent_visible()); let invisible_msg = Message::user() .with_text("Invisible message") .with_metadata(MessageMetadata::invisible()); assert!(!invisible_msg.is_user_visible()); assert!(!invisible_msg.is_agent_visible()); } #[test] fn test_message_metadata_builder_methods() { // Test with_agent_invisible let metadata = MessageMetadata::default().with_agent_invisible(); assert!(metadata.user_visible); assert!(!metadata.agent_visible); // Test with_user_invisible let metadata = MessageMetadata::default().with_user_invisible(); assert!(!metadata.user_visible); assert!(metadata.agent_visible); // Test with_agent_visible let metadata = MessageMetadata::invisible().with_agent_visible(); assert!(!metadata.user_visible); assert!(metadata.agent_visible); // Test with_user_visible let metadata = MessageMetadata::invisible().with_user_visible(); assert!(metadata.user_visible); assert!(!metadata.agent_visible); // Test chaining let metadata = MessageMetadata::invisible() .with_user_visible() .with_agent_visible(); assert!(metadata.user_visible); assert!(metadata.agent_visible); } #[test] fn test_legacy_tool_response_deserialization() { let legacy_json = r#"{ "role": "user", "created": 1640995200, "content": [{ "type": "toolResponse", "id": "tool123", "toolResult": { "status": "success", "value": [ { "type": "text", "text": "Tool output text" } ] } }], "metadata": { "agentVisible": true, "userVisible": true } }"#; let message: Message = serde_json::from_str(legacy_json).unwrap(); assert_eq!(message.content.len(), 1); if let MessageContent::ToolResponse(response) = &message.content[0] { assert_eq!(response.id, "tool123"); if let Ok(result) = &response.tool_result { assert_eq!(result.content.len(), 1); assert_eq!( result.content[0].as_text().unwrap().text, "Tool output text" ); } else { panic!("Expected successful tool result"); } } else { panic!("Expected ToolResponse content"); } } #[test] fn test_new_tool_response_deserialization() { let new_json = r#"{ "role": "user", "created": 1640995200, "content": [{ "type": "toolResponse", "id": "tool456", "toolResult": { "status": "success", "value": { "content": [ { "type": "text", "text": "New format output" } ], "isError": false } } }], "metadata": { "agentVisible": true, "userVisible": true } }"#; let message: Message = serde_json::from_str(new_json).unwrap(); assert_eq!(message.content.len(), 1); if let MessageContent::ToolResponse(response) = &message.content[0] { assert_eq!(response.id, "tool456"); if let Ok(result) = &response.tool_result { assert_eq!(result.content.len(), 1); assert_eq!( result.content[0].as_text().unwrap().text, "New format output" ); } else { panic!("Expected successful tool result"); } } else { panic!("Expected ToolResponse content"); } } #[test] fn test_tool_request_with_value_arguments_backward_compatibility() { struct TestCase { name: &'static str, arguments_json: &'static str, expected: Option, } let test_cases = [ TestCase { name: "string", arguments_json: r#""string_argument""#, expected: Some(serde_json::json!({"value": "string_argument"})), }, TestCase { name: "array", arguments_json: r#"["a", "b", "c"]"#, expected: Some(serde_json::json!({"value": ["a", "b", "c"]})), }, TestCase { name: "number", arguments_json: "42", expected: Some(serde_json::json!({"value": 42})), }, TestCase { name: "null", arguments_json: "null", expected: None, }, TestCase { name: "object", arguments_json: r#"{"key": "value", "number": 123}"#, expected: Some(serde_json::json!({"key": "value", "number": 123})), }, ]; for tc in test_cases { let json = format!( r#"{{ "role": "assistant", "created": 1640995200, "content": [{{ "type": "toolRequest", "id": "tool123", "toolCall": {{ "status": "success", "value": {{ "name": "test_tool", "arguments": {} }} }} }}], "metadata": {{ "agentVisible": true, "userVisible": true }} }}"#, tc.arguments_json ); let message: Message = serde_json::from_str(&json) .unwrap_or_else(|e| panic!("{}: parse failed: {}", tc.name, e)); let MessageContent::ToolRequest(request) = &message.content[0] else { panic!("{}: expected ToolRequest content", tc.name); }; let Ok(tool_call) = &request.tool_call else { panic!("{}: expected successful tool call", tc.name); }; assert_eq!(tool_call.name, "test_tool", "{}: wrong tool name", tc.name); match (&tool_call.arguments, &tc.expected) { (None, None) => {} (Some(args), Some(expected)) => { let args_value = serde_json::to_value(args).unwrap(); assert_eq!(&args_value, expected, "{}: arguments mismatch", tc.name); } (actual, expected) => { panic!("{}: expected {:?}, got {:?}", tc.name, expected, actual); } } } } }