Skip to main content

ServerCapabilities

Struct ServerCapabilities 

Source
pub struct ServerCapabilities {
    pub completions: Option<Map<String, Value>>,
    pub experimental: Option<HashMap<String, Map<String, Value>>>,
    pub logging: Option<Map<String, Value>>,
    pub prompts: Option<ServerCapabilitiesPrompts>,
    pub resources: Option<ServerCapabilitiesResources>,
    pub tasks: Option<ServerTasks>,
    pub tools: Option<ServerCapabilitiesTools>,
}
Expand description

Capabilities that a server may support. Known capabilities are defined here, in this schema, but this is not a closed set: any server can define its own, additional capabilities.

JSON schema
{
 "description": "Capabilities that a server may support. Known capabilities are defined here, in this schema, but this is not a closed set: any server can define its own, additional capabilities.",
 "type": "object",
 "properties": {
   "completions": {
     "description": "Present if the server supports argument autocompletion suggestions.",
     "type": "object",
     "additionalProperties": true
   },
   "experimental": {
     "description": "Experimental, non-standard capabilities that the server supports.",
     "type": "object",
     "additionalProperties": {
       "type": "object",
       "additionalProperties": true
     }
   },
   "logging": {
     "description": "Present if the server supports sending log messages to the client.",
     "type": "object",
     "additionalProperties": true
   },
   "prompts": {
     "description": "Present if the server offers any prompt templates.",
     "type": "object",
     "properties": {
       "listChanged": {
         "description": "Whether this server supports notifications for changes to the prompt list.",
         "type": "boolean"
       }
     }
   },
   "resources": {
     "description": "Present if the server offers any resources to read.",
     "type": "object",
     "properties": {
       "listChanged": {
         "description": "Whether this server supports notifications for changes to the resource list.",
         "type": "boolean"
       },
       "subscribe": {
         "description": "Whether this server supports subscribing to resource updates.",
         "type": "boolean"
       }
     }
   },
   "tasks": {
     "description": "Present if the server supports task-augmented requests.",
     "type": "object",
     "properties": {
       "cancel": {
         "description": "Whether this server supports tasks/cancel.",
         "type": "object",
         "additionalProperties": true
       },
       "list": {
         "description": "Whether this server supports tasks/list.",
         "type": "object",
         "additionalProperties": true
       },
       "requests": {
         "description": "Specifies which request types can be augmented with tasks.",
         "type": "object",
         "properties": {
           "tools": {
             "description": "Task support for tool-related requests.",
             "type": "object",
             "properties": {
               "call": {
                 "description": "Whether the server supports task-augmented tools/call requests.",
                 "type": "object",
                 "additionalProperties": true
               }
             }
           }
         }
       }
     }
   },
   "tools": {
     "description": "Present if the server offers any tools to call.",
     "type": "object",
     "properties": {
       "listChanged": {
         "description": "Whether this server supports notifications for changes to the tool list.",
         "type": "boolean"
       }
     }
   }
 }
}

Fields§

§completions: Option<Map<String, Value>>

Present if the server supports argument autocompletion suggestions.

§experimental: Option<HashMap<String, Map<String, Value>>>

Experimental, non-standard capabilities that the server supports.

§logging: Option<Map<String, Value>>

Present if the server supports sending log messages to the client.

§prompts: Option<ServerCapabilitiesPrompts>§resources: Option<ServerCapabilitiesResources>§tasks: Option<ServerTasks>§tools: Option<ServerCapabilitiesTools>

Implementations§

Source§

impl ServerCapabilities

Source

pub fn can_list_tasks(&self) -> bool

Returns true if the server supports listing tasks.

This is determined by whether the list capability is present.

Source

pub fn can_cancel_tasks(&self) -> bool

Returns true if the server supports canceling tasks.

This is determined by whether the cancel capability is present.

Source

pub fn can_run_task_augmented_tools(&self) -> bool

Returns true if the server supports task-augmented tools/call requests

Source

pub fn can_handle_request( &self, client_request: &ClientJsonrpcRequest, ) -> Result<(), RpcError>

Source

pub fn can_accept_notification( &self, notification_method: &str, ) -> Result<(), RpcError>

Asserts that the server supports the requested notification.

Verifies that the server advertises support for the notification type, allowing callers to avoid sending notifications that the server does not support. This can be used to prevent issuing requests to peers that lack the required capability.

Trait Implementations§

Source§

impl Clone for ServerCapabilities

Source§

fn clone(&self) -> ServerCapabilities

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerCapabilities

Source§

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

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

impl Default for ServerCapabilities

Source§

fn default() -> ServerCapabilities

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ServerCapabilities

Source§

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

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

impl Serialize for ServerCapabilities

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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