Struct NewSessionRequest 

#[non_exhaustive]
pub struct NewSessionRequest {
    pub cwd: PathBuf,
    pub additional_directories: Vec<PathBuf>,
    pub mcp_servers: Vec<McpServer>,
    pub meta: Option<Map<String, Value>>,
}

Request parameters for creating a new session.

See protocol docs: Creating a Session

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.

cwd: PathBuf

The working directory for this session. Must be an absolute path.

additional_directories: Vec<PathBuf>

Additional workspace roots for this session. Each path must be absolute.

These expand the session’s filesystem scope without changing cwd, which remains the base for relative paths. When omitted or empty, no additional roots are activated for the new session.

mcp_servers: Vec<McpServer>

List of MCP (Model Context Protocol) servers the agent should connect to.

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 NewSessionRequest

pub fn new(cwd: impl Into<PathBuf>) -> NewSessionRequest

pub fn additional_directories( self, additional_directories: Vec<PathBuf>, ) -> NewSessionRequest

Additional workspace roots for this session. Each path must be absolute.

pub fn mcp_servers(self, mcp_servers: Vec<McpServer>) -> NewSessionRequest

List of MCP (Model Context Protocol) servers the agent should connect to.

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

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 NewSessionRequest

fn clone(&self) -> NewSessionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NewSessionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NewSessionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonRpcMessage for NewSessionRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

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

Convert this message into an untyped message.

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

Parse this type from a method name and parameters.

impl JsonRpcRequest for NewSessionRequest

type Response = NewSessionResponse

The type of data expected in response.

impl JsonSchema for NewSessionRequest

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 NewSessionRequest

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

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 Eq for NewSessionRequest

impl StructuralPartialEq for NewSessionRequest