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
1 change: 1 addition & 0 deletions crates/rmcp-macros/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ proc-macro = true
syn = {version = "2", features = ["full"]}
quote = "1"
proc-macro2 = "1"
serde_json = "1.0"


[features]
Expand Down
62 changes: 59 additions & 3 deletions crates/rmcp-macros/src/tool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,45 @@ use std::collections::HashSet;

use proc_macro2::TokenStream;
use quote::{ToTokens, quote};
use serde_json::json;
use syn::{
Expr, FnArg, Ident, ItemFn, ItemImpl, MetaList, PatType, Token, Type, Visibility, parse::Parse,
parse_quote, spanned::Spanned,
Expr, FnArg, Ident, ItemFn, ItemImpl, Lit, MetaList, PatType, Token, Type, Visibility,
parse::Parse, parse_quote, spanned::Spanned,
};

/// Stores tool annotation attributes
#[derive(Default, Clone)]
struct ToolAnnotationAttrs(pub serde_json::Map<String, serde_json::Value>);

impl Parse for ToolAnnotationAttrs {
fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
let mut attrs = serde_json::Map::new();

while !input.is_empty() {
let key: Ident = input.parse()?;
input.parse::<Token![:]>()?;
let value: Lit = input.parse()?;
let value = match value {
Lit::Str(s) => json!(s.value()),
Lit::Bool(b) => json!(b.value),
_ => {
return Err(syn::Error::new(
key.span(),
"annotations must be string or boolean literals",
));
}
};
attrs.insert(key.to_string(), value);
if input.is_empty() {
break;
}
input.parse::<Token![,]>()?;
}

Ok(ToolAnnotationAttrs(attrs))
}
}

#[derive(Default)]
struct ToolImplItemAttrs {
tool_box: Option<Option<Ident>>,
Expand Down Expand Up @@ -45,13 +79,16 @@ struct ToolFnItemAttrs {
name: Option<Expr>,
description: Option<Expr>,
vis: Option<Visibility>,
annotations: Option<ToolAnnotationAttrs>,
}

impl Parse for ToolFnItemAttrs {
fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
let mut name = None;
let mut description = None;
let mut vis = None;
let mut annotations = None;

while !input.is_empty() {
let key: Ident = input.parse()?;
input.parse::<Token![=]>()?;
Expand All @@ -68,6 +105,13 @@ impl Parse for ToolFnItemAttrs {
let value: Visibility = input.parse()?;
vis = Some(value);
}
"annotations" => {
// Parse the annotations as a nested structure
let content;
syn::braced!(content in input);
let value = content.parse()?;
annotations = Some(value);
}
_ => {
return Err(syn::Error::new(key.span(), "unknown attribute"));
}
Expand All @@ -82,6 +126,7 @@ impl Parse for ToolFnItemAttrs {
name,
description,
vis,
annotations,
})
}
}
Expand Down Expand Up @@ -470,14 +515,25 @@ pub(crate) fn tool_fn_item(attr: TokenStream, mut input_fn: ItemFn) -> syn::Resu
};
let input_fn_attrs = &input_fn.attrs;
let input_fn_vis = &input_fn.vis;

let annotations_code = if let Some(annotations) = &tool_macro_attrs.fn_item.annotations {
let annotations =
serde_json::to_string(&annotations.0).expect("failed to serialize annotations");
quote! {
Some(serde_json::from_str::<rmcp::model::ToolAnnotations>(&#annotations).expect("Could not parse tool annotations"))
}
} else {
quote! { None }
};

quote! {
#(#input_fn_attrs)*
#input_fn_vis fn #tool_attr_fn_ident() -> rmcp::model::Tool {
rmcp::model::Tool {
name: #name.into(),
description: Some(#description.into()),
input_schema: #schema.into(),
annotations: None
annotations: #annotations_code,
}
}
}
Expand Down
5 changes: 5 additions & 0 deletions crates/rmcp/src/model/tool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@ pub struct Tool {
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct ToolAnnotations {
/// A human-readable title for the tool.
#[serde(skip_serializing_if = "Option::is_none")]
pub title: Option<String>,

/// If true, the tool does not modify its environment.
///
/// Default: false
#[serde(skip_serializing_if = "Option::is_none")]
pub read_only_hint: Option<bool>,

/// If true, the tool may perform destructive updates to its environment.
Expand All @@ -51,6 +53,7 @@ pub struct ToolAnnotations {
///
/// Default: true
/// A human-readable description of the tool's purpose.
#[serde(skip_serializing_if = "Option::is_none")]
pub destructive_hint: Option<bool>,

/// If true, calling the tool repeatedly with the same arguments
Expand All @@ -59,6 +62,7 @@ pub struct ToolAnnotations {
/// (This property is meaningful only when `readOnlyHint == false`)
///
/// Default: false.
#[serde(skip_serializing_if = "Option::is_none")]
pub idempotent_hint: Option<bool>,

/// If true, this tool may interact with an "open world" of external
Expand All @@ -67,6 +71,7 @@ pub struct ToolAnnotations {
/// of a memory tool is not.
///
/// Default: true
#[serde(skip_serializing_if = "Option::is_none")]
pub open_world_hint: Option<bool>,
}

Expand Down
59 changes: 59 additions & 0 deletions crates/rmcp/tests/test_tool_macro_annotations.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#[cfg(test)]
mod tests {
use rmcp::{ServerHandler, tool};

#[derive(Debug, Clone, Default)]
pub struct AnnotatedServer {}

impl AnnotatedServer {
// Tool with inline comments for documentation
/// Direct annotation test tool
/// This is used to test tool annotations
#[tool(
name = "direct-annotated-tool",
annotations = {
title: "Annotated Tool",
readOnlyHint: true
}
)]
pub async fn direct_annotated_tool(&self, #[tool(param)] input: String) -> String {
format!("Direct: {}", input)
}
}

impl ServerHandler for AnnotatedServer {
async fn call_tool(
&self,
request: rmcp::model::CallToolRequestParam,
context: rmcp::service::RequestContext<rmcp::RoleServer>,
) -> Result<rmcp::model::CallToolResult, rmcp::Error> {
let tcc = rmcp::handler::server::tool::ToolCallContext::new(self, request, context);
match tcc.name() {
"direct-annotated-tool" => Self::direct_annotated_tool_tool_call(tcc).await,
_ => Err(rmcp::Error::invalid_params("method not found", None)),
}
}
}

#[test]
fn test_direct_tool_attributes() {
// Get the tool definition
let tool = AnnotatedServer::direct_annotated_tool_tool_attr();

// Verify basic properties
assert_eq!(tool.name, "direct-annotated-tool");

// Verify description is extracted from doc comments
assert!(tool.description.is_some());
assert!(
tool.description
.as_ref()
.unwrap()
.contains("Direct annotation test tool")
);

let annotations = tool.annotations.unwrap();
assert_eq!(annotations.title.as_ref().unwrap(), "Annotated Tool");
assert_eq!(annotations.read_only_hint, Some(true));
}
}
Loading