Struct ForkSessionRequest 

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

UNSTABLE

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

Request parameters for forking an existing session.

Creates a new session based on the context of an existing one, allowing operations like generating summaries without affecting the original session’s history.

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

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.

session_id: SessionId

The ID of the session to fork.

cwd: PathBuf

The working directory for this session.

additional_directories: Vec<PathBuf>

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

When omitted or empty, no additional roots are activated. When non-empty, this is the complete resulting additional-root list for the forked session.

mcp_servers: Vec<McpServer>

List of MCP servers to connect to for this session.

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 ForkSessionRequest

pub fn new( session_id: impl Into<SessionId>, cwd: impl Into<PathBuf>, ) -> ForkSessionRequest

Available on crate feature unstable_session_fork only.

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

Available on crate feature unstable_session_fork only.

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

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

Available on crate feature unstable_session_fork only.

List of MCP servers to connect to for this session.

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

Available on crate feature unstable_session_fork only.

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 ForkSessionRequest

fn clone(&self) -> ForkSessionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForkSessionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ForkSessionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ForkSessionRequest

impl IntoV2 for ForkSessionRequest

Available on crate feature unstable_session_fork only.

type Output = ForkSessionRequest

The corresponding v2 draft type.

fn into_v2( self, ) -> Result<<ForkSessionRequest as IntoV2>::Output, ProtocolConversionError>

Converts this value into the corresponding v2 draft type.

impl JsonRpcMessage for ForkSessionRequest

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 ForkSessionRequest

type Response = ForkSessionResponse

The type of data expected in response.

impl JsonSchema for ForkSessionRequest

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 ForkSessionRequest

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

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 ForkSessionRequest