@github/copilot-sdk 1.0.6-preview.0 → 1.0.6

package/dist/generated/session-events.d.ts

@@ -5,7 +5,7 @@
 /**
  * Union of all session event variants emitted by the Copilot CLI runtime.
  */
-export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
+export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | ScheduleRearmedEvent | AutopilotObjectiveChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | SessionLimitsChangedEvent | PermissionsChangedEvent | PlanChangedEvent | TodosChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | UsageCheckpointEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantToolCallDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantIdleEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | HookProgressEvent | BinaryAssetEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | McpHeadersRefreshRequiredEvent | McpHeadersRefreshCompletedEvent | CustomNotificationEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | SessionLimitsExhaustedRequestedEvent | SessionLimitsExhaustedCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent | CanvasOpenedEvent | CanvasRegistryChangedEvent | CanvasClosedEvent | CanvasUnavailableEvent | CanvasRecordedEvent | CanvasRemovedEvent | ExtensionsAttachmentsPushedEvent | McpAppToolCallCompleteEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -32,6 +32,16 @@ export type ReasoningSummary =
  | "concise"
 /** Request a detailed summary of the model's reasoning. */
  | "detailed";
+/**
+ * Output verbosity level used for supported model calls (e.g. "low", "medium", "high")
+ */
+export type Verbosity = 
+/** A terse response was requested. */
+"low"
+/** A medium amount of response detail was requested. */
+ | "medium"
+/** A more detailed response was requested. */
+ | "high";
 /**
  * The type of operation performed on the autopilot objective state file
  */
@@ -64,6 +74,17 @@ export type SessionMode =
  | "plan"
 /** The agent is working autonomously toward task completion. */
  | "autopilot";
+/**
+ * Allow-all mode for the session.
+ */
+/** @experimental */
+export type PermissionAllowAllMode = 
+/** Permission requests follow the normal approval flow. */
+"off"
+/** Tool, path, and URL permission requests are automatically approved. */
+ | "on"
+/** Permission requests follow the normal approval flow with an LLM advisory recommendation attached; clients may choose to auto-approve requests the judge evaluated as acceptable. */
+ | "auto";
 /**
  * The type of operation performed on the plan file
  */
@@ -142,6 +163,14 @@ export type UserMessageDelivery =
  | "steering"
 /** Enqueued while the agent was busy; processed as its own run afterward. */
  | "queued";
+/**
+ * Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent.
+ */
+export type AssistantMessageToolRequestType = 
+/** Standard function-style tool call. */
+"function"
+/** Custom grammar-based tool call. */
+ | "custom";
 /**
  * The system that produced a citation.
  */
@@ -158,14 +187,6 @@ export type CitationProvider =
  */
 /** @experimental */
 export type CitationLocation = CitationLocationChar | CitationLocationPage | CitationLocationBlock;
-/**
- * Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent.
- */
-export type AssistantMessageToolRequestType = 
-/** Standard function-style tool call. */
-"function"
-/** Custom grammar-based tool call. */
- | "custom";
 /**
  * API endpoint used for this model call, matching CAPI supported_endpoints vocabulary
  */
@@ -329,6 +350,19 @@ export type PermissionRequestMemoryDirection =
  * Derived user-facing permission prompt details for UI consumers
  */
 export type PermissionPromptRequest = PermissionPromptRequestCommands | PermissionPromptRequestWrite | PermissionPromptRequestRead | PermissionPromptRequestMcp | PermissionPromptRequestUrl | PermissionPromptRequestMemory | PermissionPromptRequestCustomTool | PermissionPromptRequestPath | PermissionPromptRequestHook | PermissionPromptRequestExtensionManagement | PermissionPromptRequestExtensionPermissionAccess;
+/**
+ * Outcome of the auto-approval safety judge for a permission request. Present only when auto mode is enabled; its absence means the judge did not evaluate the request (auto mode was off).
+ */
+/** @experimental */
+export type AutoApprovalRecommendation = 
+/** The judge evaluated the request and recommends automatically approving it. */
+"approve"
+/** The judge evaluated the request and does not recommend auto-approving it; explicit approval is required. Whether that means prompting, denying, or something else is the consumer's decision. */
+ | "requireApproval"
+/** Auto mode is enabled, but this request category is never auto-approvable (for example, sandbox-bypass requests), so the judge was not consulted. */
+ | "excluded"
+/** The judge was consulted but did not return a usable recommendation, so the request requires explicit approval. */
+ | "error";
 /**
  * Underlying permission kind that needs path approval
  */
@@ -598,6 +632,7 @@ export interface StartData {
      * ISO 8601 timestamp when the session was created
      */
     startTime: string;
+    verbosity?: Verbosity;
     /**
      * Schema version number for the session event format
      */
@@ -726,6 +761,7 @@ export interface ResumeData {
      * True when this resume attached to a session that the runtime already had running in-memory (for example, an extension joining a session another client was actively driving). False (or omitted) for cold resumes — the runtime had to reconstitute the session from its persisted event log.
      */
     sessionWasActive?: boolean;
+    verbosity?: Verbosity;
 }
 /**
  * Session event "session.remote_steerable_changed". Notifies that the session's remote steering capability has changed
@@ -1262,11 +1298,13 @@ export interface ModelChangeData {
      */
     previousReasoningEffort?: string;
     previousReasoningSummary?: ReasoningSummary;
+    previousVerbosity?: Verbosity;
     /**
      * Reasoning effort level after the model change, if applicable
      */
     reasoningEffort?: string | null;
     reasoningSummary?: ReasoningSummary;
+    verbosity?: Verbosity;
 }
 /**
  * Session event "session.mode_changed". Agent mode change details including previous and new modes
@@ -1345,7 +1383,7 @@ export interface SessionLimitsChangedData {
     sessionLimits: SessionLimitsConfig | null;
 }
 /**
- * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all boolean transition.
+ * Session event "session.permissions_changed". Permissions change details carrying the aggregate allow-all transition.
  */
 export interface PermissionsChangedEvent {
     /**
@@ -1375,13 +1413,25 @@ export interface PermissionsChangedEvent {
     type: "session.permissions_changed";
 }
 /**
- * Permissions change details carrying the aggregate allow-all boolean transition.
+ * Permissions change details carrying the aggregate allow-all transition.
  */
 export interface PermissionsChangedData {
+    /**
+     * Allow-all mode after the change
+     *
+     * @experimental
+     */
+    allowAllPermissionMode?: PermissionAllowAllMode;
     /**
      * Aggregate allow-all flag after the change
      */
     allowAllPermissions: boolean;
+    /**
+     * Allow-all mode before the change
+     *
+     * @experimental
+     */
+    previousAllowAllPermissionMode?: PermissionAllowAllMode;
     /**
      * Aggregate allow-all flag before the change
      */
@@ -1791,7 +1841,7 @@ export interface ShutdownCodeChanges {
     linesRemoved: number;
 }
 /**
- * Schema for the `ShutdownModelMetric` type.
+ * Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details.
  */
 export interface ShutdownModelMetric {
     requests: ShutdownModelMetricRequests;
@@ -1827,7 +1877,7 @@ export interface ShutdownModelMetricRequests {
     count?: number;
 }
 /**
- * Schema for the `ShutdownModelMetricTokenDetail` type.
+ * A token-type entry in a shutdown model metric, storing the accumulated token count.
  */
 export interface ShutdownModelMetricTokenDetail {
     /**
@@ -1861,7 +1911,7 @@ export interface ShutdownModelMetricUsage {
     reasoningTokens?: number;
 }
 /**
- * Schema for the `ShutdownTokenDetail` type.
+ * A session-wide shutdown token-type entry storing the accumulated token count.
  */
 export interface ShutdownTokenDetail {
     /**
@@ -2039,6 +2089,10 @@ export interface CompactionStartData {
      * Token count from non-system messages (user, assistant, tool) at compaction start
      */
     conversationTokens?: number;
+    /**
+     * Model identifier used for compaction, when known
+     */
+    model?: string;
     /**
      * Token count from system message(s) at compaction start
      */
@@ -2246,7 +2300,7 @@ export interface TaskCompleteData {
     summary?: string;
 }
 /**
- * Session event "user.message".
+ * Session event "user.message". Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs.
  */
 export interface UserMessageEvent {
     /**
@@ -2276,7 +2330,7 @@ export interface UserMessageEvent {
     type: "user.message";
 }
 /**
- * Schema for the `UserMessageData` type.
+ * Payload of `user.message` with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs.
  */
 export interface UserMessageData {
     agentMode?: UserMessageAgentMode;
@@ -2831,6 +2885,10 @@ export interface AssistantTurnStartData {
      * CAPI interaction ID for correlating this turn with upstream telemetry
      */
     interactionId?: string;
+    /**
+     * Model identifier used for this turn, when known
+     */
+    model?: string;
     /**
      * Identifier for this turn within the agentic loop, typically a stringified turn number
      */
@@ -2961,6 +3019,54 @@ export interface AssistantReasoningDeltaData {
      */
     reasoningId: string;
 }
+/**
+ * Session event "assistant.tool_call_delta". Streaming tool-call input delta for incremental tool-call updates
+ */
+export interface AssistantToolCallDeltaEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: AssistantToolCallDeltaData;
+    /**
+     * Always true for events that are transient and not persisted to the session event log on disk.
+     */
+    ephemeral: true;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    /**
+     * Type discriminator. Always "assistant.tool_call_delta".
+     */
+    type: "assistant.tool_call_delta";
+}
+/**
+ * Streaming tool-call input delta for incremental tool-call updates
+ */
+export interface AssistantToolCallDeltaData {
+    /**
+     * Raw provider tool input fragment to append for this tool call. Function/tool-use providers stream serialized JSON argument text (so newlines inside JSON string values may appear as escaped `\n` until the accumulated JSON is parsed); custom tool calls stream raw custom input.
+     */
+    inputDelta: string;
+    /**
+     * Tool call ID this delta belongs to, matching the corresponding assistant.message tool request
+     */
+    toolCallId: string;
+    /**
+     * Name of the tool being invoked, when known from the stream
+     */
+    toolName?: string;
+    toolType?: AssistantMessageToolRequestType;
+}
 /**
  * Session event "assistant.streaming_delta". Streaming response progress with cumulative byte count
  */
@@ -3411,6 +3517,10 @@ export interface AssistantTurnEndEvent {
  * Turn completion metadata including the turn identifier
  */
 export interface AssistantTurnEndData {
+    /**
+     * Model identifier used for this turn, when known
+     */
+    model?: string;
     /**
      * Identifier of the turn that has ended, matching the corresponding assistant.turn_start event
      */
@@ -3903,7 +4013,7 @@ export interface ToolExecutionStartToolDescriptionMeta {
     ui?: ToolExecutionStartToolDescriptionMetaUI;
 }
 /**
- * Schema for the `ToolExecutionStartToolDescriptionMetaUI` type.
+ * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`.
  */
 export interface ToolExecutionStartToolDescriptionMetaUI {
     /**
@@ -4396,7 +4506,7 @@ export interface ToolExecutionCompleteContentResource {
     type: "resource";
 }
 /**
- * Schema for the `EmbeddedTextResourceContents` type.
+ * Embedded text resource contents identified by a URI, with an optional MIME type and a text payload.
  */
 export interface EmbeddedTextResourceContents {
     /**
@@ -4413,7 +4523,7 @@ export interface EmbeddedTextResourceContents {
     uri: string;
 }
 /**
- * Schema for the `EmbeddedBlobResourceContents` type.
+ * Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob.
  */
 export interface EmbeddedBlobResourceContents {
     /**
@@ -4458,7 +4568,7 @@ export interface ToolExecutionCompleteUIResourceMeta {
     ui?: ToolExecutionCompleteUIResourceMetaUI;
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUI` type.
+ * MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference.
  */
 export interface ToolExecutionCompleteUIResourceMetaUI {
     csp?: ToolExecutionCompleteUIResourceMetaUICsp;
@@ -4467,7 +4577,7 @@ export interface ToolExecutionCompleteUIResourceMetaUI {
     prefersBorder?: boolean;
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type.
+ * CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains.
  */
 export interface ToolExecutionCompleteUIResourceMetaUICsp {
     baseUriDomains?: string[];
@@ -4476,7 +4586,7 @@ export interface ToolExecutionCompleteUIResourceMetaUICsp {
     resourceDomains?: string[];
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type.
+ * Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write.
  */
 export interface ToolExecutionCompleteUIResourceMetaUIPermissions {
     camera?: ToolExecutionCompleteUIResourceMetaUIPermissionsCamera;
@@ -4485,22 +4595,22 @@ export interface ToolExecutionCompleteUIResourceMetaUIPermissions {
     microphone?: ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone;
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type.
+ * Marker object for camera permission on an MCP Apps UI resource.
  */
 export interface ToolExecutionCompleteUIResourceMetaUIPermissionsCamera {
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type.
+ * Marker object for clipboard-write permission on an MCP Apps UI resource.
  */
 export interface ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite {
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type.
+ * Marker object for geolocation permission on an MCP Apps UI resource.
  */
 export interface ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation {
 }
 /**
- * Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type.
+ * Marker object for microphone permission on an MCP Apps UI resource.
  */
 export interface ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone {
 }
@@ -4525,7 +4635,7 @@ export interface ToolExecutionCompleteToolDescriptionMeta {
     ui?: ToolExecutionCompleteToolDescriptionMetaUI;
 }
 /**
- * Schema for the `ToolExecutionCompleteToolDescriptionMetaUI` type.
+ * MCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`.
  */
 export interface ToolExecutionCompleteToolDescriptionMetaUI {
     /**
@@ -4583,6 +4693,10 @@ export interface SkillInvokedData {
      * Description of the skill from its SKILL.md frontmatter
      */
     description?: string;
+    /**
+     * Model identifier active when the skill was invoked, when known
+     */
+    model?: string;
     /**
      * Name of the invoked skill
      */
@@ -5199,7 +5313,7 @@ export interface SystemNotificationData {
     kind: SystemNotification;
 }
 /**
- * Schema for the `SystemNotificationAgentCompleted` type.
+ * System notification metadata for a background agent that completed or failed, including agent ID, type, status, description, and prompt.
  */
 export interface SystemNotificationAgentCompleted {
     /**
@@ -5225,7 +5339,7 @@ export interface SystemNotificationAgentCompleted {
     type: "agent_completed";
 }
 /**
- * Schema for the `SystemNotificationAgentIdle` type.
+ * System notification metadata for a background agent that became idle, including agent ID, type, and description.
  */
 export interface SystemNotificationAgentIdle {
     /**
@@ -5246,7 +5360,7 @@ export interface SystemNotificationAgentIdle {
     type: "agent_idle";
 }
 /**
- * Schema for the `SystemNotificationNewInboxMessage` type.
+ * System notification metadata for a new inbox message, including entry ID, sender details, and summary.
  */
 export interface SystemNotificationNewInboxMessage {
     /**
@@ -5271,7 +5385,7 @@ export interface SystemNotificationNewInboxMessage {
     type: "new_inbox_message";
 }
 /**
- * Schema for the `SystemNotificationShellCompleted` type.
+ * System notification metadata for a shell session that completed, including shell ID, optional exit code, and description.
  */
 export interface SystemNotificationShellCompleted {
     /**
@@ -5292,7 +5406,7 @@ export interface SystemNotificationShellCompleted {
     type: "shell_completed";
 }
 /**
- * Schema for the `SystemNotificationShellDetachedCompleted` type.
+ * System notification metadata for a detached shell session that completed, including shell ID and description.
  */
 export interface SystemNotificationShellDetachedCompleted {
     /**
@@ -5309,7 +5423,7 @@ export interface SystemNotificationShellDetachedCompleted {
     type: "shell_detached_completed";
 }
 /**
- * Schema for the `SystemNotificationInstructionDiscovered` type.
+ * System notification metadata for an instruction file discovered during tool access, including source, trigger file, and tool.
  */
 export interface SystemNotificationInstructionDiscovered {
     /**
@@ -5432,7 +5546,7 @@ export interface PermissionRequestShell {
     warning?: string;
 }
 /**
- * Schema for the `PermissionRequestShellCommand` type.
+ * A parsed command identifier in a shell permission request, including whether it is read-only.
  */
 export interface PermissionRequestShellCommand {
     /**
@@ -5445,7 +5559,7 @@ export interface PermissionRequestShellCommand {
     readOnly: boolean;
 }
 /**
- * Schema for the `PermissionRequestShellPossibleUrl` type.
+ * A URL that may be accessed by a command in a shell permission request.
  */
 export interface PermissionRequestShellPossibleUrl {
     /**
@@ -5481,6 +5595,14 @@ export interface PermissionRequestWrite {
      * Complete new file contents for newly created files
      */
     newFileContents?: string;
+    /**
+     * True when a built-in file tool (apply_patch / str_replace_editor) asked to write a path the sandbox filesystem policy would block, and the host opted in via sandbox.allowBypass. This is a request, not a grant: the write happens unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI.
+     */
+    requestSandboxBypass?: boolean;
+    /**
+     * Justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true.
+     */
+    requestSandboxBypassReason?: string;
     /**
      * Tool call ID that triggered this permission request
      */
@@ -5562,6 +5684,14 @@ export interface PermissionRequestUrl {
      * Permission kind discriminator
      */
     kind: "url";
+    /**
+     * True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI.
+     */
+    requestSandboxBypass?: boolean;
+    /**
+     * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true.
+     */
+    requestSandboxBypassReason?: string;
     /**
      * Tool call ID that triggered this permission request
      */
@@ -5702,6 +5832,12 @@ export interface PermissionRequestExtensionPermissionAccess {
  * Shell command permission prompt
  */
 export interface PermissionPromptRequestCommands {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Whether the UI can offer session-wide approval for this command pattern
      */
@@ -5731,10 +5867,27 @@ export interface PermissionPromptRequestCommands {
      */
     warning?: string;
 }
+/**
+ * Auto-approval judge information attached to a permission request. Present (non-null) only when the session's allow-all mode is "auto"; its absence means auto mode was off and the judge did not evaluate the request. The `recommendation` conveys the judge's disposition for this request.
+ */
+/** @experimental */
+export interface PermissionAutoApproval {
+    /**
+     * Human-readable reason for the judge's recommendation, when available.
+     */
+    reason?: string;
+    recommendation: AutoApprovalRecommendation;
+}
 /**
  * File write permission prompt
  */
 export interface PermissionPromptRequestWrite {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Whether the UI can offer session-wide approval for file write operations
      */
@@ -5768,6 +5921,12 @@ export interface PermissionPromptRequestWrite {
  * File read permission prompt
  */
 export interface PermissionPromptRequestRead {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Human-readable description of why the file is being read
      */
@@ -5795,6 +5954,12 @@ export interface PermissionPromptRequestMcp {
     args?: {
         [k: string]: unknown | undefined;
     };
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Prompt kind discriminator
      */
@@ -5820,6 +5985,12 @@ export interface PermissionPromptRequestMcp {
  * URL access permission prompt
  */
 export interface PermissionPromptRequestUrl {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Human-readable description of why the URL is being accessed
      */
@@ -5828,6 +5999,14 @@ export interface PermissionPromptRequestUrl {
      * Prompt kind discriminator
      */
     kind: "url";
+    /**
+     * True when this URL fetch is requesting to bypass the sandbox network policy: either the model set requestSandboxBypass: true, or the tool re-issued the request as an interactive bypass after the network policy denied the approved URL (host opted in via sandbox.allowBypass). This is a request, not a grant: the fetch runs only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI.
+     */
+    requestSandboxBypass?: boolean;
+    /**
+     * Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true.
+     */
+    requestSandboxBypassReason?: string;
     /**
      * Tool call ID that triggered this permission request
      */
@@ -5842,6 +6021,12 @@ export interface PermissionPromptRequestUrl {
  */
 export interface PermissionPromptRequestMemory {
     action?: PermissionRequestMemoryAction;
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Source references for the stored fact (store only)
      */
@@ -5878,6 +6063,12 @@ export interface PermissionPromptRequestCustomTool {
     args?: {
         [k: string]: unknown | undefined;
     };
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Prompt kind discriminator
      */
@@ -5900,6 +6091,12 @@ export interface PermissionPromptRequestCustomTool {
  */
 export interface PermissionPromptRequestPath {
     accessKind: PermissionPromptRequestPathAccessKind;
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Prompt kind discriminator
      */
@@ -5917,6 +6114,12 @@ export interface PermissionPromptRequestPath {
  * Hook confirmation permission prompt
  */
 export interface PermissionPromptRequestHook {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Optional message from the hook explaining why confirmation is needed
      */
@@ -5944,6 +6147,12 @@ export interface PermissionPromptRequestHook {
  * Extension management permission prompt
  */
 export interface PermissionPromptRequestExtensionManagement {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Name of the extension being managed
      */
@@ -5965,6 +6174,12 @@ export interface PermissionPromptRequestExtensionManagement {
  * Extension permission access prompt
  */
 export interface PermissionPromptRequestExtensionPermissionAccess {
+    /**
+     * Auto-approval judge information for this request; present only when auto mode is enabled.
+     *
+     * @experimental
+     */
+    autoApproval?: PermissionAutoApproval;
     /**
      * Capabilities the extension is requesting
      */
@@ -6027,7 +6242,7 @@ export interface PermissionCompletedData {
     toolCallId?: string;
 }
 /**
- * Schema for the `PermissionApproved` type.
+ * Permission response variant indicating the request was approved without persisting an approval rule.
  */
 export interface PermissionApproved {
     /**
@@ -6036,7 +6251,7 @@ export interface PermissionApproved {
     kind: "approved";
 }
 /**
- * Schema for the `PermissionApprovedForSession` type.
+ * Permission response variant that approves a request and remembers the provided approval for the rest of the session.
  */
 export interface PermissionApprovedForSession {
     approval: UserToolSessionApproval;
@@ -6046,7 +6261,7 @@ export interface PermissionApprovedForSession {
     kind: "approved-for-session";
 }
 /**
- * Schema for the `UserToolSessionApprovalCommands` type.
+ * Session-scoped tool-approval rule for specific shell command identifiers.
  */
 export interface UserToolSessionApprovalCommands {
     /**
@@ -6059,7 +6274,7 @@ export interface UserToolSessionApprovalCommands {
     kind: "commands";
 }
 /**
- * Schema for the `UserToolSessionApprovalRead` type.
+ * Session-scoped tool-approval rule for read-only filesystem operations.
  */
 export interface UserToolSessionApprovalRead {
     /**
@@ -6068,7 +6283,7 @@ export interface UserToolSessionApprovalRead {
     kind: "read";
 }
 /**
- * Schema for the `UserToolSessionApprovalWrite` type.
+ * Session-scoped tool-approval rule for filesystem write operations.
  */
 export interface UserToolSessionApprovalWrite {
     /**
@@ -6077,7 +6292,7 @@ export interface UserToolSessionApprovalWrite {
     kind: "write";
 }
 /**
- * Schema for the `UserToolSessionApprovalMcp` type.
+ * Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when `toolName` is null.
  */
 export interface UserToolSessionApprovalMcp {
     /**
@@ -6094,7 +6309,7 @@ export interface UserToolSessionApprovalMcp {
     toolName: string | null;
 }
 /**
- * Schema for the `UserToolSessionApprovalMemory` type.
+ * Session-scoped tool-approval rule for writes to long-term memory.
  */
 export interface UserToolSessionApprovalMemory {
     /**
@@ -6103,7 +6318,7 @@ export interface UserToolSessionApprovalMemory {
     kind: "memory";
 }
 /**
- * Schema for the `UserToolSessionApprovalCustomTool` type.
+ * Session-scoped tool-approval rule for a custom tool, keyed by tool name.
  */
 export interface UserToolSessionApprovalCustomTool {
     /**
@@ -6116,7 +6331,7 @@ export interface UserToolSessionApprovalCustomTool {
     toolName: string;
 }
 /**
- * Schema for the `UserToolSessionApprovalExtensionManagement` type.
+ * Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation.
  */
 export interface UserToolSessionApprovalExtensionManagement {
     /**
@@ -6129,7 +6344,7 @@ export interface UserToolSessionApprovalExtensionManagement {
     operation?: string;
 }
 /**
- * Schema for the `UserToolSessionApprovalExtensionPermissionAccess` type.
+ * Session-scoped tool-approval rule for an extension's permission-gated capability access, keyed by extension name.
  */
 export interface UserToolSessionApprovalExtensionPermissionAccess {
     /**
@@ -6142,7 +6357,7 @@ export interface UserToolSessionApprovalExtensionPermissionAccess {
     kind: "extension-permission-access";
 }
 /**
- * Schema for the `PermissionApprovedForLocation` type.
+ * Permission response variant that approves a request and persists the provided approval to a project location key.
  */
 export interface PermissionApprovedForLocation {
     approval: UserToolSessionApproval;
@@ -6156,7 +6371,7 @@ export interface PermissionApprovedForLocation {
     locationKey: string;
 }
 /**
- * Schema for the `PermissionCancelled` type.
+ * Permission response variant indicating the request was cancelled before use, with an optional reason.
  */
 export interface PermissionCancelled {
     /**
@@ -6169,7 +6384,7 @@ export interface PermissionCancelled {
     reason?: string;
 }
 /**
- * Schema for the `PermissionDeniedByRules` type.
+ * Permission response variant denied because matching approval rules explicitly blocked the request.
  */
 export interface PermissionDeniedByRules {
     /**
@@ -6182,7 +6397,7 @@ export interface PermissionDeniedByRules {
     rules: PermissionRule[];
 }
 /**
- * Schema for the `PermissionRule` type.
+ * A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value.
  */
 export interface PermissionRule {
     /**
@@ -6195,7 +6410,7 @@ export interface PermissionRule {
     kind: string;
 }
 /**
- * Schema for the `PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser` type.
+ * Permission response variant denied because no approval rule matched and user confirmation was unavailable.
  */
 export interface PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser {
     /**
@@ -6204,7 +6419,7 @@ export interface PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser {
     kind: "denied-no-approval-rule-and-could-not-request-from-user";
 }
 /**
- * Schema for the `PermissionDeniedInteractivelyByUser` type.
+ * Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag.
  */
 export interface PermissionDeniedInteractivelyByUser {
     /**
@@ -6221,7 +6436,7 @@ export interface PermissionDeniedInteractivelyByUser {
     kind: "denied-interactively-by-user";
 }
 /**
- * Schema for the `PermissionDeniedByContentExclusionPolicy` type.
+ * Permission response variant denying a path under content exclusion policy, with the path and message.
  */
 export interface PermissionDeniedByContentExclusionPolicy {
     /**
@@ -6238,7 +6453,7 @@ export interface PermissionDeniedByContentExclusionPolicy {
     path: string;
 }
 /**
- * Schema for the `PermissionDeniedByPermissionRequestHook` type.
+ * Permission response variant denied by a permission-request hook, with optional message and interrupt flag.
  */
 export interface PermissionDeniedByPermissionRequestHook {
     /**
@@ -6479,7 +6694,7 @@ export interface ElicitationCompletedData {
     requestId: string;
 }
 /**
- * Schema for the `ElicitationCompletedContent` type.
+ * Opaque JSON value submitted for one field in accepted `elicitation.completed` form content.
  */
 export interface ElicitationCompletedContent {
     [k: string]: unknown | undefined;
@@ -7322,7 +7537,7 @@ export interface CommandsChangedData {
     commands: CommandsChangedCommand[];
 }
 /**
- * Schema for the `CommandsChangedCommand` type.
+ * A single slash command available in the session, as listed by the `commands.changed` event.
  */
 export interface CommandsChangedCommand {
     /**
@@ -7492,7 +7707,7 @@ export interface ExitPlanModeCompletedData {
     selectedAction?: ExitPlanModeAction;
 }
 /**
- * Session event "session.tools_updated".
+ * Session event "session.tools_updated". Payload of `session.tools_updated` identifying the model whose resolved tools were updated.
  */
 export interface ToolsUpdatedEvent {
     /**
@@ -7522,7 +7737,7 @@ export interface ToolsUpdatedEvent {
     type: "session.tools_updated";
 }
 /**
- * Schema for the `ToolsUpdatedData` type.
+ * Payload of `session.tools_updated` identifying the model whose resolved tools were updated.
  */
 export interface ToolsUpdatedData {
     /**
@@ -7531,7 +7746,7 @@ export interface ToolsUpdatedData {
     model: string;
 }
 /**
- * Session event "session.background_tasks_changed".
+ * Session event "session.background_tasks_changed". Empty payload for `session.background_tasks_changed`, indicating background task state changed.
  */
 export interface BackgroundTasksChangedEvent {
     /**
@@ -7561,12 +7776,12 @@ export interface BackgroundTasksChangedEvent {
     type: "session.background_tasks_changed";
 }
 /**
- * Schema for the `BackgroundTasksChangedData` type.
+ * Empty payload for `session.background_tasks_changed`, indicating background task state changed.
  */
 export interface BackgroundTasksChangedData {
 }
 /**
- * Session event "session.skills_loaded".
+ * Session event "session.skills_loaded". Payload of `session.skills_loaded` listing resolved skill metadata.
  */
 export interface SkillsLoadedEvent {
     /**
@@ -7596,7 +7811,7 @@ export interface SkillsLoadedEvent {
     type: "session.skills_loaded";
 }
 /**
- * Schema for the `SkillsLoadedData` type.
+ * Payload of `session.skills_loaded` listing resolved skill metadata.
  */
 export interface SkillsLoadedData {
     /**
@@ -7605,7 +7820,7 @@ export interface SkillsLoadedData {
     skills: SkillsLoadedSkill[];
 }
 /**
- * Schema for the `SkillsLoadedSkill` type.
+ * A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint.
  */
 export interface SkillsLoadedSkill {
     /**
@@ -7635,7 +7850,7 @@ export interface SkillsLoadedSkill {
     userInvocable: boolean;
 }
 /**
- * Session event "session.custom_agents_updated".
+ * Session event "session.custom_agents_updated". Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors.
  */
 export interface CustomAgentsUpdatedEvent {
     /**
@@ -7665,7 +7880,7 @@ export interface CustomAgentsUpdatedEvent {
     type: "session.custom_agents_updated";
 }
 /**
- * Schema for the `CustomAgentsUpdatedData` type.
+ * Payload of `session.custom_agents_updated` with loaded custom agents plus non-fatal warnings and fatal errors.
  */
 export interface CustomAgentsUpdatedData {
     /**
@@ -7682,7 +7897,7 @@ export interface CustomAgentsUpdatedData {
     warnings: string[];
 }
 /**
- * Schema for the `CustomAgentsUpdatedAgent` type.
+ * A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and model override.
  */
 export interface CustomAgentsUpdatedAgent {
     /**
@@ -7719,7 +7934,7 @@ export interface CustomAgentsUpdatedAgent {
     userInvocable: boolean;
 }
 /**
- * Session event "session.mcp_servers_loaded".
+ * Session event "session.mcp_servers_loaded". Payload of `session.mcp_servers_loaded` listing MCP server status summaries.
  */
 export interface McpServersLoadedEvent {
     /**
@@ -7749,7 +7964,7 @@ export interface McpServersLoadedEvent {
     type: "session.mcp_servers_loaded";
 }
 /**
- * Schema for the `McpServersLoadedData` type.
+ * Payload of `session.mcp_servers_loaded` listing MCP server status summaries.
  */
 export interface McpServersLoadedData {
     /**
@@ -7758,7 +7973,7 @@ export interface McpServersLoadedData {
     servers: McpServersLoadedServer[];
 }
 /**
- * Schema for the `McpServersLoadedServer` type.
+ * A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata.
  */
 export interface McpServersLoadedServer {
     /**
@@ -7782,7 +7997,7 @@ export interface McpServersLoadedServer {
     transport?: McpServerTransport;
 }
 /**
- * Session event "session.mcp_server_status_changed".
+ * Session event "session.mcp_server_status_changed". Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error.
  */
 export interface McpServerStatusChangedEvent {
     /**
@@ -7812,7 +8027,7 @@ export interface McpServerStatusChangedEvent {
     type: "session.mcp_server_status_changed";
 }
 /**
- * Schema for the `McpServerStatusChangedData` type.
+ * Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error.
  */
 export interface McpServerStatusChangedData {
     /**
@@ -7826,7 +8041,7 @@ export interface McpServerStatusChangedData {
     status: McpServerStatus;
 }
 /**
- * Session event "session.extensions_loaded".
+ * Session event "session.extensions_loaded". Payload of `session.extensions_loaded` listing discovered extensions and their statuses.
  */
 export interface ExtensionsLoadedEvent {
     /**
@@ -7856,7 +8071,7 @@ export interface ExtensionsLoadedEvent {
     type: "session.extensions_loaded";
 }
 /**
- * Schema for the `ExtensionsLoadedData` type.
+ * Payload of `session.extensions_loaded` listing discovered extensions and their statuses.
  */
 export interface ExtensionsLoadedData {
     /**
@@ -7865,7 +8080,7 @@ export interface ExtensionsLoadedData {
     extensions: ExtensionsLoadedExtension[];
 }
 /**
- * Schema for the `ExtensionsLoadedExtension` type.
+ * A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status.
  */
 export interface ExtensionsLoadedExtension {
     /**
@@ -7880,7 +8095,7 @@ export interface ExtensionsLoadedExtension {
     status: ExtensionsLoadedExtensionStatus;
 }
 /**
- * Session event "session.canvas.opened".
+ * Session event "session.canvas.opened". Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional title, status, URL, and input.
  */
 /** @experimental */
 export interface CanvasOpenedEvent {
@@ -7911,7 +8126,7 @@ export interface CanvasOpenedEvent {
     type: "session.canvas.opened";
 }
 /**
- * Schema for the `CanvasOpenedData` type.
+ * Payload of `session.canvas.opened` with canvas instance and provider IDs plus optional title, status, URL, and input.
  */
 /** @experimental */
 export interface CanvasOpenedData {
@@ -7951,7 +8166,7 @@ export interface CanvasOpenedData {
     url?: string;
 }
 /**
- * Session event "session.canvas.registry_changed".
+ * Session event "session.canvas.registry_changed". Payload of `session.canvas.registry_changed` listing the canvas declarations currently available.
  */
 /** @experimental */
 export interface CanvasRegistryChangedEvent {
@@ -7982,7 +8197,7 @@ export interface CanvasRegistryChangedEvent {
     type: "session.canvas.registry_changed";
 }
 /**
- * Schema for the `CanvasRegistryChangedData` type.
+ * Payload of `session.canvas.registry_changed` listing the canvas declarations currently available.
  */
 /** @experimental */
 export interface CanvasRegistryChangedData {
@@ -7992,7 +8207,7 @@ export interface CanvasRegistryChangedData {
     canvases: CanvasRegistryChangedCanvas[];
 }
 /**
- * Schema for the `CanvasRegistryChangedCanvas` type.
+ * A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions.
  */
 /** @experimental */
 export interface CanvasRegistryChangedCanvas {
@@ -8028,7 +8243,7 @@ export interface CanvasRegistryChangedCanvas {
     };
 }
 /**
- * Schema for the `CanvasRegistryChangedCanvasAction` type.
+ * A single action within a canvas declaration, with its name, optional description, and optional input schema.
  */
 /** @experimental */
 export interface CanvasRegistryChangedCanvasAction {
@@ -8048,7 +8263,7 @@ export interface CanvasRegistryChangedCanvasAction {
     name: string;
 }
 /**
- * Session event "session.canvas.closed".
+ * Session event "session.canvas.closed". Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID.
  */
 /** @experimental */
 export interface CanvasClosedEvent {
@@ -8079,7 +8294,7 @@ export interface CanvasClosedEvent {
     type: "session.canvas.closed";
 }
 /**
- * Schema for the `CanvasClosedData` type.
+ * Payload of `session.canvas.closed` with the closed canvas instance ID, provider ID, and canvas ID.
  */
 /** @experimental */
 export interface CanvasClosedData {
@@ -8254,7 +8469,7 @@ export interface CanvasRemovedData {
     instanceId: string;
 }
 /**
- * Session event "session.extensions.attachments_pushed".
+ * Session event "session.extensions.attachments_pushed". Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send.
  */
 export interface ExtensionsAttachmentsPushedEvent {
     /**
@@ -8284,7 +8499,7 @@ export interface ExtensionsAttachmentsPushedEvent {
     type: "session.extensions.attachments_pushed";
 }
 /**
- * Schema for the `ExtensionsAttachmentsPushedData` type.
+ * Payload of `session.extensions.attachments_pushed` with extension-contributed attachments for the next send.
  */
 export interface ExtensionsAttachmentsPushedData {
     /**
@@ -8373,7 +8588,7 @@ export interface McpAppToolCallCompleteToolMeta {
     ui?: McpAppToolCallCompleteToolMetaUI;
 }
 /**
- * Schema for the `McpAppToolCallCompleteToolMetaUI` type.
+ * MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result.
  */
 export interface McpAppToolCallCompleteToolMetaUI {
     /**