@github/copilot-sdk-darwin-x64 1.0.13-preview.6 → 1.0.13

package/schemas/session-events.schema.json

@@ -3434,6 +3434,111 @@
         "intelligence": "Optimize for intelligence."
       }
     },
+    "AutoTierSwitchFailedData": {
+      "type": "object",
+      "properties": {
+        "effectiveAutoTier": {
+          "$ref": "#/definitions/AutoTier",
+          "description": "Auto preference that remains effective after the failed request."
+        },
+        "requestedAutoTier": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/AutoTier",
+              "description": "Routing preference used when the session model is `auto`."
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Auto preference that failed to activate, or null when returning to provider-default routing failed."
+        },
+        "reason": {
+          "$ref": "#/definitions/AutoTierSwitchFailureReason",
+          "description": "Low-cardinality failure outcome reported by Auto resolution."
+        }
+      },
+      "required": [
+        "requestedAutoTier",
+        "reason"
+      ],
+      "additionalProperties": false,
+      "description": "A transient Auto preference failure emitted when the runtime cannot mint or accept a usable model and token pair. The previously effective preference remains active, so SDK clients can surface a non-blocking failure without changing their committed-tier state. This event is ephemeral and is not persisted or replayed on resume.",
+      "title": "AutoTierSwitchFailedData"
+    },
+    "AutoTierSwitchFailedEvent": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Unique event identifier (UUID v4), generated when the event is emitted"
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the event was created"
+        },
+        "parentId": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "uuid"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event."
+        },
+        "ephemeral": {
+          "type": "boolean",
+          "const": true,
+          "description": "Always true for events that are transient and not persisted to the session event log on disk."
+        },
+        "agentId": {
+          "type": "string",
+          "description": "Sub-agent instance identifier. Absent for events from the root/main agent and session-level events."
+        },
+        "type": {
+          "type": "string",
+          "const": "session.auto_tier_switch_failed",
+          "description": "Type discriminator. Always \"session.auto_tier_switch_failed\"."
+        },
+        "data": {
+          "$ref": "#/definitions/AutoTierSwitchFailedData",
+          "description": "A transient Auto preference failure emitted when the runtime cannot mint or accept a usable model and token pair. The previously effective preference remains active, so SDK clients can surface a non-blocking failure without changing their committed-tier state. This event is ephemeral and is not persisted or replayed on resume."
+        }
+      },
+      "required": [
+        "id",
+        "timestamp",
+        "parentId",
+        "ephemeral",
+        "type",
+        "data"
+      ],
+      "additionalProperties": false,
+      "description": "Session event \"session.auto_tier_switch_failed\". A transient Auto preference failure emitted when the runtime cannot mint or accept a usable model and token pair. The previously effective preference remains active, so SDK clients can surface a non-blocking failure without changing their committed-tier state. This event is ephemeral and is not persisted or replayed on resume.",
+      "title": "AutoTierSwitchFailedEvent"
+    },
+    "AutoTierSwitchFailureReason": {
+      "type": "string",
+      "enum": [
+        "policy_rejected",
+        "request_failed",
+        "setup_failed",
+        "unsupported"
+      ],
+      "description": "Terminal reason an Auto preference activation failed.",
+      "title": "AutoTierSwitchFailureReason",
+      "x-enumDescriptions": {
+        "policy_rejected": "The candidate model was rejected by model policy.",
+        "request_failed": "The Auto routing request failed or returned an unusable response.",
+        "setup_failed": "The runtime could not prepare the Auto routing request.",
+        "unsupported": "The provider does not support Auto routing."
+      }
+    },
     "BackgroundTasksChangedData": {
       "type": "object",
       "properties": {},
@@ -6245,6 +6350,10 @@
           "type": "string",
           "description": "Human-readable error message"
         },
+        "remediation": {
+          "$ref": "#/definitions/RemediationAction",
+          "description": "What the user must do to recover, when the runtime knows of an action. The `message` never names a client affordance, so a client that offers one — a slash command, a settings pane, a link — renders it from this value."
+        },
         "stack": {
           "type": "string",
           "description": "Error stack trace, when available"
@@ -10234,6 +10343,166 @@
       "description": "Session event \"mcp.resources.list_changed\". Payload identifying the MCP server associated with a list change.",
       "title": "McpResourcesListChangedEvent"
     },
+    "McpServerMetadata": {
+      "type": "object",
+      "properties": {
+        "instructions": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Non-empty natural-language guidance for using the server, or null when the server omitted instructions or advertised an empty string."
+        }
+      },
+      "required": [
+        "instructions"
+      ],
+      "additionalProperties": false,
+      "description": "Server-advertised metadata learned through modern discovery or legacy initialization.",
+      "title": "McpServerMetadata"
+    },
+    "McpServerNeedsReconnectData": {
+      "type": "object",
+      "properties": {
+        "serverName": {
+          "type": "string",
+          "description": "Name of the MCP server that needs to reconnect"
+        }
+      },
+      "required": [
+        "serverName"
+      ],
+      "additionalProperties": false,
+      "description": "Payload of `session.mcp_server_needs_reconnect` identifying an MCP server whose connection must be re-established.",
+      "title": "McpServerNeedsReconnectData"
+    },
+    "McpServerNeedsReconnectEvent": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Unique event identifier (UUID v4), generated when the event is emitted"
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the event was created"
+        },
+        "parentId": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "uuid"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event."
+        },
+        "ephemeral": {
+          "type": "boolean",
+          "const": true,
+          "description": "Always true for events that are transient and not persisted to the session event log on disk."
+        },
+        "agentId": {
+          "type": "string",
+          "description": "Sub-agent instance identifier. Absent for events from the root/main agent and session-level events."
+        },
+        "type": {
+          "type": "string",
+          "const": "session.mcp_server_needs_reconnect",
+          "description": "Type discriminator. Always \"session.mcp_server_needs_reconnect\"."
+        },
+        "data": {
+          "$ref": "#/definitions/McpServerNeedsReconnectData",
+          "description": "Payload of `session.mcp_server_needs_reconnect` identifying an MCP server whose connection must be re-established."
+        }
+      },
+      "required": [
+        "id",
+        "timestamp",
+        "parentId",
+        "ephemeral",
+        "type",
+        "data"
+      ],
+      "additionalProperties": false,
+      "description": "Session event \"session.mcp_server_needs_reconnect\". Payload of `session.mcp_server_needs_reconnect` identifying an MCP server whose connection must be re-established.",
+      "title": "McpServerNeedsReconnectEvent"
+    },
+    "McpServerRemovedData": {
+      "type": "object",
+      "properties": {
+        "serverName": {
+          "type": "string",
+          "description": "Name of the MCP server that was removed from the graph"
+        }
+      },
+      "required": [
+        "serverName"
+      ],
+      "additionalProperties": false,
+      "description": "Payload of `session.mcp_server_removed` identifying an MCP server the graph no longer runs.",
+      "title": "McpServerRemovedData"
+    },
+    "McpServerRemovedEvent": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Unique event identifier (UUID v4), generated when the event is emitted"
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 timestamp when the event was created"
+        },
+        "parentId": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "uuid"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event."
+        },
+        "ephemeral": {
+          "type": "boolean",
+          "const": true,
+          "description": "Always true for events that are transient and not persisted to the session event log on disk."
+        },
+        "agentId": {
+          "type": "string",
+          "description": "Sub-agent instance identifier. Absent for events from the root/main agent and session-level events."
+        },
+        "type": {
+          "type": "string",
+          "const": "session.mcp_server_removed",
+          "description": "Type discriminator. Always \"session.mcp_server_removed\"."
+        },
+        "data": {
+          "$ref": "#/definitions/McpServerRemovedData",
+          "description": "Payload of `session.mcp_server_removed` identifying an MCP server the graph no longer runs."
+        }
+      },
+      "required": [
+        "id",
+        "timestamp",
+        "parentId",
+        "ephemeral",
+        "type",
+        "data"
+      ],
+      "additionalProperties": false,
+      "description": "Session event \"session.mcp_server_removed\". Payload of `session.mcp_server_removed` identifying an MCP server the graph no longer runs.",
+      "title": "McpServerRemovedEvent"
+    },
     "McpServersLoadedData": {
       "type": "object",
       "properties": {
@@ -10328,6 +10597,10 @@
           "type": "string",
           "description": "Error message if the server failed to connect"
         },
+        "serverMetadata": {
+          "$ref": "#/definitions/McpServerMetadata",
+          "description": "Server-advertised metadata for a connected server. Omitted when no live connection metadata is available, including while pending or when failed, disabled, stopped, or not configured."
+        },
         "transport": {
           "$ref": "#/definitions/McpServerTransport",
           "description": "Transport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server)"
@@ -11221,6 +11494,22 @@
         "source": {
           "$ref": "#/definitions/ModelChangeSource",
           "description": "Origin of the effective model change, when known."
+        },
+        "previousAutoTier": {
+          "$ref": "#/definitions/AutoTier",
+          "description": "Previously committed Auto preference, when one was explicitly selected."
+        },
+        "autoTier": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/AutoTier",
+              "description": "Routing preference used when the session model is `auto`."
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Committed Auto preference after the model configuration change, when applicable."
         }
       },
       "required": [
@@ -12474,11 +12763,11 @@
         },
         "requestSandboxBypass": {
           "type": "boolean",
-          "description": "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."
+          "description": "True when the tool is asking to run this URL fetch outside the sandbox, after the network policy denied the approved URL or the sandbox proxy could not reach it (host opted in via sandbox.allowBypass). The model cannot ask for this; only the tool raises it. 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."
         },
         "requestSandboxBypassReason": {
           "type": "string",
-          "description": "Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true."
+          "description": "What the tool tells the user about the bypass on offer: which policy rule blocked the call, or why it cannot be sandboxed. Only meaningful when requestSandboxBypass is true."
         },
         "assistedApproval": {
           "$ref": "#/definitions/PermissionAssistedApproval",
@@ -13138,11 +13427,11 @@
         },
         "requestSandboxBypass": {
           "type": "boolean",
-          "description": "True when the model has requested to run this search outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI."
+          "description": "True when the tool is asking to re-run this search outside the sandbox, after a sandboxed run looked blocked (host opted in via sandbox.allowBypass). The model cannot ask for this; only the tool raises it. This is a request, not a grant: the search runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI."
         },
         "requestSandboxBypassReason": {
           "type": "string",
-          "description": "Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true."
+          "description": "What the tool tells the user about the bypass on offer: which policy rule blocked the call, or why it cannot be sandboxed. Only meaningful when requestSandboxBypass is true."
         }
       },
       "required": [
@@ -13223,11 +13512,11 @@
         },
         "requestSandboxBypass": {
           "type": "boolean",
-          "description": "True when the model has requested to run this command outside the sandbox (it set requestSandboxBypass: true and the host opted in via sandbox.allowBypass). This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI."
+          "description": "True when the tool is asking to run this command outside the sandbox, either because the command detaches and cannot be sandboxed at all, or because a sandboxed run looked blocked (host opted in via sandbox.allowBypass). The model cannot ask for this; only the tool raises it. This is a request, not a grant: the command runs unsandboxed only if the user approves this permission request. Hosts should highlight the elevated risk in the approval UI."
         },
         "requestSandboxBypassReason": {
           "type": "string",
-          "description": "Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true."
+          "description": "What the tool tells the user about the bypass on offer: which policy rule blocked the call, or why it cannot be sandboxed. Only meaningful when requestSandboxBypass is true."
         }
       },
       "required": [
@@ -13329,11 +13618,11 @@
         },
         "requestSandboxBypass": {
           "type": "boolean",
-          "description": "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."
+          "description": "True when the tool is asking to run this URL fetch outside the sandbox, after the network policy denied the approved URL or the sandbox proxy could not reach it (host opted in via sandbox.allowBypass). The model cannot ask for this; only the tool raises it. 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."
         },
         "requestSandboxBypassReason": {
           "type": "string",
-          "description": "Model-provided justification for the sandbox-bypass request. Only meaningful when requestSandboxBypass is true."
+          "description": "What the tool tells the user about the bypass on offer: which policy rule blocked the call, or why it cannot be sandboxed. Only meaningful when requestSandboxBypass is true."
         }
       },
       "required": [
@@ -13945,6 +14234,25 @@
         "detailed": "Request a detailed summary of the model's reasoning."
       }
     },
+    "RemediationAction": {
+      "type": "string",
+      "enum": [
+        "sign_in",
+        "switch_account",
+        "show_account",
+        "review_sandbox_policy",
+        "allow_sandbox_outbound"
+      ],
+      "description": "What the user must do to recover from a failure, named as an action rather than as one client's affordance. The runtime cannot know which affordance a client offers — a slash command, a settings pane, a link — so the accompanying message stays host-agnostic and each client renders its own copy from this value. Absent when the runtime knows of no action the user can take.",
+      "title": "RemediationAction",
+      "x-enumDescriptions": {
+        "sign_in": "Authenticate again with the Copilot backend. The current credential is absent, expired, or rejected.",
+        "switch_account": "Authenticate as a different account. The current account exists but lacks access to the requested resource.",
+        "show_account": "Inspect which account is currently authenticated before deciding what to change.",
+        "review_sandbox_policy": "Review or widen the sandbox policy. The blocked path or host is named by the accompanying message or by the tool result the action arrived with.",
+        "allow_sandbox_outbound": "Permit outbound network access in the sandbox policy."
+      }
+    },
     "RemoteSteerableChangedData": {
       "type": "object",
       "properties": {
@@ -14351,9 +14659,9 @@
       "description": "Where a request to run outside the process sandbox originated. Orthogonal to the outcome: the same verdict means a different thing depending on where the request came from.",
       "title": "SandboxBypassSource",
       "x-enumDescriptions": {
-        "model_requested": "The request originated in the tool call itself. Says nothing about whether a person saw it: the ordinary pre-execution permission prompt discloses the bypass and may have gated this one.",
-        "user_prompted": "The runtime raised its own escalation prompt after a sandboxed command looked blocked, and a person answered it.",
-        "prompt_unavailable": "The runtime attempted its own escalation after a sandboxed command looked blocked, but the permission flow produced no confirmed human answer. This includes unavailable or unreadable prompts, cancellation, and automated rule, hook, or content-exclusion denials."
+        "model_requested": "No longer produced. The model could once ask for a bypass in the tool call itself; no tool exposes that parameter now. Retained so historical events still deserialize.",
+        "user_prompted": "The runtime raised the prompt itself — either after a sandboxed attempt looked blocked, or before a run the sandbox cannot enforce at all, such as a detached command — and a person answered it. In the second case nothing had executed when the decision was made.",
+        "prompt_unavailable": "The runtime raised the prompt itself — after a sandboxed attempt looked blocked, or before a run it cannot enforce — but the permission flow produced no confirmed human answer. This includes unavailable or unreadable prompts, cancellation, and automated rule, hook, or content-exclusion denials."
       }
     },
     "SandboxControl": {
@@ -15276,6 +15584,10 @@
           "$ref": "#/definitions/ModelChangeEvent",
           "description": "Session event \"session.model_change\". Model change details including previous and new model identifiers"
         },
+        {
+          "$ref": "#/definitions/AutoTierSwitchFailedEvent",
+          "description": "Session event \"session.auto_tier_switch_failed\". A transient Auto preference failure emitted when the runtime cannot mint or accept a usable model and token pair. The previously effective preference remains active, so SDK clients can surface a non-blocking failure without changing their committed-tier state. This event is ephemeral and is not persisted or replayed on resume."
+        },
         {
           "$ref": "#/definitions/ModeChangedEvent",
           "description": "Session event \"session.mode_changed\". Agent mode change details including previous and new modes"
@@ -15728,6 +16040,14 @@
           "$ref": "#/definitions/McpServerStatusChangedEvent",
           "description": "Session event \"session.mcp_server_status_changed\". Payload of `session.mcp_server_status_changed` for one MCP server's status and optional failure error."
         },
+        {
+          "$ref": "#/definitions/McpServerRemovedEvent",
+          "description": "Session event \"session.mcp_server_removed\". Payload of `session.mcp_server_removed` identifying an MCP server the graph no longer runs."
+        },
+        {
+          "$ref": "#/definitions/McpServerNeedsReconnectEvent",
+          "description": "Session event \"session.mcp_server_needs_reconnect\". Payload of `session.mcp_server_needs_reconnect` identifying an MCP server whose connection must be re-established."
+        },
         {
           "$ref": "#/definitions/McpToolsListChangedEvent",
           "description": "Session event \"mcp.tools.list_changed\". Payload identifying the MCP server associated with a list change."
@@ -18723,6 +19043,10 @@
         "code": {
           "type": "string",
           "description": "Machine-readable error code"
+        },
+        "remediation": {
+          "$ref": "#/definitions/RemediationAction",
+          "description": "What the user must do to recover, when the runtime knows of an action. Set on sandbox policy denials, where `message` names the rule that blocked the call but never the client affordance that relaxes it."
         }
       },
       "required": [
@@ -20720,6 +21044,10 @@
         "url": {
           "type": "string",
           "description": "Optional URL associated with this warning that the user can open in a browser"
+        },
+        "remediation": {
+          "$ref": "#/definitions/RemediationAction",
+          "description": "What the user must do to recover, when the runtime knows of an action. The `message` never names a client affordance, so a client that offers one — a slash command, a settings pane, a link — renders it from this value."
         }
       },
       "required": [