Struct SessionUpdateOptionsParams 

pub struct SessionUpdateOptionsParams {

    pub additional_content_exclusion_policies: Option<Vec<OptionsUpdateAdditionalContentExclusionPolicy>>,
    pub agent_context: Option<String>,
    pub ask_user_disabled: Option<bool>,
    pub available_tools: Option<Vec<String>>,
    pub client_name: Option<String>,
    pub coauthor_enabled: Option<bool>,
    pub context_tier: Option<OptionsUpdateContextTier>,
    pub continue_on_auto_mode: Option<bool>,
    pub copilot_url: Option<String>,
    pub custom_agents_local_only: Option<bool>,
    pub disabled_instruction_sources: Option<Vec<String>>,
    pub disabled_skills: Option<Vec<String>>,
    pub enable_file_hooks: Option<bool>,
    pub enable_host_git_operations: Option<bool>,
    pub enable_on_demand_instruction_discovery: Option<bool>,
    pub enable_reasoning_summaries: Option<bool>,
    pub enable_script_safety: Option<bool>,
    pub enable_session_store: Option<bool>,
    pub enable_skills: Option<bool>,
    pub enable_streaming: Option<bool>,
    pub env_value_mode: Option<OptionsUpdateEnvValueMode>,
    pub events_log_directory: Option<String>,
    pub excluded_tools: Option<Vec<String>>,
    pub feature_flags: Option<HashMap<String, bool>>,
    pub installed_plugins: Option<Vec<SessionInstalledPlugin>>,
    pub integration_id: Option<String>,
    pub is_experimental_mode: Option<bool>,
    pub log_interactive_shells: Option<bool>,
    pub lsp_client_name: Option<String>,
    pub manage_schedule_enabled: Option<bool>,
    pub max_inline_binary_bytes: Option<i64>,
    pub model: Option<String>,
    pub model_capabilities_overrides: Option<ModelCapabilitiesOverride>,
    pub organization_custom_instructions: Option<String>,
    pub provider: Option<ProviderConfig>,
    pub reasoning_effort: Option<String>,
    pub reasoning_summary: Option<OptionsUpdateReasoningSummary>,
    pub running_in_interactive_mode: Option<bool>,
    pub sandbox_config: Option<SandboxConfig>,
    pub session_capabilities: Option<Vec<SessionCapability>>,
    pub shell_init_profile: Option<String>,
    pub shell_process_flags: Option<Vec<String>>,
    pub skill_directories: Option<Vec<String>>,
    pub skip_custom_instructions: Option<bool>,
    pub skip_embedding_retrieval: Option<bool>,
    pub suppress_custom_agent_prompt: Option<bool>,
    pub tool_filter_precedence: Option<OptionsUpdateToolFilterPrecedence>,
    pub trajectory_file: Option<String>,
    pub working_directory: Option<String>,
}

Patch of mutable session options to apply to the running session.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

additional_content_exclusion_policies: Option<Vec<OptionsUpdateAdditionalContentExclusionPolicy>>

Additional content-exclusion policies to merge into the session’s policy set.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

agent_context: Option<String>

Runtime context discriminator (e.g., cli, actions).

ask_user_disabled: Option<bool>

Whether to disable the ask_user tool (encourages autonomous behavior).

available_tools: Option<Vec<String>>

Allowlist of tool names available to this session.

client_name: Option<String>

Identifier of the client driving the session.

coauthor_enabled: Option<bool>

Whether to include the Co-authored-by trailer in commit messages.

context_tier: Option<OptionsUpdateContextTier>

Context tier for models with tiered pricing. The session uses this to derive effective modelCapabilitiesOverrides so compaction, truncation, token display, and request limits honor the selected tier.

continue_on_auto_mode: Option<bool>

Whether to allow auto-mode continuation across turns.

copilot_url: Option<String>

Override URL for the Copilot API endpoint.

custom_agents_local_only: Option<bool>

Whether to default custom agents to local-only execution.

disabled_instruction_sources: Option<Vec<String>>

Instruction source IDs to exclude from the system prompt.

disabled_skills: Option<Vec<String>>

Skill IDs that should be excluded from this session.

enable_file_hooks: Option<bool>

Whether to enable loading of .github/hooks/ filesystem hooks. Separate from the SDK callback hook mechanism.

enable_host_git_operations: Option<bool>

Whether to enable host git operations (context resolution, child repo scanning, git info in system prompt).

enable_on_demand_instruction_discovery: Option<bool>

Whether to discover custom instructions on demand after successful file views (AGENTS.md / CLAUDE.md / .github/copilot-instructions.md surfacing). Combined with skipCustomInstructions and the runtime-side ON_DEMAND_INSTRUCTIONS feature flag.

enable_reasoning_summaries: Option<bool>

Whether to surface reasoning-summary events from the model.

enable_script_safety: Option<bool>

Whether shell-script safety heuristics are enabled.

enable_session_store: Option<bool>

Whether to enable cross-session store writes and reads.

enable_skills: Option<bool>

Whether to enable skill directory scanning and loading. Falls back to enableConfigDiscovery when unset.

enable_streaming: Option<bool>

Whether to stream model responses.

env_value_mode: Option<OptionsUpdateEnvValueMode>

How env values are passed to MCP servers (direct inlines literal values; indirect resolves at launch).

events_log_directory: Option<String>

Override directory for the session-events log. When unset, the runtime’s default events log directory is used.

excluded_tools: Option<Vec<String>>

Denylist of tool names for this session.

feature_flags: Option<HashMap<String, bool>>

Map of feature-flag IDs to their boolean enabled state.

installed_plugins: Option<Vec<SessionInstalledPlugin>>

Full set of installed plugins for the session. Replaces the existing list; the runtime invalidates the skills cache only when the list materially changes.

integration_id: Option<String>

Stable integration identifier used for analytics and rate-limit attribution.

is_experimental_mode: Option<bool>

Whether experimental capabilities are enabled.

log_interactive_shells: Option<bool>

Whether interactive shell sessions are logged.

lsp_client_name: Option<String>

Identifier sent to LSP-style integrations.

manage_schedule_enabled: Option<bool>

Whether to expose the manage_schedule tool to the agent. The runtime always owns the per-session schedule registry; this flag only controls tool exposure (typically gated to staff users).

max_inline_binary_bytes: Option<i64>

Maximum decoded byte size of a single model-facing binary tool result (e.g. an image) persisted inline in session events and re-presented to the model on later turns / resume. Larger results are persisted as a metadata-only marker and shown to the model as a short text note. Defaults to 10 MB.

model: Option<String>

The model ID to use for assistant turns.

model_capabilities_overrides: Option<ModelCapabilitiesOverride>

Per-property model capability overrides for the selected model.

organization_custom_instructions: Option<String>

Organization-level custom instructions to inject into the system prompt.

provider: Option<ProviderConfig>

Custom model-provider configuration (BYOK).

reasoning_effort: Option<String>

Reasoning effort for the selected model (model-defined enum).

reasoning_summary: Option<OptionsUpdateReasoningSummary>

Reasoning summary mode for supported model clients.

running_in_interactive_mode: Option<bool>

Whether the session is running in an interactive UI.

sandbox_config: Option<SandboxConfig>

Resolved sandbox configuration.

session_capabilities: Option<Vec<SessionCapability>>

Replaces the session’s capability set with the given list. Use to enable or disable capabilities mid-session (e.g., remove memory for reproducible scripted runs). Omit the field to leave the existing capability set unchanged.

shell_init_profile: Option<String>

Shell init profile (None or NonInteractive).

shell_process_flags: Option<Vec<String>>

Per-shell process flags (e.g., pwsh arguments).

skill_directories: Option<Vec<String>>

Additional directories to search for skills.

skip_custom_instructions: Option<bool>

Whether to skip loading custom instruction sources.

skip_embedding_retrieval: Option<bool>

Whether to skip embedding retrieval pipeline initialization and execution.

suppress_custom_agent_prompt: Option<bool>

When true, the selected custom agent’s prompt is not injected into the user message (skill context is still injected). Used by automation triggers where the agent prompt is already in the problem statement.

tool_filter_precedence: Option<OptionsUpdateToolFilterPrecedence>

Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set.

trajectory_file: Option<String>

Optional path for trajectory output.

working_directory: Option<String>

Absolute working-directory path for shell tools.

Trait Implementations

impl Clone for SessionUpdateOptionsParams

fn clone(&self) -> SessionUpdateOptionsParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionUpdateOptionsParams

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

Formats the value using the given formatter.

impl Default for SessionUpdateOptionsParams

fn default() -> SessionUpdateOptionsParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionUpdateOptionsParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionUpdateOptionsParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.