Skip to main content

ClientNotification

Enum ClientNotification 

Source
#[non_exhaustive]
pub enum ClientNotification { CancelSessionNotification(Box<CancelSessionNotification>), MessageMcpNotification(Box<MessageMcpNotification>), ExtNotification(Box<ExtNotification>), }
Available on crate feature unstable_protocol_v2 only.
Expand description

All possible notifications that a Client can send to an Agent.

This enum is used internally for routing RPC notifications. You typically won’t need to use this directly.

Notifications do not expect a response.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

CancelSessionNotification(Box<CancelSessionNotification>)

Cancels the named session’s active foreground work and earlier prompts not yet inserted. The Agent MUST answer those uninserted prompts with -32800. Inserted prompts still succeed with their messageId. This cancellation does not cover later submissions.

Work in the latest background list is not covered and keeps running. The Agent MAY stop background activity it does not list.

Upon receiving this notification, the Agent SHOULD stop all language model requests and all tool call invocations of the cancelled foreground work as soon as possible.

The Agent MUST stop waiting for pending session/request_permission requests of the cancelled work and treat them as not approved. It MUST cancel each of them with $/cancel_request.

When cancellation stops active foreground work, the Agent MUST send that work’s pending updates, then an idle state_update with stopReason: "cancelled", before starting new foreground work in the same session. A later prompt can be inserted and acknowledged before that idle update, or held with its response pending. Listed background work can report updates before or after it. No additional idle update is required if no foreground work was active.

After cancellation completes, the Agent SHOULD ignore late answers rather than use them to resume the cancelled work.

Agents MUST catch errors caused by aborting cancelled work and report the cancelled stop reason, not error.

See protocol docs: Cancellation

§

MessageMcpNotification(Box<MessageMcpNotification>)

Available on crate feature unstable_mcp_over_acp only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Sends an MCP-over-ACP notification.

§

ExtNotification(Box<ExtNotification>)

Handles extension notifications from the Client.

Extension notifications are custom one-way messages that are not part of the ACP spec.

See protocol docs: Extensibility

Implementations§

Source§

impl ClientNotification

Source

pub fn method(&self) -> &str

Returns the corresponding method name.

Source

pub fn supports_method(method: &str) -> bool

Whether this enum recognizes the method with the enabled Cargo features, including extensions when it has an extension variant.

This does not check the peer’s advertised capabilities.

Source

pub fn from_method_and_params( method: &str, params: &Value, ) -> Result<Self, MethodDispatchError>

Parses parameters selected by the JSON-RPC method name.

Use this instead of the enum’s untagged Deserialize implementation. Untagged deserialization selects by payload shape, which can silently select an unrelated variant.

The payload is passed unchanged to the selected type’s deserializer. In particular, null is not converted to {}. Extension payloads retain their JSON value and method name.

§Errors

Returns crate::MethodDispatchError::UnknownMethod for an unsupported method, or crate::MethodDispatchError::InvalidPayload for a malformed payload.

Trait Implementations§

Source§

impl Clone for ClientNotification

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientNotification

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ClientNotification

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ClientNotification

Available on crate feature schemars only.
Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for ClientNotification

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.