Struct InitializeResponse 

#[non_exhaustive]
pub struct InitializeResponse {
    pub protocol_version: ProtocolVersion,
    pub capabilities: AgentCapabilities,
    pub auth_methods: Vec<AuthMethod>,
    pub agent_info: Option<Implementation>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Response to the initialize method.

Contains the negotiated protocol version and agent capabilities.

See protocol docs: Initialization

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.

protocol_version: ProtocolVersion

The protocol version the client specified if supported by the agent, or the latest protocol version supported by the agent.

The client should disconnect, if it doesn’t support this version.

capabilities: AgentCapabilities

Capabilities supported by the agent.

auth_methods: Vec<AuthMethod>

Authentication methods supported by the agent.

agent_info: Option<Implementation>

Information about the Agent name and version sent to the Client.

Note: in future versions of the protocol, this will be required.

meta: Option<Map<String, Value>>

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 InitializeResponse

pub fn new(protocol_version: ProtocolVersion) -> InitializeResponse

Builds InitializeResponse with the required response fields set; optional fields start unset or empty.

pub fn capabilities(self, capabilities: AgentCapabilities) -> InitializeResponse

Capabilities supported by the agent.

pub fn auth_methods(self, auth_methods: Vec<AuthMethod>) -> InitializeResponse

Authentication methods supported by the agent.

pub fn agent_info( self, agent_info: impl IntoOption<Implementation>, ) -> InitializeResponse

Information about the Agent name and version sent to the Client.

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> InitializeResponse

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 InitializeResponse

fn clone(&self) -> InitializeResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitializeResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InitializeResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InitializeResponse

impl IntoV1 for InitializeResponse

type Output = InitializeResponse

The corresponding v1 type.

fn into_v1( self, ) -> Result<<InitializeResponse as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonRpcResponse for InitializeResponse

fn into_json(self, _method: &str) -> Result<Value, Error>

Convert this message into a JSON value.

fn from_value(_method: &str, value: Value) -> Result<Self, Error>

Parse a JSON value into the response type.

impl JsonSchema for InitializeResponse

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 InitializeResponse

fn eq(&self, other: &InitializeResponse) -> 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 InitializeResponse

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.

impl StructuralPartialEq for InitializeResponse