Struct ClientCapabilities 

#[non_exhaustive]
pub struct ClientCapabilities {
    pub fs: FileSystemCapabilities,
    pub terminal: bool,
    pub plan: Option<PlanCapabilities>,
    pub auth: AuthCapabilities,
    pub elicitation: Option<ElicitationCapabilities>,
    pub nes: Option<ClientNesCapabilities>,
    pub position_encodings: Vec<PositionEncodingKind>,
    pub meta: Option<Meta>,
}

Capabilities supported by the client.

Advertised during initialization to inform the agent about available features and methods.

See protocol docs: Client Capabilities

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fs: FileSystemCapabilities

File system capabilities supported by the client. Determines which file operations the agent can request.

terminal: bool

Whether the Client support all terminal/* methods.

plan: Option<PlanCapabilities>

Available on crate feature unstable_plan_operations only.

UNSTABLE

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

Whether the client supports plan_update and plan_removed session updates.

Optional. Omitted means the client does not advertise support. Supplying {} means the client can receive both update types.

auth: AuthCapabilities

Available on crate feature unstable_auth_methods only.

UNSTABLE

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

Authentication capabilities supported by the client. Determines which authentication method types the agent may include in its InitializeResponse.

elicitation: Option<ElicitationCapabilities>

Available on crate feature unstable_elicitation only.

UNSTABLE

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

Elicitation capabilities supported by the client. Determines which elicitation modes the agent may use.

nes: Option<ClientNesCapabilities>

Available on crate feature unstable_nes only.

UNSTABLE

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

NES (Next Edit Suggestions) capabilities supported by the client.

position_encodings: Vec<PositionEncodingKind>

Available on crate feature unstable_nes only.

UNSTABLE

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

The position encodings supported by the client, in order of preference.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl ClientCapabilities

pub fn new() -> Self

pub fn fs(self, fs: FileSystemCapabilities) -> Self

File system capabilities supported by the client. Determines which file operations the agent can request.

pub fn terminal(self, terminal: bool) -> Self

Whether the Client support all terminal/* methods.

pub fn plan(self, plan: impl IntoOption<PlanCapabilities>) -> Self

Available on crate feature unstable_plan_operations only.

UNSTABLE

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

Whether the client supports plan_update and plan_removed session updates.

Omitted means the client does not advertise support. Supplying {} means the client can receive both update types.

pub fn auth(self, auth: AuthCapabilities) -> Self

Available on crate feature unstable_auth_methods only.

UNSTABLE

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

Authentication capabilities supported by the client. Determines which authentication method types the agent may include in its InitializeResponse.

pub fn elicitation( self, elicitation: impl IntoOption<ElicitationCapabilities>, ) -> Self

Available on crate feature unstable_elicitation only.

UNSTABLE

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

Elicitation capabilities supported by the client. Determines which elicitation modes the agent may use.

pub fn nes(self, nes: impl IntoOption<ClientNesCapabilities>) -> Self

Available on crate feature unstable_nes only.

UNSTABLE

NES (Next Edit Suggestions) capabilities supported by the client.

pub fn position_encodings( self, position_encodings: Vec<PositionEncodingKind>, ) -> Self

Available on crate feature unstable_nes only.

UNSTABLE

The position encodings supported by the client, in order of preference.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for ClientCapabilities

fn clone(&self) -> ClientCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientCapabilities

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

Formats the value using the given formatter.

impl Default for ClientCapabilities

fn default() -> ClientCapabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientCapabilities

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClientCapabilities

impl IntoV2 for ClientCapabilities

Available on crate feature unstable_protocol_v2 only.

type Output = ClientCapabilities

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for ClientCapabilities

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl PartialEq for ClientCapabilities

fn eq(&self, other: &ClientCapabilities) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientCapabilities

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientCapabilities