Skip to content

docs(client): point on_*_list_changed callbacks to Peer::listen #1402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paolocostanzo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(client): point on_*_list_changed callbacks to Peer::listen #1402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions crates/rmcp/src/handler/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,18 +232,49 @@ macro_rules! client_handler_methods {
) -> impl Future<Output = ()> + MaybeSendFuture + '_ {
std::future::ready(())
}
/// Called for a `notifications/resources/list_changed` notification that
/// is not routed to a [`Subscription`](crate::service::Subscription).
///
/// See [`Self::on_tool_list_changed`]: on a `2026-07-28` connection,
/// request it with [`Peer::listen`](crate::service::Peer::listen) and
/// [`SubscriptionFilterBuilder::resources_list_changed`](crate::model::SubscriptionFilterBuilder::resources_list_changed).
/// Notifications routed to that subscription are not delivered here. The
/// cached resource list is invalidated on either path.
fn on_resource_list_changed(
&self,
context: NotificationContext<RoleClient>,
) -> impl Future<Output = ()> + MaybeSendFuture + '_ {
std::future::ready(())
}
/// Called for a `notifications/tools/list_changed` notification that is
/// not routed to a [`Subscription`](crate::service::Subscription).
///
/// On a `2026-07-28` connection, a server sends list-changed
/// notifications on a listen stream that requested them. Open one with
/// [`Peer::listen`](crate::service::Peer::listen) and a filter built with
/// [`SubscriptionFilterBuilder::tools_list_changed`](crate::model::SubscriptionFilterBuilder::tools_list_changed),
/// then read the notifications from the returned subscription.
/// Notifications routed to a subscription are not delivered to this
/// callback, so it mainly sees notifications without a matching
/// subscription: from servers on earlier protocol versions, or from
/// servers that send them unscoped.
///
/// The client's cached `tools/list` response is invalidated on either
/// path. See `examples/clients/src/subscriptions_streamhttp.rs`.
fn on_tool_list_changed(
&self,
context: NotificationContext<RoleClient>,
) -> impl Future<Output = ()> + MaybeSendFuture + '_ {
std::future::ready(())
}
/// Called for a `notifications/prompts/list_changed` notification that is
/// not routed to a [`Subscription`](crate::service::Subscription).
///
/// See [`Self::on_tool_list_changed`]: on a `2026-07-28` connection,
/// request it with [`Peer::listen`](crate::service::Peer::listen) and
/// [`SubscriptionFilterBuilder::prompts_list_changed`](crate::model::SubscriptionFilterBuilder::prompts_list_changed).
/// Notifications routed to that subscription are not delivered here. The
/// cached prompt list is invalidated on either path.
fn on_prompt_list_changed(
&self,
context: NotificationContext<RoleClient>,
Expand Down
Loading