Implement SEP-1319: Decouple Request Payload from RPC Methods (#617)
* feat: implement SEP-1319 Decouple Request Payload from RPC Methods * test: update tests * fix: update handler trait methods to use new types * fix: update examples * fix: correct deprecation version * fix: update wrapper macros to use new *Params type names
This commit is contained in:
Dale Seo
GitHub
parent
48e989b711
commit
9e881a645b
8 changed files with 913 additions and 278 deletions
|
|
@ -85,7 +85,7 @@ pub trait ClientHandler: Sized + Send + Sync + 'static {
|
|||
|
||||
fn create_message(
|
||||
&self,
|
||||
params: CreateMessageRequestParam,
|
||||
params: CreateMessageRequestParams,
|
||||
context: RequestContext<RoleClient>,
|
||||
) -> impl Future<Output = Result<CreateMessageResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(
|
||||
|
|
@ -118,7 +118,7 @@ pub trait ClientHandler: Sized + Send + Sync + 'static {
|
|||
/// Real clients should override this to provide user interaction.
|
||||
fn create_elicitation(
|
||||
&self,
|
||||
request: CreateElicitationRequestParam,
|
||||
request: CreateElicitationRequestParams,
|
||||
context: RequestContext<RoleClient>,
|
||||
) -> impl Future<Output = Result<CreateElicitationResult, McpError>> + Send + '_ {
|
||||
// Default implementation declines all requests - real clients should override this
|
||||
|
|
@ -225,7 +225,7 @@ macro_rules! impl_client_handler_for_wrapper {
|
|||
|
||||
fn create_message(
|
||||
&self,
|
||||
params: CreateMessageRequestParam,
|
||||
params: CreateMessageRequestParams,
|
||||
context: RequestContext<RoleClient>,
|
||||
) -> impl Future<Output = Result<CreateMessageResult, McpError>> + Send + '_ {
|
||||
(**self).create_message(params, context)
|
||||
|
|
@ -240,7 +240,7 @@ macro_rules! impl_client_handler_for_wrapper {
|
|||
|
||||
fn create_elicitation(
|
||||
&self,
|
||||
request: CreateElicitationRequestParam,
|
||||
request: CreateElicitationRequestParams,
|
||||
context: RequestContext<RoleClient>,
|
||||
) -> impl Future<Output = Result<CreateElicitationResult, McpError>> + Send + '_ {
|
||||
(**self).create_elicitation(request, context)
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@ impl<H: ServerHandler> Service<RoleServer> for H {
|
|||
pub trait ServerHandler: Sized + Send + Sync + 'static {
|
||||
fn enqueue_task(
|
||||
&self,
|
||||
_request: CallToolRequestParam,
|
||||
_request: CallToolRequestParams,
|
||||
_context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CreateTaskResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::internal_error(
|
||||
|
|
@ -154,7 +154,7 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
// handle requests
|
||||
fn initialize(
|
||||
&self,
|
||||
request: InitializeRequestParam,
|
||||
request: InitializeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<InitializeResult, McpError>> + Send + '_ {
|
||||
if context.peer.peer_info().is_none() {
|
||||
|
|
@ -164,49 +164,49 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
}
|
||||
fn complete(
|
||||
&self,
|
||||
request: CompleteRequestParam,
|
||||
request: CompleteRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CompleteResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Ok(CompleteResult::default()))
|
||||
}
|
||||
fn set_level(
|
||||
&self,
|
||||
request: SetLevelRequestParam,
|
||||
request: SetLevelRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<SetLevelRequestMethod>()))
|
||||
}
|
||||
fn get_prompt(
|
||||
&self,
|
||||
request: GetPromptRequestParam,
|
||||
request: GetPromptRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<GetPromptResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<GetPromptRequestMethod>()))
|
||||
}
|
||||
fn list_prompts(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListPromptsResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Ok(ListPromptsResult::default()))
|
||||
}
|
||||
fn list_resources(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListResourcesResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Ok(ListResourcesResult::default()))
|
||||
}
|
||||
fn list_resource_templates(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListResourceTemplatesResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Ok(ListResourceTemplatesResult::default()))
|
||||
}
|
||||
fn read_resource(
|
||||
&self,
|
||||
request: ReadResourceRequestParam,
|
||||
request: ReadResourceRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ReadResourceResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(
|
||||
|
|
@ -215,28 +215,28 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
}
|
||||
fn subscribe(
|
||||
&self,
|
||||
request: SubscribeRequestParam,
|
||||
request: SubscribeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<SubscribeRequestMethod>()))
|
||||
}
|
||||
fn unsubscribe(
|
||||
&self,
|
||||
request: UnsubscribeRequestParam,
|
||||
request: UnsubscribeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<UnsubscribeRequestMethod>()))
|
||||
}
|
||||
fn call_tool(
|
||||
&self,
|
||||
request: CallToolRequestParam,
|
||||
request: CallToolRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CallToolResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<CallToolRequestMethod>()))
|
||||
}
|
||||
fn list_tools(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListToolsResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Ok(ListToolsResult::default()))
|
||||
|
|
@ -297,7 +297,7 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
|
||||
fn list_tasks(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListTasksResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<ListTasksMethod>()))
|
||||
|
|
@ -305,7 +305,7 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
|
||||
fn get_task_info(
|
||||
&self,
|
||||
request: GetTaskInfoParam,
|
||||
request: GetTaskInfoParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<GetTaskInfoResult, McpError>> + Send + '_ {
|
||||
std::future::ready(Err(McpError::method_not_found::<GetTaskInfoMethod>()))
|
||||
|
|
@ -313,7 +313,7 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
|
||||
fn get_task_result(
|
||||
&self,
|
||||
request: GetTaskResultParam,
|
||||
request: GetTaskResultParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<TaskResult, McpError>> + Send + '_ {
|
||||
let _ = (request, context);
|
||||
|
|
@ -322,7 +322,7 @@ pub trait ServerHandler: Sized + Send + Sync + 'static {
|
|||
|
||||
fn cancel_task(
|
||||
&self,
|
||||
request: CancelTaskParam,
|
||||
request: CancelTaskParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
let _ = (request, context);
|
||||
|
|
@ -335,7 +335,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
impl<T: ServerHandler> ServerHandler for $wrapper<T> {
|
||||
fn enqueue_task(
|
||||
&self,
|
||||
request: CallToolRequestParam,
|
||||
request: CallToolRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CreateTaskResult, McpError>> + Send + '_ {
|
||||
(**self).enqueue_task(request, context)
|
||||
|
|
@ -350,7 +350,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn initialize(
|
||||
&self,
|
||||
request: InitializeRequestParam,
|
||||
request: InitializeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<InitializeResult, McpError>> + Send + '_ {
|
||||
(**self).initialize(request, context)
|
||||
|
|
@ -358,7 +358,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn complete(
|
||||
&self,
|
||||
request: CompleteRequestParam,
|
||||
request: CompleteRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CompleteResult, McpError>> + Send + '_ {
|
||||
(**self).complete(request, context)
|
||||
|
|
@ -366,7 +366,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn set_level(
|
||||
&self,
|
||||
request: SetLevelRequestParam,
|
||||
request: SetLevelRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
(**self).set_level(request, context)
|
||||
|
|
@ -374,7 +374,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn get_prompt(
|
||||
&self,
|
||||
request: GetPromptRequestParam,
|
||||
request: GetPromptRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<GetPromptResult, McpError>> + Send + '_ {
|
||||
(**self).get_prompt(request, context)
|
||||
|
|
@ -382,7 +382,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn list_prompts(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListPromptsResult, McpError>> + Send + '_ {
|
||||
(**self).list_prompts(request, context)
|
||||
|
|
@ -390,7 +390,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn list_resources(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListResourcesResult, McpError>> + Send + '_ {
|
||||
(**self).list_resources(request, context)
|
||||
|
|
@ -398,7 +398,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn list_resource_templates(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListResourceTemplatesResult, McpError>> + Send + '_
|
||||
{
|
||||
|
|
@ -407,7 +407,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn read_resource(
|
||||
&self,
|
||||
request: ReadResourceRequestParam,
|
||||
request: ReadResourceRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ReadResourceResult, McpError>> + Send + '_ {
|
||||
(**self).read_resource(request, context)
|
||||
|
|
@ -415,7 +415,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn subscribe(
|
||||
&self,
|
||||
request: SubscribeRequestParam,
|
||||
request: SubscribeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
(**self).subscribe(request, context)
|
||||
|
|
@ -423,7 +423,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn unsubscribe(
|
||||
&self,
|
||||
request: UnsubscribeRequestParam,
|
||||
request: UnsubscribeRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
(**self).unsubscribe(request, context)
|
||||
|
|
@ -431,7 +431,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn call_tool(
|
||||
&self,
|
||||
request: CallToolRequestParam,
|
||||
request: CallToolRequestParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<CallToolResult, McpError>> + Send + '_ {
|
||||
(**self).call_tool(request, context)
|
||||
|
|
@ -439,7 +439,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn list_tools(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListToolsResult, McpError>> + Send + '_ {
|
||||
(**self).list_tools(request, context)
|
||||
|
|
@ -497,7 +497,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn list_tasks(
|
||||
&self,
|
||||
request: Option<PaginatedRequestParam>,
|
||||
request: Option<PaginatedRequestParams>,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<ListTasksResult, McpError>> + Send + '_ {
|
||||
(**self).list_tasks(request, context)
|
||||
|
|
@ -505,7 +505,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn get_task_info(
|
||||
&self,
|
||||
request: GetTaskInfoParam,
|
||||
request: GetTaskInfoParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<GetTaskInfoResult, McpError>> + Send + '_ {
|
||||
(**self).get_task_info(request, context)
|
||||
|
|
@ -513,7 +513,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn get_task_result(
|
||||
&self,
|
||||
request: GetTaskResultParam,
|
||||
request: GetTaskResultParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<TaskResult, McpError>> + Send + '_ {
|
||||
(**self).get_task_result(request, context)
|
||||
|
|
@ -521,7 +521,7 @@ macro_rules! impl_server_handler_for_wrapper {
|
|||
|
||||
fn cancel_task(
|
||||
&self,
|
||||
request: CancelTaskParam,
|
||||
request: CancelTaskParams,
|
||||
context: RequestContext<RoleServer>,
|
||||
) -> impl Future<Output = Result<(), McpError>> + Send + '_ {
|
||||
(**self).cancel_task(request, context)
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ pub use super::{
|
|||
use crate::{
|
||||
RoleServer,
|
||||
handler::server::wrapper::Parameters,
|
||||
model::{CallToolRequestParam, CallToolResult, IntoContents, JsonObject},
|
||||
model::{CallToolRequestParams, CallToolResult, IntoContents, JsonObject},
|
||||
service::RequestContext,
|
||||
};
|
||||
|
||||
|
|
@ -39,11 +39,12 @@ pub struct ToolCallContext<'s, S> {
|
|||
impl<'s, S> ToolCallContext<'s, S> {
|
||||
pub fn new(
|
||||
service: &'s S,
|
||||
CallToolRequestParam {
|
||||
CallToolRequestParams {
|
||||
meta: _,
|
||||
name,
|
||||
arguments,
|
||||
task,
|
||||
}: CallToolRequestParam,
|
||||
}: CallToolRequestParams,
|
||||
request_context: RequestContext<RoleServer>,
|
||||
) -> Self {
|
||||
Self {
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@
|
|||
//!
|
||||
//! ```rust
|
||||
//! use anyhow::Result;
|
||||
//! use rmcp::{model::CallToolRequestParam, service::ServiceExt};
|
||||
//! use rmcp::{model::CallToolRequestParams, service::ServiceExt};
|
||||
//! #[cfg(feature = "transport-child-process")]
|
||||
//! #[cfg_attr(docsrs, doc(cfg(feature = "transport-child-process")))]
|
||||
//! use rmcp::transport::{TokioChildProcess, ConfigureCommandExt};
|
||||
|
|
@ -127,7 +127,8 @@
|
|||
//!
|
||||
//! // Call tool 'git_status' with arguments = {"repo_path": "."}
|
||||
//! let tool_result = service
|
||||
//! .call_tool(CallToolRequestParam {
|
||||
//! .call_tool(CallToolRequestParams {
|
||||
//! meta: None,
|
||||
//! name: "git_status".into(),
|
||||
//! arguments: serde_json::json!({ "repo_path": "." }).as_object().cloned(),
|
||||
//! task: None,
|
||||
|
|
|
|||
|
|
@ -718,7 +718,7 @@ impl CustomRequest {
|
|||
const_string!(InitializeResultMethod = "initialize");
|
||||
/// # Initialization
|
||||
/// This request is sent from the client to the server when it first connects, asking it to begin initialization.
|
||||
pub type InitializeRequest = Request<InitializeResultMethod, InitializeRequestParam>;
|
||||
pub type InitializeRequest = Request<InitializeResultMethod, InitializeRequestParams>;
|
||||
|
||||
const_string!(InitializedNotificationMethod = "notifications/initialized");
|
||||
/// This notification is sent from the client to the server after initialization has finished.
|
||||
|
|
@ -731,7 +731,10 @@ pub type InitializedNotification = NotificationNoParam<InitializedNotificationMe
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct InitializeRequestParam {
|
||||
pub struct InitializeRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The MCP protocol version this client supports
|
||||
pub protocol_version: ProtocolVersion,
|
||||
/// The capabilities this client supports (sampling, roots, etc.)
|
||||
|
|
@ -740,6 +743,19 @@ pub struct InitializeRequestParam {
|
|||
pub client_info: Implementation,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for InitializeRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`InitializeRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use InitializeRequestParams instead")]
|
||||
pub type InitializeRequestParam = InitializeRequestParams;
|
||||
|
||||
/// The server's response to an initialization request.
|
||||
///
|
||||
/// Contains the server's protocol version, capabilities, and implementation
|
||||
|
|
@ -760,7 +776,7 @@ pub struct InitializeResult {
|
|||
}
|
||||
|
||||
pub type ServerInfo = InitializeResult;
|
||||
pub type ClientInfo = InitializeRequestParam;
|
||||
pub type ClientInfo = InitializeRequestParams;
|
||||
|
||||
#[allow(clippy::derivable_impls)]
|
||||
impl Default for ServerInfo {
|
||||
|
|
@ -778,6 +794,7 @@ impl Default for ServerInfo {
|
|||
impl Default for ClientInfo {
|
||||
fn default() -> Self {
|
||||
ClientInfo {
|
||||
meta: None,
|
||||
protocol_version: ProtocolVersion::default(),
|
||||
capabilities: ClientCapabilities::default(),
|
||||
client_info: Implementation::from_build_env(),
|
||||
|
|
@ -843,10 +860,26 @@ impl Implementation {
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct PaginatedRequestParam {
|
||||
pub struct PaginatedRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub cursor: Option<String>,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for PaginatedRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`PaginatedRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use PaginatedRequestParams instead")]
|
||||
pub type PaginatedRequestParam = PaginatedRequestParams;
|
||||
// =============================================================================
|
||||
// PROGRESS AND PAGINATION
|
||||
// =============================================================================
|
||||
|
|
@ -910,7 +943,7 @@ macro_rules! paginated_result {
|
|||
const_string!(ListResourcesRequestMethod = "resources/list");
|
||||
/// Request to list all available resources from a server
|
||||
pub type ListResourcesRequest =
|
||||
RequestOptionalParam<ListResourcesRequestMethod, PaginatedRequestParam>;
|
||||
RequestOptionalParam<ListResourcesRequestMethod, PaginatedRequestParams>;
|
||||
|
||||
paginated_result!(ListResourcesResult {
|
||||
resources: Vec<Resource>
|
||||
|
|
@ -919,7 +952,7 @@ paginated_result!(ListResourcesResult {
|
|||
const_string!(ListResourceTemplatesRequestMethod = "resources/templates/list");
|
||||
/// Request to list all available resource templates from a server
|
||||
pub type ListResourceTemplatesRequest =
|
||||
RequestOptionalParam<ListResourceTemplatesRequestMethod, PaginatedRequestParam>;
|
||||
RequestOptionalParam<ListResourceTemplatesRequestMethod, PaginatedRequestParams>;
|
||||
|
||||
paginated_result!(ListResourceTemplatesResult {
|
||||
resource_templates: Vec<ResourceTemplate>
|
||||
|
|
@ -930,11 +963,27 @@ const_string!(ReadResourceRequestMethod = "resources/read");
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct ReadResourceRequestParam {
|
||||
pub struct ReadResourceRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The URI of the resource to read
|
||||
pub uri: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for ReadResourceRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`ReadResourceRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use ReadResourceRequestParams instead")]
|
||||
pub type ReadResourceRequestParam = ReadResourceRequestParams;
|
||||
|
||||
/// Result containing the contents of a read resource
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
|
|
@ -944,7 +993,7 @@ pub struct ReadResourceResult {
|
|||
}
|
||||
|
||||
/// Request to read a specific resource
|
||||
pub type ReadResourceRequest = Request<ReadResourceRequestMethod, ReadResourceRequestParam>;
|
||||
pub type ReadResourceRequest = Request<ReadResourceRequestMethod, ReadResourceRequestParams>;
|
||||
|
||||
const_string!(ResourceListChangedNotificationMethod = "notifications/resources/list_changed");
|
||||
/// Notification sent when the list of available resources changes
|
||||
|
|
@ -956,24 +1005,58 @@ const_string!(SubscribeRequestMethod = "resources/subscribe");
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct SubscribeRequestParam {
|
||||
pub struct SubscribeRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The URI of the resource to subscribe to
|
||||
pub uri: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for SubscribeRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`SubscribeRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use SubscribeRequestParams instead")]
|
||||
pub type SubscribeRequestParam = SubscribeRequestParams;
|
||||
|
||||
/// Request to subscribe to resource updates
|
||||
pub type SubscribeRequest = Request<SubscribeRequestMethod, SubscribeRequestParam>;
|
||||
pub type SubscribeRequest = Request<SubscribeRequestMethod, SubscribeRequestParams>;
|
||||
|
||||
const_string!(UnsubscribeRequestMethod = "resources/unsubscribe");
|
||||
/// Parameters for unsubscribing from resource updates
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct UnsubscribeRequestParam {
|
||||
pub struct UnsubscribeRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The URI of the resource to unsubscribe from
|
||||
pub uri: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for UnsubscribeRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`UnsubscribeRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use UnsubscribeRequestParams instead")]
|
||||
pub type UnsubscribeRequestParam = UnsubscribeRequestParams;
|
||||
|
||||
/// Request to unsubscribe from resource updates
|
||||
pub type UnsubscribeRequest = Request<UnsubscribeRequestMethod, UnsubscribeRequestParam>;
|
||||
pub type UnsubscribeRequest = Request<UnsubscribeRequestMethod, UnsubscribeRequestParams>;
|
||||
|
||||
const_string!(ResourceUpdatedNotificationMethod = "notifications/resources/updated");
|
||||
/// Parameters for a resource update notification
|
||||
|
|
@ -994,7 +1077,8 @@ pub type ResourceUpdatedNotification =
|
|||
|
||||
const_string!(ListPromptsRequestMethod = "prompts/list");
|
||||
/// Request to list all available prompts from a server
|
||||
pub type ListPromptsRequest = RequestOptionalParam<ListPromptsRequestMethod, PaginatedRequestParam>;
|
||||
pub type ListPromptsRequest =
|
||||
RequestOptionalParam<ListPromptsRequestMethod, PaginatedRequestParams>;
|
||||
|
||||
paginated_result!(ListPromptsResult {
|
||||
prompts: Vec<Prompt>
|
||||
|
|
@ -1005,13 +1089,30 @@ const_string!(GetPromptRequestMethod = "prompts/get");
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct GetPromptRequestParam {
|
||||
pub struct GetPromptRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
pub name: String,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub arguments: Option<JsonObject>,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for GetPromptRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`GetPromptRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use GetPromptRequestParams instead")]
|
||||
pub type GetPromptRequestParam = GetPromptRequestParams;
|
||||
|
||||
/// Request to get a specific prompt
|
||||
pub type GetPromptRequest = Request<GetPromptRequestMethod, GetPromptRequestParam>;
|
||||
pub type GetPromptRequest = Request<GetPromptRequestMethod, GetPromptRequestParams>;
|
||||
|
||||
const_string!(PromptListChangedNotificationMethod = "notifications/prompts/list_changed");
|
||||
/// Notification sent when the list of available prompts changes
|
||||
|
|
@ -1045,12 +1146,29 @@ const_string!(SetLevelRequestMethod = "logging/setLevel");
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct SetLevelRequestParam {
|
||||
pub struct SetLevelRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The desired logging level
|
||||
pub level: LoggingLevel,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for SetLevelRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`SetLevelRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use SetLevelRequestParams instead")]
|
||||
pub type SetLevelRequestParam = SetLevelRequestParams;
|
||||
|
||||
/// Request to set the logging level
|
||||
pub type SetLevelRequest = Request<SetLevelRequestMethod, SetLevelRequestParam>;
|
||||
pub type SetLevelRequest = Request<SetLevelRequestMethod, SetLevelRequestParams>;
|
||||
|
||||
const_string!(LoggingMessageNotificationMethod = "notifications/message");
|
||||
/// Parameters for a logging message notification
|
||||
|
|
@ -1075,7 +1193,7 @@ pub type LoggingMessageNotification =
|
|||
// =============================================================================
|
||||
|
||||
const_string!(CreateMessageRequestMethod = "sampling/createMessage");
|
||||
pub type CreateMessageRequest = Request<CreateMessageRequestMethod, CreateMessageRequestParam>;
|
||||
pub type CreateMessageRequest = Request<CreateMessageRequestMethod, CreateMessageRequestParams>;
|
||||
|
||||
/// Represents the role of a participant in a conversation or message exchange.
|
||||
///
|
||||
|
|
@ -1128,10 +1246,19 @@ pub enum ContextInclusion {
|
|||
/// This structure contains all the necessary information for a client to
|
||||
/// generate an LLM response, including conversation history, model preferences,
|
||||
/// and generation parameters.
|
||||
///
|
||||
/// This implements `TaskAugmentedRequestParamsMeta` as sampling requests can be
|
||||
/// long-running and may benefit from task-based execution.
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct CreateMessageRequestParam {
|
||||
pub struct CreateMessageRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// Task metadata for async task management (SEP-1319)
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub task: Option<JsonObject>,
|
||||
/// The conversation history and current messages
|
||||
pub messages: Vec<SamplingMessage>,
|
||||
/// Preferences for model selection and behavior
|
||||
|
|
@ -1156,6 +1283,28 @@ pub struct CreateMessageRequestParam {
|
|||
pub metadata: Option<Value>,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for CreateMessageRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
impl TaskAugmentedRequestParamsMeta for CreateMessageRequestParams {
|
||||
fn task(&self) -> Option<&JsonObject> {
|
||||
self.task.as_ref()
|
||||
}
|
||||
fn task_mut(&mut self) -> &mut Option<JsonObject> {
|
||||
&mut self.task
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`CreateMessageRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use CreateMessageRequestParams instead")]
|
||||
pub type CreateMessageRequestParam = CreateMessageRequestParams;
|
||||
|
||||
/// Preferences for model selection and behavior in sampling requests.
|
||||
///
|
||||
/// This allows servers to express their preferences for which model to use
|
||||
|
|
@ -1244,7 +1393,10 @@ impl CompletionContext {
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct CompleteRequestParam {
|
||||
pub struct CompleteRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
pub r#ref: Reference,
|
||||
pub argument: ArgumentInfo,
|
||||
/// Optional context containing previously resolved argument values
|
||||
|
|
@ -1252,7 +1404,20 @@ pub struct CompleteRequestParam {
|
|||
pub context: Option<CompletionContext>,
|
||||
}
|
||||
|
||||
pub type CompleteRequest = Request<CompleteRequestMethod, CompleteRequestParam>;
|
||||
impl RequestParamsMeta for CompleteRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`CompleteRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use CompleteRequestParams instead")]
|
||||
pub type CompleteRequestParam = CompleteRequestParams;
|
||||
|
||||
pub type CompleteRequest = Request<CompleteRequestMethod, CompleteRequestParams>;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
|
|
@ -1477,7 +1642,8 @@ pub enum ElicitationAction {
|
|||
/// ```rust
|
||||
/// use rmcp::model::*;
|
||||
///
|
||||
/// let params = CreateElicitationRequestParam {
|
||||
/// let params = CreateElicitationRequestParams {
|
||||
/// meta: None,
|
||||
/// message: "Please provide your email".to_string(),
|
||||
/// requested_schema: ElicitationSchema::builder()
|
||||
/// .required_email("email")
|
||||
|
|
@ -1488,7 +1654,11 @@ pub enum ElicitationAction {
|
|||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct CreateElicitationRequestParam {
|
||||
pub struct CreateElicitationRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
|
||||
/// Human-readable message explaining what input is needed from the user.
|
||||
/// This should be clear and provide sufficient context for the user to understand
|
||||
/// what information they need to provide.
|
||||
|
|
@ -1500,6 +1670,19 @@ pub struct CreateElicitationRequestParam {
|
|||
pub requested_schema: ElicitationSchema,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for CreateElicitationRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`CreateElicitationRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use CreateElicitationRequestParams instead")]
|
||||
pub type CreateElicitationRequestParam = CreateElicitationRequestParams;
|
||||
|
||||
/// The result returned by a client in response to an elicitation request.
|
||||
///
|
||||
/// Contains the user's decision (accept/decline/cancel) and optionally their input data
|
||||
|
|
@ -1520,7 +1703,7 @@ pub struct CreateElicitationResult {
|
|||
|
||||
/// Request type for creating an elicitation to gather user input
|
||||
pub type CreateElicitationRequest =
|
||||
Request<ElicitationCreateRequestMethod, CreateElicitationRequestParam>;
|
||||
Request<ElicitationCreateRequestMethod, CreateElicitationRequestParams>;
|
||||
|
||||
// =============================================================================
|
||||
// TOOL EXECUTION RESULTS
|
||||
|
|
@ -1685,7 +1868,7 @@ impl<'de> Deserialize<'de> for CallToolResult {
|
|||
|
||||
const_string!(ListToolsRequestMethod = "tools/list");
|
||||
/// Request to list all available tools from a server
|
||||
pub type ListToolsRequest = RequestOptionalParam<ListToolsRequestMethod, PaginatedRequestParam>;
|
||||
pub type ListToolsRequest = RequestOptionalParam<ListToolsRequestMethod, PaginatedRequestParams>;
|
||||
|
||||
paginated_result!(
|
||||
ListToolsResult {
|
||||
|
|
@ -1698,21 +1881,50 @@ const_string!(CallToolRequestMethod = "tools/call");
|
|||
///
|
||||
/// Contains the tool name and optional arguments needed to execute
|
||||
/// the tool operation.
|
||||
///
|
||||
/// This implements `TaskAugmentedRequestParamsMeta` as tool calls can be
|
||||
/// long-running and may benefit from task-based execution.
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct CallToolRequestParam {
|
||||
pub struct CallToolRequestParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
/// The name of the tool to call
|
||||
pub name: Cow<'static, str>,
|
||||
/// Arguments to pass to the tool (must match the tool's input schema)
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub arguments: Option<JsonObject>,
|
||||
/// Task metadata for async task management (SEP-1319)
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub task: Option<JsonObject>,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for CallToolRequestParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
impl TaskAugmentedRequestParamsMeta for CallToolRequestParams {
|
||||
fn task(&self) -> Option<&JsonObject> {
|
||||
self.task.as_ref()
|
||||
}
|
||||
fn task_mut(&mut self) -> &mut Option<JsonObject> {
|
||||
&mut self.task
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`CallToolRequestParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use CallToolRequestParams instead")]
|
||||
pub type CallToolRequestParam = CallToolRequestParams;
|
||||
|
||||
/// Request to call a specific tool
|
||||
pub type CallToolRequest = Request<CallToolRequestMethod, CallToolRequestParam>;
|
||||
pub type CallToolRequest = Request<CallToolRequestMethod, CallToolRequestParams>;
|
||||
|
||||
/// The result of a sampling/createMessage request containing the generated response.
|
||||
///
|
||||
|
|
@ -1752,37 +1964,85 @@ pub struct GetPromptResult {
|
|||
// =============================================================================
|
||||
|
||||
const_string!(GetTaskInfoMethod = "tasks/get");
|
||||
pub type GetTaskInfoRequest = Request<GetTaskInfoMethod, GetTaskInfoParam>;
|
||||
pub type GetTaskInfoRequest = Request<GetTaskInfoMethod, GetTaskInfoParams>;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct GetTaskInfoParam {
|
||||
pub struct GetTaskInfoParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
pub task_id: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for GetTaskInfoParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`GetTaskInfoParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use GetTaskInfoParams instead")]
|
||||
pub type GetTaskInfoParam = GetTaskInfoParams;
|
||||
|
||||
const_string!(ListTasksMethod = "tasks/list");
|
||||
pub type ListTasksRequest = RequestOptionalParam<ListTasksMethod, PaginatedRequestParam>;
|
||||
pub type ListTasksRequest = RequestOptionalParam<ListTasksMethod, PaginatedRequestParams>;
|
||||
|
||||
const_string!(GetTaskResultMethod = "tasks/result");
|
||||
pub type GetTaskResultRequest = Request<GetTaskResultMethod, GetTaskResultParam>;
|
||||
pub type GetTaskResultRequest = Request<GetTaskResultMethod, GetTaskResultParams>;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct GetTaskResultParam {
|
||||
pub struct GetTaskResultParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
pub task_id: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for GetTaskResultParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`GetTaskResultParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use GetTaskResultParams instead")]
|
||||
pub type GetTaskResultParam = GetTaskResultParams;
|
||||
|
||||
const_string!(CancelTaskMethod = "tasks/cancel");
|
||||
pub type CancelTaskRequest = Request<CancelTaskMethod, CancelTaskParam>;
|
||||
pub type CancelTaskRequest = Request<CancelTaskMethod, CancelTaskParams>;
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
pub struct CancelTaskParam {
|
||||
pub struct CancelTaskParams {
|
||||
/// Protocol-level metadata for this request (SEP-1319)
|
||||
#[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
|
||||
pub meta: Option<Meta>,
|
||||
pub task_id: String,
|
||||
}
|
||||
|
||||
impl RequestParamsMeta for CancelTaskParams {
|
||||
fn meta(&self) -> Option<&Meta> {
|
||||
self.meta.as_ref()
|
||||
}
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta> {
|
||||
&mut self.meta
|
||||
}
|
||||
}
|
||||
|
||||
/// Deprecated: Use [`CancelTaskParams`] instead (SEP-1319 compliance).
|
||||
#[deprecated(since = "0.13.0", note = "Use CancelTaskParams instead")]
|
||||
pub type CancelTaskParam = CancelTaskParams;
|
||||
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
|
||||
|
|
@ -2201,11 +2461,13 @@ mod tests {
|
|||
serde_json::from_value(request.clone()).expect("invalid request");
|
||||
let (request, id) = request.into_request().expect("should be a request");
|
||||
assert_eq!(id, RequestId::Number(1));
|
||||
#[allow(deprecated)]
|
||||
match request {
|
||||
ClientRequest::InitializeRequest(Request {
|
||||
method: _,
|
||||
params:
|
||||
InitializeRequestParam {
|
||||
meta: _,
|
||||
protocol_version: _,
|
||||
capabilities,
|
||||
client_info,
|
||||
|
|
|
|||
|
|
@ -18,6 +18,51 @@ pub trait GetExtensions {
|
|||
fn extensions_mut(&mut self) -> &mut Extensions;
|
||||
}
|
||||
|
||||
/// Trait for request params that contain the `_meta` field.
|
||||
///
|
||||
/// Per the MCP 2025-11-25 spec, all request params should have an optional `_meta`
|
||||
/// field that can contain a `progressToken` for tracking long-running operations.
|
||||
pub trait RequestParamsMeta {
|
||||
/// Get a reference to the meta field
|
||||
fn meta(&self) -> Option<&Meta>;
|
||||
/// Get a mutable reference to the meta field
|
||||
fn meta_mut(&mut self) -> &mut Option<Meta>;
|
||||
/// Set the meta field
|
||||
fn set_meta(&mut self, meta: Meta) {
|
||||
*self.meta_mut() = Some(meta);
|
||||
}
|
||||
/// Get the progress token from meta, if present
|
||||
fn progress_token(&self) -> Option<ProgressToken> {
|
||||
self.meta().and_then(|m| m.get_progress_token())
|
||||
}
|
||||
/// Set a progress token in meta
|
||||
fn set_progress_token(&mut self, token: ProgressToken) {
|
||||
match self.meta_mut() {
|
||||
Some(meta) => meta.set_progress_token(token),
|
||||
none => {
|
||||
let mut meta = Meta::new();
|
||||
meta.set_progress_token(token);
|
||||
*none = Some(meta);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Trait for task-augmented request params that contain both `_meta` and `task` fields.
|
||||
///
|
||||
/// Per the MCP 2025-11-25 spec, certain requests (like `tools/call` and `sampling/createMessage`)
|
||||
/// can include a `task` field to signal that the caller wants task-augmented execution.
|
||||
pub trait TaskAugmentedRequestParamsMeta: RequestParamsMeta {
|
||||
/// Get a reference to the task field
|
||||
fn task(&self) -> Option<&JsonObject>;
|
||||
/// Get a mutable reference to the task field
|
||||
fn task_mut(&mut self) -> &mut Option<JsonObject>;
|
||||
/// Set the task field
|
||||
fn set_task(&mut self, task: JsonObject) {
|
||||
*self.task_mut() = Some(task);
|
||||
}
|
||||
}
|
||||
|
||||
impl GetExtensions for CustomNotification {
|
||||
fn extensions(&self) -> &Extensions {
|
||||
&self.extensions
|
||||
|
|
@ -156,6 +201,13 @@ impl Meta {
|
|||
Self(JsonObject::new())
|
||||
}
|
||||
|
||||
/// Create a new Meta with a progress token set
|
||||
pub fn with_progress_token(token: ProgressToken) -> Self {
|
||||
let mut meta = Self::new();
|
||||
meta.set_progress_token(token);
|
||||
meta
|
||||
}
|
||||
|
||||
pub(crate) fn static_empty() -> &'static Self {
|
||||
static EMPTY: std::sync::OnceLock<Meta> = std::sync::OnceLock::new();
|
||||
EMPTY.get_or_init(Default::default)
|
||||
|
|
|
|||
|
|
@ -5,18 +5,18 @@ use thiserror::Error;
|
|||
use super::*;
|
||||
use crate::{
|
||||
model::{
|
||||
ArgumentInfo, CallToolRequest, CallToolRequestParam, CallToolResult, CancelledNotification,
|
||||
CancelledNotificationParam, ClientInfo, ClientJsonRpcMessage, ClientNotification,
|
||||
ClientRequest, ClientResult, CompleteRequest, CompleteRequestParam, CompleteResult,
|
||||
CompletionContext, CompletionInfo, ErrorData, GetPromptRequest, GetPromptRequestParam,
|
||||
GetPromptResult, InitializeRequest, InitializedNotification, JsonRpcResponse,
|
||||
ListPromptsRequest, ListPromptsResult, ListResourceTemplatesRequest,
|
||||
ArgumentInfo, CallToolRequest, CallToolRequestParams, CallToolResult,
|
||||
CancelledNotification, CancelledNotificationParam, ClientInfo, ClientJsonRpcMessage,
|
||||
ClientNotification, ClientRequest, ClientResult, CompleteRequest, CompleteRequestParams,
|
||||
CompleteResult, CompletionContext, CompletionInfo, ErrorData, GetPromptRequest,
|
||||
GetPromptRequestParams, GetPromptResult, InitializeRequest, InitializedNotification,
|
||||
JsonRpcResponse, ListPromptsRequest, ListPromptsResult, ListResourceTemplatesRequest,
|
||||
ListResourceTemplatesResult, ListResourcesRequest, ListResourcesResult, ListToolsRequest,
|
||||
ListToolsResult, PaginatedRequestParam, ProgressNotification, ProgressNotificationParam,
|
||||
ReadResourceRequest, ReadResourceRequestParam, ReadResourceResult, Reference, RequestId,
|
||||
ListToolsResult, PaginatedRequestParams, ProgressNotification, ProgressNotificationParam,
|
||||
ReadResourceRequest, ReadResourceRequestParams, ReadResourceResult, Reference, RequestId,
|
||||
RootsListChangedNotification, ServerInfo, ServerJsonRpcMessage, ServerNotification,
|
||||
ServerRequest, ServerResult, SetLevelRequest, SetLevelRequestParam, SubscribeRequest,
|
||||
SubscribeRequestParam, UnsubscribeRequest, UnsubscribeRequestParam,
|
||||
ServerRequest, ServerResult, SetLevelRequest, SetLevelRequestParams, SubscribeRequest,
|
||||
SubscribeRequestParams, UnsubscribeRequest, UnsubscribeRequestParams,
|
||||
},
|
||||
transport::DynamicTransportError,
|
||||
};
|
||||
|
|
@ -350,17 +350,17 @@ macro_rules! method {
|
|||
}
|
||||
|
||||
impl Peer<RoleClient> {
|
||||
method!(peer_req complete CompleteRequest(CompleteRequestParam) => CompleteResult);
|
||||
method!(peer_req set_level SetLevelRequest(SetLevelRequestParam));
|
||||
method!(peer_req get_prompt GetPromptRequest(GetPromptRequestParam) => GetPromptResult);
|
||||
method!(peer_req list_prompts ListPromptsRequest(PaginatedRequestParam)? => ListPromptsResult);
|
||||
method!(peer_req list_resources ListResourcesRequest(PaginatedRequestParam)? => ListResourcesResult);
|
||||
method!(peer_req list_resource_templates ListResourceTemplatesRequest(PaginatedRequestParam)? => ListResourceTemplatesResult);
|
||||
method!(peer_req read_resource ReadResourceRequest(ReadResourceRequestParam) => ReadResourceResult);
|
||||
method!(peer_req subscribe SubscribeRequest(SubscribeRequestParam) );
|
||||
method!(peer_req unsubscribe UnsubscribeRequest(UnsubscribeRequestParam));
|
||||
method!(peer_req call_tool CallToolRequest(CallToolRequestParam) => CallToolResult);
|
||||
method!(peer_req list_tools ListToolsRequest(PaginatedRequestParam)? => ListToolsResult);
|
||||
method!(peer_req complete CompleteRequest(CompleteRequestParams) => CompleteResult);
|
||||
method!(peer_req set_level SetLevelRequest(SetLevelRequestParams));
|
||||
method!(peer_req get_prompt GetPromptRequest(GetPromptRequestParams) => GetPromptResult);
|
||||
method!(peer_req list_prompts ListPromptsRequest(PaginatedRequestParams)? => ListPromptsResult);
|
||||
method!(peer_req list_resources ListResourcesRequest(PaginatedRequestParams)? => ListResourcesResult);
|
||||
method!(peer_req list_resource_templates ListResourceTemplatesRequest(PaginatedRequestParams)? => ListResourceTemplatesResult);
|
||||
method!(peer_req read_resource ReadResourceRequest(ReadResourceRequestParams) => ReadResourceResult);
|
||||
method!(peer_req subscribe SubscribeRequest(SubscribeRequestParams) );
|
||||
method!(peer_req unsubscribe UnsubscribeRequest(UnsubscribeRequestParams));
|
||||
method!(peer_req call_tool CallToolRequest(CallToolRequestParams) => CallToolResult);
|
||||
method!(peer_req list_tools ListToolsRequest(PaginatedRequestParams)? => ListToolsResult);
|
||||
|
||||
method!(peer_not notify_cancelled CancelledNotification(CancelledNotificationParam));
|
||||
method!(peer_not notify_progress ProgressNotification(ProgressNotificationParam));
|
||||
|
|
@ -377,7 +377,7 @@ impl Peer<RoleClient> {
|
|||
let mut cursor = None;
|
||||
loop {
|
||||
let result = self
|
||||
.list_tools(Some(PaginatedRequestParam { cursor }))
|
||||
.list_tools(Some(PaginatedRequestParams { meta: None, cursor }))
|
||||
.await?;
|
||||
tools.extend(result.tools);
|
||||
cursor = result.next_cursor;
|
||||
|
|
@ -396,7 +396,7 @@ impl Peer<RoleClient> {
|
|||
let mut cursor = None;
|
||||
loop {
|
||||
let result = self
|
||||
.list_prompts(Some(PaginatedRequestParam { cursor }))
|
||||
.list_prompts(Some(PaginatedRequestParams { meta: None, cursor }))
|
||||
.await?;
|
||||
prompts.extend(result.prompts);
|
||||
cursor = result.next_cursor;
|
||||
|
|
@ -415,7 +415,7 @@ impl Peer<RoleClient> {
|
|||
let mut cursor = None;
|
||||
loop {
|
||||
let result = self
|
||||
.list_resources(Some(PaginatedRequestParam { cursor }))
|
||||
.list_resources(Some(PaginatedRequestParams { meta: None, cursor }))
|
||||
.await?;
|
||||
resources.extend(result.resources);
|
||||
cursor = result.next_cursor;
|
||||
|
|
@ -436,7 +436,7 @@ impl Peer<RoleClient> {
|
|||
let mut cursor = None;
|
||||
loop {
|
||||
let result = self
|
||||
.list_resource_templates(Some(PaginatedRequestParam { cursor }))
|
||||
.list_resource_templates(Some(PaginatedRequestParams { meta: None, cursor }))
|
||||
.await?;
|
||||
resource_templates.extend(result.resource_templates);
|
||||
cursor = result.next_cursor;
|
||||
|
|
@ -464,7 +464,8 @@ impl Peer<RoleClient> {
|
|||
current_value: impl Into<String>,
|
||||
context: Option<CompletionContext>,
|
||||
) -> Result<CompletionInfo, ServiceError> {
|
||||
let request = CompleteRequestParam {
|
||||
let request = CompleteRequestParams {
|
||||
meta: None,
|
||||
r#ref: Reference::for_prompt(prompt_name),
|
||||
argument: ArgumentInfo {
|
||||
name: argument_name.into(),
|
||||
|
|
@ -494,7 +495,8 @@ impl Peer<RoleClient> {
|
|||
current_value: impl Into<String>,
|
||||
context: Option<CompletionContext>,
|
||||
) -> Result<CompletionInfo, ServiceError> {
|
||||
let request = CompleteRequestParam {
|
||||
let request = CompleteRequestParams {
|
||||
meta: None,
|
||||
r#ref: Reference::for_resource(uri_template),
|
||||
argument: ArgumentInfo {
|
||||
name: argument_name.into(),
|
||||
|
|
|
|||
|
|
@ -5,13 +5,13 @@ use thiserror::Error;
|
|||
use super::*;
|
||||
#[cfg(feature = "elicitation")]
|
||||
use crate::model::{
|
||||
CreateElicitationRequest, CreateElicitationRequestParam, CreateElicitationResult,
|
||||
CreateElicitationRequest, CreateElicitationRequestParams, CreateElicitationResult,
|
||||
};
|
||||
use crate::{
|
||||
model::{
|
||||
CancelledNotification, CancelledNotificationParam, ClientInfo, ClientJsonRpcMessage,
|
||||
ClientNotification, ClientRequest, ClientResult, CreateMessageRequest,
|
||||
CreateMessageRequestParam, CreateMessageResult, ErrorData, ListRootsRequest,
|
||||
CreateMessageRequestParams, CreateMessageResult, ErrorData, ListRootsRequest,
|
||||
ListRootsResult, LoggingMessageNotification, LoggingMessageNotificationParam,
|
||||
ProgressNotification, ProgressNotificationParam, PromptListChangedNotification,
|
||||
ProtocolVersion, ResourceListChangedNotification, ResourceUpdatedNotification,
|
||||
|
|
@ -386,7 +386,7 @@ macro_rules! method {
|
|||
impl Peer<RoleServer> {
|
||||
pub async fn create_message(
|
||||
&self,
|
||||
params: CreateMessageRequestParam,
|
||||
params: CreateMessageRequestParams,
|
||||
) -> Result<CreateMessageResult, ServiceError> {
|
||||
let result = self
|
||||
.send_request(ServerRequest::CreateMessageRequest(CreateMessageRequest {
|
||||
|
|
@ -402,9 +402,9 @@ impl Peer<RoleServer> {
|
|||
}
|
||||
method!(peer_req list_roots ListRootsRequest() => ListRootsResult);
|
||||
#[cfg(feature = "elicitation")]
|
||||
method!(peer_req create_elicitation CreateElicitationRequest(CreateElicitationRequestParam) => CreateElicitationResult);
|
||||
method!(peer_req create_elicitation CreateElicitationRequest(CreateElicitationRequestParams) => CreateElicitationResult);
|
||||
#[cfg(feature = "elicitation")]
|
||||
method!(peer_req_with_timeout create_elicitation_with_timeout CreateElicitationRequest(CreateElicitationRequestParam) => CreateElicitationResult);
|
||||
method!(peer_req_with_timeout create_elicitation_with_timeout CreateElicitationRequest(CreateElicitationRequestParams) => CreateElicitationResult);
|
||||
|
||||
method!(peer_not notify_cancelled CancelledNotification(CancelledNotificationParam));
|
||||
method!(peer_not notify_progress ProgressNotification(ProgressNotificationParam));
|
||||
|
|
@ -690,7 +690,8 @@ impl Peer<RoleServer> {
|
|||
|
||||
let response = self
|
||||
.create_elicitation_with_timeout(
|
||||
CreateElicitationRequestParam {
|
||||
CreateElicitationRequestParams {
|
||||
meta: None,
|
||||
message: message.into(),
|
||||
requested_schema: schema,
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in a new issue