* feat: add output_schema field to Tool struct - Add optional output_schema field to Tool struct for defining tool output structure - Update Tool::new() to initialize output_schema as None * feat: add structured_content field to CallToolResult - Add optional structured_content field for JSON object results - Make content field optional to support either structured or unstructured results - Add CallToolResult::structured() and structured_error() constructor methods * feat: implement validation for mutually exclusive content/structuredContent - Add validate() method to ensure content and structured_content are mutually exclusive - Implement custom Deserialize to enforce validation during deserialization - Update documentation to clarify the mutual exclusivity requirement * feat: add output_schema support to #[tool] macro - Add output_schema field to ToolAttribute and ResolvedToolAttribute structs - Implement automatic output schema generation from return types - Support explicit output_schema attribute for manual specification - Generate schemas for Result<T, E> where T is not CallToolResult - Update tool generation to include output_schema in Tool struct * feat: implement IntoCallToolResult for structured content - Add Structured<T> wrapper type for explicit structured content - Implement IntoCallToolResult for Structured<T> with JSON serialization - Add support for Result<Structured<T>, E> conversions - Enable tools to return structured content through the trait system * fix: update simple-chat-client example for optional content field - Handle Option<Vec<Content>> in CallToolResult.content - Add proper unwrapping for the optional content field - Fix compilation error in chat.rs * fix: update examples and tests for optional content field - Add output_schema field to Tool initialization in sampling_stdio example - Update test_tool_macros tests to handle Option<Vec<Content>> - Use as_ref() before calling first() on optional content field * feat: implement basic schema validation in conversion logic - Add validate_against_schema function for basic type validation - Add note that full JSON Schema validation requires dedicated library - Document that actual validation should happen in tool handler * feat: add structured output support for tools - Add output_schema field to Tool struct for defining output JSON schemas - Add structured_content field to CallToolResult (mutually exclusive with content) - Implement Structured<T> wrapper for type-safe structured outputs - Update #[tool] macro to automatically generate output schemas from return types - Add validation of structured outputs against their schemas - Update all examples and tests for breaking change (CallToolResult.content now Option) - Add comprehensive documentation and rustdoc - Add structured_output example demonstrating the feature BREAKING CHANGE: CallToolResult.content is now Option<Vec<Content>> instead of Vec<Content> Closes #312 * fix: correct structured output doctest to use Parameters wrapper The #[tool] macro requires Parameters<T> wrapper for tool inputs. This fixes the pre-existing broken doctest in the structured output documentation example. * feat: replace Structured<T> with Json<T> for structured output - Remove Structured<T> type definition and implementations - Reuse existing Json<T> wrapper for structured content - Update IntoCallToolResult implementations to use Json<T> - Add JsonSchema implementation for Json<T> delegating to T - Update all examples and tests to use Json<T> instead of Structured<T> - Update documentation and exports BREAKING CHANGE: Structured<T> has been replaced with Json<T>. Users must update their code to use Json<T> for structured tool outputs. * feat: add output_schema() method to IntoCallToolResult trait - Add output_schema() method with default None implementation - Implement output_schema() for Json<T> to return cached schema - Implement output_schema() for Result<Json<T>, E> delegating to Json<T> - Enable trait-based schema generation for structured outputs * feat: update macro to detect Json<T> wrapper for output schemas - Add extract_json_inner_type() helper to detect Json<T> types - Update schema generation to only occur for Json<T> wrapped types - Remove generic Result<T, E> detection in favor of specific Json<T> detection - Add comprehensive tests to verify schema generation behavior * feat: add builder methods to Tool struct for setting schemas - Add with_output_schema<T>() method to set output schema from type - Add with_input_schema<T>() method to set input schema from type - Both methods use cached_schema_for_type internally - Add comprehensive tests for builder methods * fix: address clippy warnings - Add Default implementation for StructuredOutputServer - Fix collapsible else-if in simple-chat-client - No functional changes * style: apply cargo fmt Apply automatic formatting changes to: - examples/simple-chat-client/src/chat.rs - fix line wrapping - crates/rmcp-macros/src/tool.rs - format method chaining - examples/servers/src/structured_output.rs - reorder imports and format function signatures * chore: fix formatting * chore: fix rustdoc redundant link warning * refactor: validate_against_schema * feat: enforce structured_content usage when output_schema is defined This commit implements strict validation to ensure tools with output_schema consistently use structured_content for both success and error responses. Changes: - Enhanced ToolRouter::call() validation to require structured_content when output_schema is present - Added validation that tools with output_schema cannot use regular content field - Added comprehensive tests covering the new strict validation behavior - Created example demonstrating proper structured output usage - Updated TODO.md to track validation improvements This ensures consistent response format and better type safety for MCP clients. * chore: remove TODO.md * refactor: simplify output schema extraction logic in tool macro - Extract complex nested logic into dedicated helper function - Replace deeply nested if-else chains with functional approach - Use early returns and ? operator for cleaner code flow - Reduce 46 lines to 7 lines in main logic while improving readability * chore: run cargo fmt * fix: enforce structured_content usage when output_schema is defined Structured content is returned as a JSON object in the structuredContent field of a result.For backwards compatibility, a tool that returns structured content SHOULD also return the serialized JSON in a TextContent block. https://modelcontextprotocol.io/specification/2025-06-18/server/tools#structured-content Tools may also provide an output schema for validation of structured results. If an output schema is provided: - Servers MUST provide structured results that conform to this schema. - Clients SHOULD validate structured results against this schema. https://modelcontextprotocol.io/specification/2025-06-18/server/tools#output-schema * chore: cargo fmt
289 lines
7.5 KiB
Rust
289 lines
7.5 KiB
Rust
use std::{borrow::Cow, sync::Arc};
|
|
|
|
use futures::{FutureExt, future::BoxFuture};
|
|
use schemars::JsonSchema;
|
|
|
|
use crate::{
|
|
handler::server::tool::{
|
|
CallToolHandler, DynCallToolHandler, ToolCallContext, schema_for_type,
|
|
validate_against_schema,
|
|
},
|
|
model::{CallToolResult, Tool, ToolAnnotations},
|
|
};
|
|
|
|
pub struct ToolRoute<S> {
|
|
#[allow(clippy::type_complexity)]
|
|
pub call: Arc<DynCallToolHandler<S>>,
|
|
pub attr: crate::model::Tool,
|
|
}
|
|
|
|
impl<S> std::fmt::Debug for ToolRoute<S> {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
f.debug_struct("ToolRoute")
|
|
.field("name", &self.attr.name)
|
|
.field("description", &self.attr.description)
|
|
.field("input_schema", &self.attr.input_schema)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl<S> Clone for ToolRoute<S> {
|
|
fn clone(&self) -> Self {
|
|
Self {
|
|
call: self.call.clone(),
|
|
attr: self.attr.clone(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<S: Send + Sync + 'static> ToolRoute<S> {
|
|
pub fn new<C, A>(attr: impl Into<Tool>, call: C) -> Self
|
|
where
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
{
|
|
Self {
|
|
call: Arc::new(move |context: ToolCallContext<S>| {
|
|
let call = call.clone();
|
|
context.invoke(call).boxed()
|
|
}),
|
|
attr: attr.into(),
|
|
}
|
|
}
|
|
pub fn new_dyn<C>(attr: impl Into<Tool>, call: C) -> Self
|
|
where
|
|
C: for<'a> Fn(
|
|
ToolCallContext<'a, S>,
|
|
) -> BoxFuture<'a, Result<CallToolResult, crate::ErrorData>>
|
|
+ Send
|
|
+ Sync
|
|
+ 'static,
|
|
{
|
|
Self {
|
|
call: Arc::new(call),
|
|
attr: attr.into(),
|
|
}
|
|
}
|
|
pub fn name(&self) -> &str {
|
|
&self.attr.name
|
|
}
|
|
}
|
|
|
|
pub trait IntoToolRoute<S, A> {
|
|
fn into_tool_route(self) -> ToolRoute<S>;
|
|
}
|
|
|
|
impl<S, C, A, T> IntoToolRoute<S, A> for (T, C)
|
|
where
|
|
S: Send + Sync + 'static,
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
T: Into<Tool>,
|
|
{
|
|
fn into_tool_route(self) -> ToolRoute<S> {
|
|
ToolRoute::new(self.0.into(), self.1)
|
|
}
|
|
}
|
|
|
|
impl<S> IntoToolRoute<S, ()> for ToolRoute<S>
|
|
where
|
|
S: Send + Sync + 'static,
|
|
{
|
|
fn into_tool_route(self) -> ToolRoute<S> {
|
|
self
|
|
}
|
|
}
|
|
|
|
pub struct ToolAttrGenerateFunctionAdapter;
|
|
impl<S, F> IntoToolRoute<S, ToolAttrGenerateFunctionAdapter> for F
|
|
where
|
|
S: Send + Sync + 'static,
|
|
F: Fn() -> ToolRoute<S>,
|
|
{
|
|
fn into_tool_route(self) -> ToolRoute<S> {
|
|
(self)()
|
|
}
|
|
}
|
|
|
|
pub trait CallToolHandlerExt<S, A>: Sized
|
|
where
|
|
Self: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
{
|
|
fn name(self, name: impl Into<Cow<'static, str>>) -> WithToolAttr<Self, S, A>;
|
|
}
|
|
|
|
impl<C, S, A> CallToolHandlerExt<S, A> for C
|
|
where
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
{
|
|
fn name(self, name: impl Into<Cow<'static, str>>) -> WithToolAttr<Self, S, A> {
|
|
WithToolAttr {
|
|
attr: Tool::new(
|
|
name.into(),
|
|
"",
|
|
schema_for_type::<crate::model::JsonObject>(),
|
|
),
|
|
call: self,
|
|
_marker: std::marker::PhantomData,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub struct WithToolAttr<C, S, A>
|
|
where
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
{
|
|
pub attr: crate::model::Tool,
|
|
pub call: C,
|
|
pub _marker: std::marker::PhantomData<fn(S, A)>,
|
|
}
|
|
|
|
impl<C, S, A> IntoToolRoute<S, A> for WithToolAttr<C, S, A>
|
|
where
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
S: Send + Sync + 'static,
|
|
{
|
|
fn into_tool_route(self) -> ToolRoute<S> {
|
|
ToolRoute::new(self.attr, self.call)
|
|
}
|
|
}
|
|
|
|
impl<C, S, A> WithToolAttr<C, S, A>
|
|
where
|
|
C: CallToolHandler<S, A> + Send + Sync + Clone + 'static,
|
|
{
|
|
pub fn description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
|
|
self.attr.description = Some(description.into());
|
|
self
|
|
}
|
|
pub fn parameters<T: JsonSchema>(mut self) -> Self {
|
|
self.attr.input_schema = schema_for_type::<T>().into();
|
|
self
|
|
}
|
|
pub fn parameters_value(mut self, schema: serde_json::Value) -> Self {
|
|
self.attr.input_schema = crate::model::object(schema).into();
|
|
self
|
|
}
|
|
pub fn annotation(mut self, annotation: impl Into<ToolAnnotations>) -> Self {
|
|
self.attr.annotations = Some(annotation.into());
|
|
self
|
|
}
|
|
}
|
|
#[derive(Debug)]
|
|
pub struct ToolRouter<S> {
|
|
#[allow(clippy::type_complexity)]
|
|
pub map: std::collections::HashMap<Cow<'static, str>, ToolRoute<S>>,
|
|
|
|
pub transparent_when_not_found: bool,
|
|
}
|
|
|
|
impl<S> Default for ToolRouter<S> {
|
|
fn default() -> Self {
|
|
Self {
|
|
map: std::collections::HashMap::new(),
|
|
transparent_when_not_found: false,
|
|
}
|
|
}
|
|
}
|
|
impl<S> Clone for ToolRouter<S> {
|
|
fn clone(&self) -> Self {
|
|
Self {
|
|
map: self.map.clone(),
|
|
transparent_when_not_found: self.transparent_when_not_found,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<S> IntoIterator for ToolRouter<S> {
|
|
type Item = ToolRoute<S>;
|
|
type IntoIter = std::collections::hash_map::IntoValues<Cow<'static, str>, ToolRoute<S>>;
|
|
|
|
fn into_iter(self) -> Self::IntoIter {
|
|
self.map.into_values()
|
|
}
|
|
}
|
|
|
|
impl<S> ToolRouter<S>
|
|
where
|
|
S: Send + Sync + 'static,
|
|
{
|
|
pub fn new() -> Self {
|
|
Self {
|
|
map: std::collections::HashMap::new(),
|
|
transparent_when_not_found: false,
|
|
}
|
|
}
|
|
pub fn with_route<R, A>(mut self, route: R) -> Self
|
|
where
|
|
R: IntoToolRoute<S, A>,
|
|
{
|
|
self.add_route(route.into_tool_route());
|
|
self
|
|
}
|
|
|
|
pub fn add_route(&mut self, item: ToolRoute<S>) {
|
|
self.map.insert(item.attr.name.clone(), item);
|
|
}
|
|
|
|
pub fn merge(&mut self, other: ToolRouter<S>) {
|
|
for item in other.map.into_values() {
|
|
self.add_route(item);
|
|
}
|
|
}
|
|
|
|
pub fn remove_route<H, A>(&mut self, name: &str) {
|
|
self.map.remove(name);
|
|
}
|
|
pub fn has_route(&self, name: &str) -> bool {
|
|
self.map.contains_key(name)
|
|
}
|
|
pub async fn call(
|
|
&self,
|
|
context: ToolCallContext<'_, S>,
|
|
) -> Result<CallToolResult, crate::ErrorData> {
|
|
let item = self
|
|
.map
|
|
.get(context.name())
|
|
.ok_or_else(|| crate::ErrorData::invalid_params("tool not found", None))?;
|
|
|
|
let result = (item.call)(context).await?;
|
|
|
|
// Validate structured content against output schema if present
|
|
if let Some(ref output_schema) = item.attr.output_schema {
|
|
// When output_schema is defined, structured_content is required
|
|
if result.structured_content.is_none() {
|
|
return Err(crate::ErrorData::invalid_params(
|
|
"Tool with output_schema must return structured_content",
|
|
None,
|
|
));
|
|
}
|
|
// Validate the structured content against the schema
|
|
validate_against_schema(result.structured_content.as_ref().unwrap(), output_schema)?;
|
|
}
|
|
|
|
Ok(result)
|
|
}
|
|
|
|
pub fn list_all(&self) -> Vec<crate::model::Tool> {
|
|
self.map.values().map(|item| item.attr.clone()).collect()
|
|
}
|
|
}
|
|
|
|
impl<S> std::ops::Add<ToolRouter<S>> for ToolRouter<S>
|
|
where
|
|
S: Send + Sync + 'static,
|
|
{
|
|
type Output = Self;
|
|
|
|
fn add(mut self, other: ToolRouter<S>) -> Self::Output {
|
|
self.merge(other);
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<S> std::ops::AddAssign<ToolRouter<S>> for ToolRouter<S>
|
|
where
|
|
S: Send + Sync + 'static,
|
|
{
|
|
fn add_assign(&mut self, other: ToolRouter<S>) {
|
|
self.merge(other);
|
|
}
|
|
}
|