Skip to main content

SessionStartParams

Struct SessionStartParams 

Source
pub struct SessionStartParams {
Show 19 fields pub command_id: String, pub recovery_mode: Option<RecoveryMode>, pub session_id: Option<String>, pub workspace_root: Option<String>, pub workspace_roots: Option<Vec<String>>, pub model_id: Option<String>, pub provider_id: Option<String>, pub approval_mode: Option<ApprovalMode>, pub permission_profile: Option<String>, pub approval_rules: Option<Vec<ClientApprovalRule>>, pub config: Option<SessionConfig>, pub spawned_by: Option<SessionSpawnedBy>, pub worktree: Option<WorktreeStartRequest>, pub limits: Option<SessionLimitsChoice>, pub previous_session_id: Option<String>, pub clear: Option<bool>, pub switch_policy: Option<SwitchPolicy>, pub nodes: Option<Vec<SessionStartNode>>, pub default_node: Option<String>,
}
Expand description

session/start params.

Fields§

§command_id: String

The idempotency handle (UUIDv7). Required; the server never mints one.

§recovery_mode: Option<RecoveryMode>

Recovery choice for this construction; omission keeps legacy behavior. Explicit null is invalid.

§session_id: Option<String>

Exact identity for this new root session. When omitted the server mints a UUIDv7. This field never selects an existing session: a retained or reserved id is rejected commandRejected with reason session_id_conflict.

§workspace_root: Option<String>

Absolute path, folded into the first metadata record.

§workspace_roots: Option<Vec<String>>

The session’s initial runtime workspace-root set: ordered absolute canonical existing directory paths; the first root is the CWD and plays the primary-root role; every root receives the :workspace_roots rules; extra roots grant no Project Trust. When workspaceRoot is also present the two must name the same folder, compared on canonical forms, or the request is invalid params, and so is explicit null. Omitted preserves single-root behavior.

§model_id: Option<String>

Initial model; server default when omitted.

§provider_id: Option<String>

Initial provider routing; server default when omitted or explicit null — both spellings select the default.

§approval_mode: Option<ApprovalMode>

The session’s starting approval mode; server default when omitted or explicit null — both spellings select the default. Select, never create — the value names a mode the host’s configuration already defines. This is the only surface that declares a non-interactive run’s policy.

§permission_profile: Option<String>

The new session’s initial permission profile: a profile id the host catalog already admits — the rows permissionProfile/list serves without sessionId. Select, never create. Omitted means today’s behavior: the host’s configured default under native admission, unchanged. An id the catalog does not carry, or one it serves unavailable, refuses the start commandRejected (-32030; permission_profile_unknown / permission_profile_unavailable) before any durable byte, and an ephemeral host refuses any id (permission_profile_ephemeral_fixed). session/fork does not admit the member; session/resume admits it as the launch pick. Explicit null is invalid params: the set of members that tolerate null is closed and excludes this one, exactly as it excludes workspaceRoots.

§approval_rules: Option<Vec<ClientApprovalRule>>

The session’s client-supplied shell prefix allow-rules: {argvPrefix} objects in the ShellPrefixSuggestion.argv_prefix shape. Omitted means no client rules. Explicit null is invalid params; an empty array is an explicit empty set. Until the served-handler slice, a host refuses any spelled approvalRules on session/start/fork/resume with -32602; clients omit it. Experimental (session/start.approvalRules).

§config: Option<SessionConfig>

Reserved for future per-session overrides; only its mcpServers member is admitted.

§spawned_by: Option<SessionSpawnedBy>

The session that opens this one, in the Session.spawnedBy shape: a spawner that starts a worker session over MSP names its own session here. The host writes it once into the new session’s creation record, as a worker process records its environment hand-over, and session/list / session/read serve it back as Session.spawnedBy; session/resume never takes it. Additive-optional and provenance only. A value the host cannot use (a parentSessionId that is not a session id, a malformed member) records nothing and never refuses the start; an unusable project or thread is dropped on its own. Hosts that predate the member ignore it.

§worktree: Option<WorktreeStartRequest>

Ask for a created worktree or attach an existing one. Experimental (session/start.worktree; unopted callers are refused -32602). Absent means no worktree — the start proceeds exactly as today.

§limits: Option<SessionLimitsChoice>

The per-session restriction: the axes this session chooses, each at or below the host ceiling. Experimental, socket-only (session/start.limits; unopted callers are refused -32602, as are opted callers on hosts with no limits regime). Absent means the default on every axis — the daemon default for trust, the daemon’s own posture for the sandbox axes (the ceiling, unless --allow-session-posture widens the ceiling above it). A choice wider than the ceiling on any axis refuses the start -32028 limitsAboveMax naming every too-wide axis and the ceiling kind (error.data.ceilingKind: the daemon default or managed policy). An equal or tighter choice is what the session runs and reports, with two exceptions refused -32602: on a daemon whose default sandbox is off, a start naming sandboxEnabled: true without sandboxNetwork, or a network restriction (restricted or proxy-only) without naming sandboxEnabled, until a tracked change settles how a session turns the sandbox on there, and a network restriction beside an explicit sandboxEnabled: false, which never turns it on and stays refused while a tracked change is open: drop the restriction, since a sandbox-off session has no network to restrict (data.reason: "tighterSandboxUnserved" for all three); and under --trust-workspace --listen without --allow-session-posture, an explicit workspaceTrusted: false, naming the axis. Elsewhere a network restriction beside sandboxEnabled: false restricts nothing: with the sandbox off the network is not sandboxed (sandboxNetwork reports enabled).

§previous_session_id: Option<String>

The /new predecessor link: the outgoing session this start succeeds. Any syntactically valid session UUID; there is no existence check, so a link to a session that is gone still commits. Omitted means a true root. Explicit null is invalid params.

§clear: Option<bool>

Marks this start as a /clear: true starts the new session as a clear, so its SessionStart hooks get source clear instead of startup. false and omitted are the same plain start (source startup). It neither needs nor implies previousSessionId. Explicit null is invalid params.

§switch_policy: Option<SwitchPolicy>

What happens to the previousSessionId predecessor’s unfinished background work. Experimental (session/start.switchPolicy; unopted callers are refused -32602). kill cancels the predecessor’s unfinished work once the new start is durable, as the gate-off /new does; keep ends its persistent monitors only. A policy without the link is invalid params, and so is explicit null. Omitted means no policy: the start records keep, exactly as today.

§nodes: Option<Vec<SessionStartNode>>

The nodes this session’s tool calls run on, in the order that sets the default. Experimental (session/start.nodes; unopted callers are refused -32602). Each is attached before the start answers; a start in which one fails to attach is refused commandRejected (node_attach_refused) and leaves no session. A host with the nodes feature off refuses the member (nodes_feature_off), and so does a host that does not offer nodes (nodes_not_offered). Omitted means the session runs on the host’s own machine, exactly as today. Explicit null is invalid params.

§default_node: Option<String>

The name of the default node, one of nodes. Experimental (session/start.defaultNode; unopted callers are refused -32602). Omitted means the first node. Without nodes, a host that would refuse nodes refuses it the same way (nodes_feature_off, nodes_not_offered) and a host that attaches nodes answers invalid params. Explicit null is invalid params.

Trait Implementations§

Source§

impl Clone for SessionStartParams

Source§

fn clone(&self) -> Self

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 SessionStartParams

Source§

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

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

impl<'de> Deserialize<'de> for SessionStartParams

Source§

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

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

impl Eq for SessionStartParams

Source§

impl PartialEq for SessionStartParams

Source§

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

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SessionStartParams

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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