portugalfuturista/rust-sdk
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: api ergonomics follow-up (#720)

Browse source 
* fix: builder with_* methods take T instead of Option<T>

* fix: emit conditional builder calls for optional fields in macros

* fix: convert with_task, with_stop_reason, with_logger, with_content to proper builders

* fix: update test callers for new builder signatures

* fix: simplify make_task helper and remove unused import

* fix: update sampling_stdio example for new with_stop_reason signature

* fix: make annotations and execution Option<Expr> consistent with other fields

* fix: remove unused none_expr import
This commit is contained in:
Dale Seo 2026-03-03 12:05:32 -05:00 committed by GitHub
parent 1fe5d1e1cd
commit 2d90b76501
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 81 additions and 99 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
crates/rmcp-macros/src/prompt.rs
View file

@ -46,21 +46,13 @@ impl ResolvedPromptAttribute {
} else {
quote! { None::<String> }
};
let title = if let Some(title) = title {
quote! { Some(#title.into()) }
} else {
quote! { None }
};
let icons = if let Some(icons) = icons {
quote! { Some(#icons) }
} else {
quote! { None }
};
let meta = if let Some(meta) = meta {
quote! { Some(#meta) }
} else {
quote! { None }
};
let title_call = title
.map(|t| quote! { .with_title(#t) })
.unwrap_or_default();
let icons_call = icons
.map(|i| quote! { .with_icons(#i) })
.unwrap_or_default();
let meta_call = meta.map(|m| quote! { .with_meta(#m) }).unwrap_or_default();
let tokens = quote! {
pub fn #fn_ident() -> rmcp::model::Prompt {
rmcp::model::Prompt::from_raw(
@ -68,9 +60,9 @@ impl ResolvedPromptAttribute {
#description,
#arguments,
)
.with_title(#title)
.with_icons(#icons)
.with_meta(#meta)
#title_call
#icons_call
#meta_call
}
};
syn::parse2::<ImplItemFn>(tokens)

70
crates/rmcp-macros/src/tool.rs
View file

@ -3,7 +3,7 @@ use proc_macro2::{Span, TokenStream};
use quote::{ToTokens, format_ident, quote};
use syn::{Expr, Ident, ImplItemFn, LitStr, ReturnType, parse_quote};
use crate::common::{extract_doc_line, none_expr};
use crate::common::extract_doc_line;
/// Check if a type is Json<T> and extract the inner type T
fn extract_json_inner_type(ty: &syn::Type) -> Option<&syn::Type> {
@ -110,8 +110,8 @@ pub struct ResolvedToolAttribute {
pub description: Option<Expr>,
pub input_schema: Expr,
pub output_schema: Option<Expr>,
pub annotations: Expr,
pub execution: Expr,
pub annotations: Option<Expr>,
pub execution: Option<Expr>,
pub icons: Option<Expr>,
pub meta: Option<Expr>,
}
@ -134,26 +134,22 @@ impl ResolvedToolAttribute {
} else {
quote! { None }
};
let output_schema = if let Some(output_schema) = output_schema {
quote! { Some(#output_schema) }
} else {
quote! { None }
};
let title = if let Some(title) = title {
quote! { Some(#title.into()) }
} else {
quote! { None }
};
let icons = if let Some(icons) = icons {
quote! { Some(#icons) }
} else {
quote! { None }
};
let meta = if let Some(meta) = meta {
quote! { Some(#meta) }
} else {
quote! { None }
};
let title_call = title
.map(|t| quote! { .with_title(#t) })
.unwrap_or_default();
let output_schema_call = output_schema
.map(|s| quote! { .with_raw_output_schema(#s) })
.unwrap_or_default();
let annotations_call = annotations
.map(|a| quote! { .with_annotations(#a) })
.unwrap_or_default();
let execution_call = execution
.map(|e| quote! { .with_execution(#e) })
.unwrap_or_default();
let icons_call = icons
.map(|i| quote! { .with_icons(#i) })
.unwrap_or_default();
let meta_call = meta.map(|m| quote! { .with_meta(#m) }).unwrap_or_default();
let doc_comment = format!("Generated tool metadata function for {name}");
let doc_attr: syn::Attribute = parse_quote!(#[doc = #doc_comment]);
let tokens = quote! {
@ -164,12 +160,12 @@ impl ResolvedToolAttribute {
#description,
#input_schema,
)
.with_title(#title)
.with_raw_output_schema(#output_schema)
.with_annotations(#annotations)
.with_execution(#execution)
.with_icons(#icons)
.with_meta(#meta)
#title_call
#output_schema_call
#annotations_call
#execution_call
#icons_call
#meta_call
}
};
syn::parse2::<ImplItemFn>(tokens)
@ -260,17 +256,17 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
let idempotent_hint = wrap_option(idempotent_hint);
let open_world_hint = wrap_option(open_world_hint);
let token_stream = quote! {
Some(rmcp::model::ToolAnnotations::from_raw(
rmcp::model::ToolAnnotations::from_raw(
#title,
#read_only_hint,
#destructive_hint,
#idempotent_hint,
#open_world_hint,
))
)
};
syn::parse2::<Expr>(token_stream)?
Some(syn::parse2::<Expr>(token_stream)?)
} else {
none_expr()?
None
};
let execution_expr = if let Some(execution) = attribute.execution {
let ToolExecutionAttribute { task_support } = execution;
@ -296,13 +292,13 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
};
let token_stream = quote! {
Some(rmcp::model::ToolExecution::from_raw(
rmcp::model::ToolExecution::from_raw(
#task_support_expr,
))
)
};
syn::parse2::<Expr>(token_stream)?
Some(syn::parse2::<Expr>(token_stream)?)
} else {
none_expr()?
None
};
// Handle output_schema - either explicit or generated from return type
let output_schema_expr = attribute.output_schema.or_else(|| {

29
crates/rmcp/src/model.rs
View file

@ -1455,13 +1455,10 @@ impl LoggingMessageNotificationParam {
}
}
/// Create with a logger name.
pub fn with_logger(level: LoggingLevel, logger: impl Into<String>, data: Value) -> Self {
Self {
level,
logger: Some(logger.into()),
data,
}
/// Set the logger name.
pub fn with_logger(mut self, logger: impl Into<String>) -> Self {
self.logger = Some(logger.into());
self
}
}
@ -2605,12 +2602,10 @@ impl CreateElicitationResult {
}
}
/// Create with content.
pub fn with_content(action: ElicitationAction, content: Value) -> Self {
Self {
action,
content: Some(content),
}
/// Set the content on this result.
pub fn with_content(mut self, content: Value) -> Self {
self.content = Some(content);
self
}
}
@ -2822,8 +2817,8 @@ impl CallToolRequestParams {
}
/// Sets the task metadata for this tool call.
pub fn with_task(mut self, task: Option<JsonObject>) -> Self {
self.task = task;
pub fn with_task(mut self, task: JsonObject) -> Self {
self.task = Some(task);
self
}
}
@ -2889,8 +2884,8 @@ impl CreateMessageResult {
pub const STOP_REASON_TOOL_USE: &str = "toolUse";
/// Set the stop reason.
pub fn with_stop_reason(mut self, stop_reason: Option<String>) -> Self {
self.stop_reason = stop_reason;
pub fn with_stop_reason(mut self, stop_reason: impl Into<String>) -> Self {
self.stop_reason = Some(stop_reason.into());
self
}

12
crates/rmcp/src/model/prompt.rs
View file

@ -68,20 +68,20 @@ impl Prompt {
}
/// Set the human-readable title
pub fn with_title(mut self, title: Option<String>) -> Self {
self.title = title;
pub fn with_title(mut self, title: impl Into<String>) -> Self {
self.title = Some(title.into());
self
}
/// Set the icons
pub fn with_icons(mut self, icons: Option<Vec<Icon>>) -> Self {
self.icons = icons;
pub fn with_icons(mut self, icons: Vec<Icon>) -> Self {
self.icons = Some(icons);
self
}
/// Set the metadata
pub fn with_meta(mut self, meta: Option<Meta>) -> Self {
self.meta = meta;
pub fn with_meta(mut self, meta: Meta) -> Self {
self.meta = Some(meta);
self
}
}

24
crates/rmcp/src/model/tool.rs
View file

@ -261,32 +261,32 @@ impl Tool {
}
/// Set the human-readable title
pub fn with_title(mut self, title: Option<String>) -> Self {
self.title = title;
pub fn with_title(mut self, title: impl Into<String>) -> Self {
self.title = Some(title.into());
self
}
/// Set the output schema from a raw value
pub fn with_raw_output_schema(mut self, output_schema: Option<Arc<JsonObject>>) -> Self {
self.output_schema = output_schema;
pub fn with_raw_output_schema(mut self, output_schema: Arc<JsonObject>) -> Self {
self.output_schema = Some(output_schema);
self
}
/// Set the annotations
pub fn with_annotations(mut self, annotations: Option<ToolAnnotations>) -> Self {
self.annotations = annotations;
pub fn with_annotations(mut self, annotations: ToolAnnotations) -> Self {
self.annotations = Some(annotations);
self
}
/// Set the icons
pub fn with_icons(mut self, icons: Option<Vec<Icon>>) -> Self {
self.icons = icons;
pub fn with_icons(mut self, icons: Vec<Icon>) -> Self {
self.icons = Some(icons);
self
}
/// Set the metadata
pub fn with_meta(mut self, meta: Option<Meta>) -> Self {
self.meta = meta;
pub fn with_meta(mut self, meta: Meta) -> Self {
self.meta = Some(meta);
self
}
@ -298,8 +298,8 @@ impl Tool {
}
/// Set the execution configuration for this tool.
pub fn with_execution(mut self, execution: Option<ToolExecution>) -> Self {
self.execution = execution;
pub fn with_execution(mut self, execution: ToolExecution) -> Self {
self.execution = Some(execution);
self
}

2
crates/rmcp/tests/common/handlers.rs
View file

@ -78,7 +78,7 @@ impl ClientHandler for TestClientHandler {
SamplingMessage::assistant_text(response.to_string()),
"test-model".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_END_TURN.to_string())))
.with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN))
}
fn on_logging_message(

8
crates/rmcp/tests/test_sampling.rs
View file

@ -55,7 +55,7 @@ async fn test_sampling_result_structure() -> Result<()> {
SamplingMessage::assistant_text("The capital of France is Paris."),
"test-model".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()));
.with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN);
let json = serde_json::to_string(&result)?;
let deserialized: CreateMessageResult = serde_json::from_str(&json)?;
@ -436,7 +436,7 @@ async fn test_create_message_result_tool_use_stop_reason() -> Result<()> {
),
"test-model".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_TOOL_USE.to_string()));
.with_stop_reason(CreateMessageResult::STOP_REASON_TOOL_USE);
let json = serde_json::to_string(&result)?;
let deserialized: CreateMessageResult = serde_json::from_str(&json)?;
@ -688,7 +688,7 @@ async fn test_create_message_result_validate_rejects_user_role() {
SamplingMessage::user_text("This should not be a user message"),
"test-model".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()));
.with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN);
let err = result.validate().unwrap_err();
assert!(
@ -703,7 +703,7 @@ async fn test_create_message_result_validate_accepts_assistant_role() {
SamplingMessage::assistant_text("Hello!"),
"test-model".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_END_TURN.to_string()));
.with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN);
assert!(result.validate().is_ok());
}

5
crates/rmcp/tests/test_task_support_validation.rs
View file

@ -13,7 +13,6 @@ use rmcp::{
model::{CallToolRequestParams, ClientInfo, ErrorCode, JsonObject},
tool, tool_handler, tool_router,
};
use serde_json::json;
/// Server with tools having different task support modes.
#[derive(Debug, Clone)]
@ -75,8 +74,8 @@ impl ClientHandler for DummyClientHandler {
}
/// Helper to create a task object for tool calls
fn make_task() -> Option<JsonObject> {
Some(json!({}).as_object().unwrap().clone())
fn make_task() -> JsonObject {
serde_json::Map::new()
}
#[tokio::test]

2
examples/clients/src/sampling_stdio.rs
View file

@ -44,7 +44,7 @@ impl ClientHandler for SamplingDemoClient {
SamplingMessage::assistant_text(response_text),
"mock_llm".to_string(),
)
.with_stop_reason(Some(CreateMessageResult::STOP_REASON_END_TURN.to_string())))
.with_stop_reason(CreateMessageResult::STOP_REASON_END_TURN))
}
}