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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -169,6 +169,8 @@ async fn main() -> anyhow::Result<()> {
}
```

The generated tool `inputSchema` is derived from the fields of `T`. The type name and documentation on `T` are ignored; only field names, field types, and field documentation are used.

When you need custom server metadata or multiple capabilities (tools + prompts), use explicit `#[tool_handler]`:

```rust,ignore
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp-macros/src/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,7 +231,7 @@ pub fn tool(attr: TokenStream, input: TokenStream) -> syn::Result<TokenStream> {
if let Some(params_ty) = params_ty {
// if found, use the Parameters schema
syn::parse2::<Expr>(quote! {
rmcp::handler::server::common::schema_for_type::<#params_ty>()
rmcp::handler::server::common::schema_for_input::<#params_ty>()
})?
} else {
// if not found, use a default empty JSON schema object
Expand Down
30 changes: 30 additions & 0 deletions crates/rmcp/src/handler/server/common.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,36 @@ pub fn schema_for_type<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
})
}

/// Generate a JSON schema for inputSchema (does not need "title" or "description" fields for the top-level object)
pub fn schema_for_input<T: JsonSchema + std::any::Any>() -> Arc<JsonObject> {
thread_local! {
static CACHE_FOR_INPUT: std::sync::RwLock<HashMap<TypeId, Arc<JsonObject>>> = Default::default();
};
CACHE_FOR_INPUT.with(|cache| {
if let Some(schema) = cache
.read()
.expect("input schema cache lock poisoned")
.get(&TypeId::of::<T>())
{
schema.clone()
} else {
let mut schema = schema_for_type::<T>().as_ref().clone();

// Remove unnecessary top-level fields
schema.remove("title");
schema.remove("description");

let schema = Arc::new(schema);
cache
.write()
.expect("input schema cache lock poisoned")
.insert(TypeId::of::<T>(), schema.clone());

schema
}
})
}

// TODO: should be updated according to the new specifications
/// Schema used when input is empty.
pub fn schema_for_empty_input() -> Arc<JsonObject> {
Expand Down
7 changes: 4 additions & 3 deletions crates/rmcp/src/handler/server/router/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ pub use tool_traits::{AsyncTool, SyncTool, ToolBase};

use crate::{
handler::server::{
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type},
common::schema_for_input,
tool::{CallToolHandler, DynCallToolHandler, ToolCallContext},
tool_name_validation::validate_and_warn_tool_name,
},
model::{CallToolResult, Tool, ToolAnnotations},
Expand DownExpand Up@@ -249,7 +250,7 @@ where
attr: Tool::new(
name.into(),
"",
schema_for_type::<crate::model::JsonObject>(),
schema_for_input::<crate::model::JsonObject>(),
),
call: self,
_marker: std::marker::PhantomData,
Expand DownExpand Up@@ -286,7 +287,7 @@ where
self
}
pub fn parameters<T: JsonSchema + 'static>(mut self) -> Self {
self.attr.input_schema = schema_for_type::<T>();
self.attr.input_schema = schema_for_input::<T>();
self
}
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
Expand Down
6 changes: 3 additions & 3 deletions crates/rmcp/src/handler/server/router/tool/tool_traits.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,8 @@ use serde::{Deserialize, Serialize};
use crate::{
ErrorData,
handler::server::{
common::schema_for_empty_input,
tool::{schema_for_output, schema_for_type},
common::{schema_for_empty_input, schema_for_input},
tool::schema_for_output,
wrapper::{Json, Parameters},
},
model::{Icon, JsonObject, Meta, ToolAnnotations, ToolExecution},
Expand DownExpand Up@@ -49,7 +49,7 @@ pub trait ToolBase {
/// If the tool does not have any parameters, you should override this methods to return [`None`],
/// and when invoked, the parameter will get default values.
fn input_schema() -> Option<Arc<JsonObject>> {
Some(schema_for_type::<Parameters<Self::Parameter>>())
Some(schema_for_input::<Parameters<Self::Parameter>>())
}

/// Json schema for tool output.
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/handler/server/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ use serde::de::DeserializeOwned;

use super::common::{AsRequestContext, FromContextPart};
pub use super::{
common::{Extension, RequestId, schema_for_output, schema_for_type},
common::{Extension, RequestId, schema_for_input, schema_for_output, schema_for_type},
router::tool::{ToolRoute, ToolRouter},
};
use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/rmcp/src/model/tool.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -330,7 +330,7 @@ impl Tool {
/// Set the input schema using a type that implements JsonSchema
#[cfg(feature = "server")]
pub fn with_input_schema<T: JsonSchema + 'static>(mut self) -> Self {
self.input_schema = crate::handler::server::tool::schema_for_type::<T>();
self.input_schema = crate::handler::server::tool::schema_for_input::<T>();
self
}

Expand Down
1 change: 0 additions & 1 deletion crates/rmcp/tests/test_complex_schema.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,7 +91,6 @@ fn expected_schema() -> serde_json::Value {
"required": [
"messages"
],
"title": "ChatRequest",
"type": "object"
})
}
Expand Down
40 changes: 40 additions & 0 deletions crates/rmcp/tests/test_list_tools_result.rs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
#![cfg(all(feature = "server", feature = "macros", not(feature = "local")))]

use rmcp::{
handler::server::wrapper::Parameters,
model::{ListToolsResult, NumberOrString, ServerJsonRpcMessage, ServerResult},
};

/// Parameters for adding two numbers.
#[derive(Debug, serde::Deserialize, schemars::JsonSchema)]
struct AddRequest {
/// The left-hand number.
a: f64,
/// The right-hand number.
b: f64,
}

/// Add two numbers.
#[rmcp::tool]
fn add(Parameters(AddRequest { a, b }): Parameters<AddRequest>) -> String {
(a + b).to_string()
}

#[test]
fn list_tools_result_matches_expected_json() {
let expected_json = std::fs::read("tests/test_list_tools_result/list_tools_result.json")
.expect("missing expected list tools result JSON fixture");
let expected: serde_json::Value =
serde_json::from_slice(&expected_json).expect("invalid expected JSON fixture");

assert_eq!(add(Parameters(AddRequest { a: 1.0, b: 2.0 })), "3");

let result = ListToolsResult::with_all_items(vec![add_tool_attr()]);
let response = ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(result),
NumberOrString::Number(2),
);

let actual = serde_json::to_value(response).expect("failed to serialize list tools response");
assert_eq!(actual, expected);
}
32 changes: 32 additions & 0 deletions crates/rmcp/tests/test_list_tools_result/list_tools_result.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
{
"result": {
"tools": [
{
"name": "add",
"description": "Add two numbers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"a": {
"description": "The left-hand number.",
"format": "double",
"type": "number"
},
"b": {
"description": "The right-hand number.",
"format": "double",
"type": "number"
}
},
"required": [
"a",
"b"
]
}
}
]
},
"jsonrpc": "2.0",
"id": 2
}