Skip to main content

SessionOptionsRequest

Struct SessionOptionsRequest 

Source
#[non_exhaustive]
pub struct SessionOptionsRequest { pub cwd: AbsolutePath, pub additional_directories: Vec<AbsolutePath>, pub session_id: Option<SessionId>, pub meta: Option<Map<String, Value>>, }
Available on crate feature unstable_protocol_v2 only.
Expand description

UNSTABLE

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

Request parameters for session/options, which returns the config options a session would start with, without creating or resuming a session.

Only available if the Agent supports the session.options capability.

session/options MUST NOT create or resume a session, send session/update notifications, add an entry to session/list, or change an existing session. Agents SHOULD NOT connect to MCP servers to answer it. Agents MAY start their runtime to resolve the options. The rules above still hold for it.

Fields (Non-exhaustive)§

This struct is marked as 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.
§cwd: AbsolutePath

The working directory to resolve options for. Must be an absolute path.

§additional_directories: Vec<AbsolutePath>

Additional workspace roots to resolve options for. Each path must be absolute.

Optional. Omitted and null are equivalent to an empty list.

§session_id: Option<SessionId>

The session to resolve options for.

Optional. Omitted and null are equivalent and mean a new session. When present, the Agent returns what session/resume with the same cwd and additionalDirectories would return, with the same cwd rules. A session the Agent does not know gets -32002.

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

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations§

Source§

impl SessionOptionsRequest

Source

pub fn new(cwd: impl Into<AbsolutePath>) -> SessionOptionsRequest

Available on crate feature unstable_session_options only.

Builds SessionOptionsRequest with the required request fields set. Optional fields start unset or empty.

Source

pub fn additional_directories<I, P>( self, additional_directories: I, ) -> SessionOptionsRequest
where I: IntoIterator<Item = P>, P: Into<AbsolutePath>,

Available on crate feature unstable_session_options only.

Additional workspace roots to resolve options for. Each path must be absolute.

Source

pub fn session_id( self, session_id: impl IntoOption<SessionId>, ) -> SessionOptionsRequest

Available on crate feature unstable_session_options only.

The session to resolve options for. Unset means a new session.

Source

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

Available on crate feature unstable_session_options only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations§

Source§

impl Clone for SessionOptionsRequest

Source§

fn clone(&self) -> SessionOptionsRequest

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 SessionOptionsRequest

Source§

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

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

impl<'de> Deserialize<'de> for SessionOptionsRequest

Source§

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

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

impl Eq for SessionOptionsRequest

Source§

impl JsonRpcMessage for SessionOptionsRequest

Source§

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.
Source§

fn method(&self) -> &str

The method name for the message.
Source§

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.
Source§

fn parse_message(method: &str, params: &Value) -> Result<Self, Error>

Parse this type from a method name and the message’s JSON params. Read more
Source§

impl JsonRpcRequest for SessionOptionsRequest

Source§

type Response = SessionOptionsResponse

The type of data expected in response.
Source§

impl JsonSchema for SessionOptionsRequest

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 PartialEq for SessionOptionsRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for SessionOptionsRequest

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

impl StructuralPartialEq for SessionOptionsRequest

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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