pub struct SessionStartParams {Show 14 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 config: Option<SessionConfig>,
pub spawned_by: Option<SessionSpawnedBy>,
pub worktree: Option<WorktreeStartRequest>,
pub limits: Option<SessionLimitsChoice>,
pub previous_session_id: Option<String>,
}Expand description
session/start params.
Fields§
§command_id: StringThe 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.
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 ceiling for the
sandbox axes. A choice wider than the ceiling on any axis refuses the
start -32028 limitsAboveMax naming every too-wide axis.
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.