Module session_events 

Session event payload types — auto-generated from the protocol schema. Session event payload types — auto-generated from the session-events.schema.json protocol schema.

This is the stable public access point for the generated event types. The underlying crate-private module where the types are defined is an implementation detail whose layout may change.

Structs

AbortData

Session event “abort”. Turn abort information including the reason for termination

AssistantIdleData

Session event “assistant.idle”. Payload emitted whenever the main agent’s processing loop goes idle, including while related background work (running agents or in-flight attached shell commands) is still pending and the session-level idle event is therefore deferred

AssistantIntentData

Session event “assistant.intent”. Agent intent description for current activity or plan

AssistantMessageData

Session event “assistant.message”. Assistant response containing text content, optional tool requests, and interaction metadata

AssistantMessageDeltaData

Session event “assistant.message_delta”. Streaming assistant message delta for incremental response updates

AssistantMessageServerTools

Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping

AssistantMessageStartData

Session event “assistant.message_start”. Streaming assistant message start metadata

AssistantMessageToolRequest

A tool invocation request from the assistant

AssistantReasoningData

Session event “assistant.reasoning”. Assistant reasoning content for timeline display with complete thinking text

AssistantReasoningDeltaData

Session event “assistant.reasoning_delta”. Streaming reasoning delta for incremental extended thinking updates

AssistantStreamingDeltaData

Session event “assistant.streaming_delta”. Streaming response progress with cumulative byte count

AssistantToolCallDeltaData

Session event “assistant.tool_call_delta”. Streaming tool-call input delta for incremental tool-call updates

AssistantTurnEndData

Session event “assistant.turn_end”. Turn completion metadata including the turn identifier

AssistantTurnStartData

Session event “assistant.turn_start”. Turn initialization metadata including identifier and interaction tracking

AssistantUsageCopilotUsage

Per-request cost and usage data from the CAPI copilot_usage response field

AssistantUsageCopilotUsageTokenDetail

Token usage detail for a single billing category

AssistantUsageData

Session event “assistant.usage”. LLM API call usage metrics including tokens, costs, quotas, and billing information

AutoModeSwitchCompletedData

Session event “auto_mode_switch.completed”. Auto mode switch completion notification

AutoModeSwitchRequestedData

Session event “auto_mode_switch.requested”. Auto mode switch request notification requiring user approval

CanvasRegistryChangedCanvas

A single canvas declaration in session.canvas.registry_changed, including provider IDs, display metadata, input schema, and actions.

CanvasRegistryChangedCanvasAction

A single action within a canvas declaration, with its name, optional description, and optional input schema.

CapabilitiesChangedData

Session event “capabilities.changed”. Session capability change notification

CapabilitiesChangedUI

UI capability changes

CitableSource

A source supplied by a tool that should be made available to the model as citable content.

CitationReference

A single citation occurrence linking a span of generated text to a supporting source.

CitationSource

A source that backs one or more cited spans in the assistant’s response.

CitationSpan

A contiguous span of generated assistant text and the source references that support it.

Citations

Provider-agnostic citations linking spans of the assistant’s response to their supporting sources.

CommandCompletedData

Session event “command.completed”. Queued command completion notification signaling UI dismissal

CommandExecuteData

Session event “command.execute”. Registered command dispatch request routed to the owning client

CommandQueuedData

Session event “command.queued”. Queued slash command dispatch request for client execution

CommandsChangedCommand

A single slash command available in the session, as listed by the commands.changed event.

CommandsChangedData

Session event “commands.changed”. SDK command registration change notification

CompactionCompleteCompactionTokensUsed

Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)

CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail

Token usage detail for a single billing category

CustomAgentsUpdatedAgent

A single loaded custom agent in session.custom_agents_updated, with identity, source, tools, invocability, and model override.

ElicitationCompletedData

Session event “elicitation.completed”. Elicitation request completion with the user’s response

ElicitationRequestedData

Session event “elicitation.requested”. Elicitation request; may be form-based (structured input) or URL-based (browser redirect)

ElicitationRequestedSchema

JSON Schema describing the form fields to present to the user (form mode only)

EmbeddedBlobResourceContents

Embedded binary resource contents identified by a URI, with an optional MIME type and a base64-encoded blob.

EmbeddedTextResourceContents

Embedded text resource contents identified by a URI, with an optional MIME type and a text payload.

ExitPlanModeCompletedData

Session event “exit_plan_mode.completed”. Plan mode exit completion with the user’s approval decision and optional feedback

ExitPlanModeRequestedData

Session event “exit_plan_mode.requested”. Plan approval request with plan content and available user actions

ExtensionsLoadedExtension

A single extension discovered by session.extensions_loaded, including qualified ID, source, and current status.

ExternalToolCompletedData

Session event “external_tool.completed”. External tool completion notification signaling UI dismissal

ExternalToolRequestedData

Session event “external_tool.requested”. External tool invocation request for client-side tool execution

HandoffRepository

Repository context for the handed-off session

HookEndData

Session event “hook.end”. Hook invocation completion details including output, success status, and error information

HookEndError

Error details when the hook failed

HookProgressData

Session event “hook.progress”. Ephemeral progress update from a running hook process

HookStartData

Session event “hook.start”. Hook invocation start details including type and input data

McpAppToolCallCompleteData

Session event “mcp_app.tool_call_complete”. MCP App view called a tool on a connected MCP server (SEP-1865)

McpAppToolCallCompleteError

Set when the underlying tools/call threw an error before returning a CallToolResult

McpAppToolCallCompleteToolMeta

The tool’s _meta.ui block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools.

McpAppToolCallCompleteToolMetaUI

MCP App tool _meta.ui resource URI and SEP-1865 visibility captured with an mcp_app.tool_call_complete result.

McpHeadersRefreshCompletedData

Session event “mcp.headers_refresh_completed”. MCP headers refresh request completion notification

McpHeadersRefreshRequiredData

Session event “mcp.headers_refresh_required”. Dynamic headers refresh request for a remote MCP server

McpOauthCompletedData

Session event “mcp.oauth_completed”. MCP OAuth request completion notification

McpOauthRequiredData

Session event “mcp.oauth_required”. OAuth authentication request for an MCP server

McpOauthRequiredStaticClientConfig

Static OAuth client configuration, if the server specifies one

McpOauthWWWAuthenticateParams

OAuth WWW-Authenticate parameters parsed from an MCP auth challenge

McpServersLoadedServer

A single MCP server status summary in session.mcp_servers_loaded, including name, status, source, transport, and plugin metadata.

ModelCallFailureData

Session event “model.call_failure”. Failed LLM API call metadata for telemetry

ModelCallFailureRequestFingerprint

Content-free structural summary of the failing request for diagnosing malformed 4xx calls

PendingMessagesModifiedData

Session event “pending_messages.modified”. Empty payload; the event signals that the pending message queue has changed

PermissionApproved

Permission response variant indicating the request was approved without persisting an approval rule.

PermissionApprovedForLocation

Permission response variant that approves a request and persists the provided approval to a project location key.

PermissionApprovedForSession

Permission response variant that approves a request and remembers the provided approval for the rest of the session.

PermissionAutoApproval

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.

PermissionCancelled

Permission response variant indicating the request was cancelled before use, with an optional reason.

PermissionCompletedData

Session event “permission.completed”. Permission request completion notification signaling UI dismissal

PermissionDeniedByContentExclusionPolicy

Permission response variant denying a path under content exclusion policy, with the path and message.

PermissionDeniedByPermissionRequestHook

Permission response variant denied by a permission-request hook, with optional message and interrupt flag.

PermissionDeniedByRules

Permission response variant denied because matching approval rules explicitly blocked the request.

PermissionDeniedInteractivelyByUser

Permission response variant denied in an interactive user prompt, with optional feedback and force-reject flag.

PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser

Permission response variant denied because no approval rule matched and user confirmation was unavailable.

PermissionPromptRequestCommands

Shell command permission prompt

PermissionPromptRequestCustomTool

Custom tool invocation permission prompt

PermissionPromptRequestExtensionManagement

Extension management permission prompt

PermissionPromptRequestExtensionPermissionAccess

Extension permission access prompt

PermissionPromptRequestHook

Hook confirmation permission prompt

PermissionPromptRequestMcp

MCP tool invocation permission prompt

PermissionPromptRequestMemory

Memory operation permission prompt

PermissionPromptRequestPath

Path access permission prompt

PermissionPromptRequestRead

File read permission prompt

PermissionPromptRequestUrl

URL access permission prompt

PermissionPromptRequestWrite

File write permission prompt

PermissionRequestCustomTool

Custom tool invocation permission request

PermissionRequestExtensionManagement

Extension management permission request

PermissionRequestExtensionPermissionAccess

Extension permission access request

PermissionRequestHook

Hook confirmation permission request

PermissionRequestMcp

MCP tool invocation permission request

PermissionRequestMemory

Memory operation permission request

PermissionRequestRead

File or directory read permission request

PermissionRequestShell

Shell command permission request

PermissionRequestShellCommand

A parsed command identifier in a shell permission request, including whether it is read-only.

PermissionRequestShellPossibleUrl

A URL that may be accessed by a command in a shell permission request.

PermissionRequestUrl

URL access permission request

PermissionRequestWrite

File write permission request

PermissionRequestedData

Session event “permission.requested”. Permission request notification requiring client approval with request details

PermissionRule

A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value.

SamplingCompletedData

Session event “sampling.completed”. Sampling request completion notification signaling UI dismissal

SamplingRequestedData

Session event “sampling.requested”. Sampling request from an MCP server; contains the server name and a requestId for correlation

SessionAutoModeResolvedData

Session event “session.auto_mode_resolved”. Auto Intent resolution: the concrete model the session settled on for the first prompt of an auto-mode session, and why. Lets SDK clients render the chosen model and the full reason it was picked. The core selection fields (chosenModel/reasoningBucket/categoryScores) are stable; the routing-analytics fields (predictedLabel/confidence/candidateModels) mirror the upstream intent service and may evolve, hence the event’s experimental stability.

SessionAutopilotObjectiveChangedData

Session event “session.autopilot_objective_changed”. Autopilot objective state file operation details indicating what changed

SessionBackgroundTasksChangedData

Session event “session.background_tasks_changed”. Empty payload for session.background_tasks_changed, indicating background task state changed.

SessionBinaryAssetData

Session event “session.binary_asset”. Canonical bytes for a content-addressed binary asset shared by reference across events

SessionCanvasClosedData

Session event “session.canvas.closed”. Payload of session.canvas.closed with the closed canvas instance ID, provider ID, and canvas ID.

SessionCanvasOpenedData

Session event “session.canvas.opened”. Payload of session.canvas.opened with canvas instance and provider IDs plus optional title, status, URL, and input.

SessionCanvasRecordedData

Session event “session.canvas.recorded”. Durable record that a canvas instance is open, used to restore open canvases on cold session resume. Intentionally omits the transient url and availability.

SessionCanvasRegistryChangedData

Session event “session.canvas.registry_changed”. Payload of session.canvas.registry_changed listing the canvas declarations currently available.

SessionCanvasRemovedData

Session event “session.canvas.removed”. Durable record that a canvas instance was closed, superseding a prior instance_recorded during resume replay.

SessionCanvasUnavailableData

Session event “session.canvas.unavailable”. Transient signal that an open canvas instance’s provider has dropped (for example the extension is reloading mid-session). The host should keep the panel mounted and surface a reconnecting affordance rather than tearing it down; a subsequent session.canvas.opened for the same instanceId clears the affordance once the provider reconnects with a fresh url. Ephemeral and never persisted, so it is never replayed on cold resume.

SessionCompactionCompleteData

Session event “session.compaction_complete”. Conversation compaction results including success status, metrics, and optional error details

SessionCompactionStartData

Session event “session.compaction_start”. Context window breakdown at the start of LLM-powered conversation compaction

SessionContextChangedData

Session event “session.context_changed”. Updated working directory and git context after the change

SessionCustomAgentsUpdatedData

Session event “session.custom_agents_updated”. Payload of session.custom_agents_updated with loaded custom agents plus non-fatal warnings and fatal errors.

SessionCustomNotificationData

Session event “session.custom_notification”. Opaque custom notification data. Consumers may branch on source and name, but payload semantics are source-defined.

SessionErrorData

Session event “session.error”. Error details for timeline display including message and optional diagnostic information

SessionExtensionsAttachmentsPushedData

Session event “session.extensions.attachments_pushed”. Payload of session.extensions.attachments_pushed with extension-contributed attachments for the next send.

SessionExtensionsLoadedData

Session event “session.extensions_loaded”. Payload of session.extensions_loaded listing discovered extensions and their statuses.

SessionHandoffData

Session event “session.handoff”. Session handoff metadata including source, context, and repository information

SessionIdleData

Session event “session.idle”. Payload indicating the session is idle with no background agents or attached shell commands in flight

SessionInfoData

Session event “session.info”. Informational message for timeline display with categorization

SessionLimitsConfig

Optional session limits.

SessionLimitsExhaustedCompletedData

Session event “session_limits_exhausted.completed”. Session limit exhaustion prompt completion notification.

SessionLimitsExhaustedRequestedData

Session event “session_limits_exhausted.requested”. Session limit exhaustion notification requiring user action.

SessionLimitsExhaustedResponse

The user’s selected action for an exhausted session limit.

SessionMcpServerStatusChangedData

Session event “session.mcp_server_status_changed”. Payload of session.mcp_server_status_changed for one MCP server’s status and optional failure error.

SessionMcpServersLoadedData

Session event “session.mcp_servers_loaded”. Payload of session.mcp_servers_loaded listing MCP server status summaries.

SessionModeChangedData

Session event “session.mode_changed”. Agent mode change details including previous and new modes

SessionModelChangeData

Session event “session.model_change”. Model change details including previous and new model identifiers

SessionPermissionsChangedData

Session event “session.permissions_changed”. Permissions change details carrying the aggregate allow-all transition.

SessionPlanChangedData

Session event “session.plan_changed”. Plan file operation details indicating what changed

SessionRemoteSteerableChangedData

Session event “session.remote_steerable_changed”. Notifies that the session’s remote steering capability has changed

SessionResumeData

Session event “session.resume”. Session resume metadata including current context and event count

SessionScheduleCancelledData

Session event “session.schedule_cancelled”. Scheduled prompt cancelled from the schedule manager dialog

SessionScheduleCreatedData

Session event “session.schedule_created”. Scheduled prompt registered via /every or /after

SessionScheduleRearmedData

Session event “session.schedule_rearmed”. Self-paced schedule re-armed for its next run

SessionSessionLimitsChangedData

Session event “session.session_limits_changed”. Session limits update details. Null clears the limits.

SessionShutdownData

Session event “session.shutdown”. Session termination metrics including usage statistics, code changes, and shutdown reason

SessionSkillsLoadedData

Session event “session.skills_loaded”. Payload of session.skills_loaded listing resolved skill metadata.

SessionSnapshotRewindData

Session event “session.snapshot_rewind”. Session rewind details including target event and count of removed events

SessionStartData

Session event “session.start”. Session initialization metadata including context and configuration

SessionTaskCompleteData

Session event “session.task_complete”. Task completion notification with summary from the agent

SessionTitleChangedData

Session event “session.title_changed”. Session title change payload containing the new display title

SessionTodosChangedData

Session event “session.todos_changed”. Signal-only event: the agent’s todos or todo_deps table was written to. No payload — clients should call session.plan.readSqlTodosWithDependencies() to fetch the current state. Events arrive in order; clients can debounce on arrival if needed.

SessionToolsUpdatedData

Session event “session.tools_updated”. Payload of session.tools_updated identifying the model whose resolved tools were updated.

SessionTruncationData

Session event “session.truncation”. Conversation truncation statistics including token counts and removed content metrics

SessionUsageCheckpointData

Session event “session.usage_checkpoint”. Durable session usage checkpoint for reconstructing aggregate accounting on resume

SessionUsageInfoData

Session event “session.usage_info”. Current context window usage statistics including token and message counts

SessionWarningData

Session event “session.warning”. Warning message for timeline display with categorization

SessionWorkspaceFileChangedData

Session event “session.workspace_file_changed”. Workspace file change details including path and operation type

ShutdownCodeChanges

Aggregate code change metrics for the session

ShutdownModelMetric

Per-model shutdown metrics with request counts, token usage, nano-AI units, and token details.

ShutdownModelMetricRequests

Request count and cost metrics

ShutdownModelMetricTokenDetail

A token-type entry in a shutdown model metric, storing the accumulated token count.

ShutdownModelMetricUsage

Token usage breakdown

ShutdownTokenDetail

A session-wide shutdown token-type entry storing the accumulated token count.

SkillInvokedData

Session event “skill.invoked”. Skill invocation details including content, allowed tools, and plugin metadata

SkillsLoadedSkill

A single resolved skill in session.skills_loaded, including source, invocability, enabled state, path, and argument hint.

SubagentCompletedData

Session event “subagent.completed”. Sub-agent completion details for successful execution

SubagentDeselectedData

Session event “subagent.deselected”. Empty payload; the event signals that the custom agent was deselected, returning to the default agent

SubagentFailedData

Session event “subagent.failed”. Sub-agent failure details including error message and agent information

SubagentSelectedData

Session event “subagent.selected”. Custom agent selection details including name and available tools

SubagentStartedData

Session event “subagent.started”. Sub-agent startup details including parent tool call and agent information

SystemMessageData

Session event “system.message”. System/developer instruction content with role and optional template metadata

SystemMessageMetadata

Metadata about the prompt template and its construction

SystemNotificationData

Session event “system.notification”. System-generated notification for runtime events like background task completion

ToolExecutionCompleteContentAudio

Audio content block with base64-encoded data

ToolExecutionCompleteContentImage

Image content block with base64-encoded data

ToolExecutionCompleteContentResource

Embedded resource content block with inline text or binary data

ToolExecutionCompleteContentResourceLink

Resource link content block referencing an external resource

ToolExecutionCompleteContentResourceLinkIcon

Icon image for a resource

ToolExecutionCompleteContentShellExit

Shell command exit metadata with optional output preview

ToolExecutionCompleteContentText

Plain text content block

ToolExecutionCompleteData

Session event “tool.execution_complete”. Tool execution completion results including success status, detailed output, and error information

ToolExecutionCompleteError

Error details when the tool execution failed

ToolExecutionCompleteResult

Tool execution result on success

ToolExecutionCompleteToolDescription

Tool definition metadata, present for MCP tools with MCP Apps support

ToolExecutionCompleteToolDescriptionMeta

MCP Apps metadata for UI resource association

ToolExecutionCompleteToolDescriptionMetaUI

MCP Apps tool _meta.ui resource URI and visibility captured on tool.execution_complete.

ToolExecutionCompleteUIResource

MCP Apps UI resource content for rendering in a sandboxed iframe

ToolExecutionCompleteUIResourceMeta

Resource-level UI metadata (CSP, permissions, visual preferences)

ToolExecutionCompleteUIResourceMetaUI

MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference.

ToolExecutionCompleteUIResourceMetaUICsp

CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains.

ToolExecutionCompleteUIResourceMetaUIPermissions

Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write.

ToolExecutionCompleteUIResourceMetaUIPermissionsCamera

Marker object for camera permission on an MCP Apps UI resource.

ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite

Marker object for clipboard-write permission on an MCP Apps UI resource.

ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation

Marker object for geolocation permission on an MCP Apps UI resource.

ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone

Marker object for microphone permission on an MCP Apps UI resource.

ToolExecutionPartialResultData

Session event “tool.execution_partial_result”. Streaming tool execution output for incremental result display

ToolExecutionProgressData

Session event “tool.execution_progress”. Tool execution progress notification with status message

ToolExecutionStartData

Session event “tool.execution_start”. Tool execution startup details including MCP server information when applicable

ToolExecutionStartShellToolInfo

Shell-aware path hints for a shell tool’s command, captured at start time so consumers can snapshot a file’s pre-image before the tool runs.

ToolExecutionStartToolDescription

Tool definition metadata, present for MCP tools with MCP Apps support

ToolExecutionStartToolDescriptionMeta

MCP Apps metadata for UI resource association

ToolExecutionStartToolDescriptionMetaUI

MCP Apps tool _meta.ui resource URI and visibility captured on tool.execution_start.

ToolUserRequestedData

Session event “tool.user_requested”. User-initiated tool invocation request with tool name and arguments

TypedSessionEvent

A session event with typed data payload.

UserInputCompletedData

Session event “user_input.completed”. User input request completion with the user’s response

UserInputRequestedData

Session event “user_input.requested”. User input request notification with question and optional predefined choices

UserMessageData

Session event “user.message”. Payload of user.message with displayed and model-transformed content, attachments, source/delivery metadata, mode, and telemetry IDs.

UserToolSessionApprovalCommands

Session-scoped tool-approval rule for specific shell command identifiers.

UserToolSessionApprovalCustomTool

Session-scoped tool-approval rule for a custom tool, keyed by tool name.

UserToolSessionApprovalExtensionManagement

Session-scoped tool-approval rule for extension-management operations, optionally narrowed by operation.

UserToolSessionApprovalExtensionPermissionAccess

Session-scoped tool-approval rule for an extension’s permission-gated capability access, keyed by extension name.

UserToolSessionApprovalMcp

Session-scoped tool-approval rule for an MCP server tool, or all tools on the server when toolName is null.

UserToolSessionApprovalMemory

Session-scoped tool-approval rule for writes to long-term memory.

UserToolSessionApprovalRead

Session-scoped tool-approval rule for read-only filesystem operations.

UserToolSessionApprovalWrite

Session-scoped tool-approval rule for filesystem write operations.

WorkingDirectoryContext

Working directory and git context at session start

Enums

AbortReason

Finite reason code describing why the current turn was aborted

AssistantMessageToolRequestType

Tool call type: “function” for standard tool calls, “custom” for grammar-based tool calls. Defaults to “function” when absent.

AssistantUsageApiEndpoint

API endpoint used for this model call, matching CAPI supported_endpoints vocabulary

AutoApprovalRecommendation

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

AutoModeResolvedReasoningBucket

Coarse request-difficulty bucket for UX explainability

AutoModeSwitchResponse

The user’s auto-mode-switch choice

AutopilotObjectiveChangedOperation

The type of operation performed on the autopilot objective state file

AutopilotObjectiveChangedStatus

Current autopilot objective status, if one exists

BinaryAssetType

Binary asset type discriminator. Use “image” for images and “resource” otherwise.

CitationProvider

The system that produced a citation.

ContextTier

Allowed values for the ContextTier enumeration.

ElicitationCompletedAction

The user action: “accept” (submitted form), “decline” (explicitly refused), or “cancel” (dismissed)

ElicitationRequestedMode

Elicitation mode; “form” for structured input, “url” for browser-based. Defaults to “form” when absent.

ElicitationRequestedSchemaType

Schema type indicator (always ‘object’)

ExitPlanModeAction

Exit plan mode action

ExtensionsLoadedExtensionSource

Discovery source

ExtensionsLoadedExtensionStatus

Current status: running, disabled, failed, or starting

HandoffSourceType

Origin type of the session being handed off

McpHeadersRefreshCompletedOutcome

How the pending MCP headers refresh request resolved.

McpHeadersRefreshRequiredReason

Why dynamic headers are being requested.

McpOauthCompletionOutcome

How the pending MCP OAuth request was completed

McpOauthRequestReason

Reason the runtime is requesting host-provided MCP OAuth credentials

McpOauthRequiredStaticClientConfigGrantType

Optional non-default OAuth grant type. When set to ‘client_credentials’, the OAuth flow runs headlessly using the client_id + keychain-stored secret (no browser, no callback server).

McpServerSource

Configuration source: user, workspace, plugin, or builtin

McpServerStatus

Connection status: connected, failed, needs-auth, pending, disabled, or not_configured

McpServerTransport

Transport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server)

ModelCallFailureBadRequestKind

For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature). Absent for non-400 failures.

ModelCallFailureSource

Where the failed model call originated

PermissionAllowAllMode

Allow-all mode for the session.

PermissionApprovedForLocationKind

Approved and persisted for this project location

PermissionApprovedForSessionKind

Approved and remembered for the rest of the session

PermissionApprovedKind

The permission request was approved

PermissionCancelledKind

The permission request was cancelled before a response was used

PermissionDeniedByContentExclusionPolicyKind

Denied by the organization’s content exclusion policy

PermissionDeniedByPermissionRequestHookKind

Denied by a permission request hook registered by an extension or plugin

PermissionDeniedByRulesKind

Denied because approval rules explicitly blocked it

PermissionDeniedInteractivelyByUserKind

Denied by the user during an interactive prompt

PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUserKind

Denied because no approval rule matched and user confirmation was unavailable

PermissionPromptRequest

Derived user-facing permission prompt details for UI consumers

PermissionPromptRequestCommandsKind

Prompt kind discriminator

PermissionPromptRequestCustomToolKind

Prompt kind discriminator

PermissionPromptRequestExtensionManagementKind

Prompt kind discriminator

PermissionPromptRequestExtensionPermissionAccessKind

Prompt kind discriminator

PermissionPromptRequestHookKind

Prompt kind discriminator

PermissionPromptRequestMcpKind

Prompt kind discriminator

PermissionPromptRequestMemoryKind

Prompt kind discriminator

PermissionPromptRequestPathAccessKind

Underlying permission kind that needs path approval

PermissionPromptRequestPathKind

Prompt kind discriminator

PermissionPromptRequestReadKind

Prompt kind discriminator

PermissionPromptRequestUrlKind

Prompt kind discriminator

PermissionPromptRequestWriteKind

Prompt kind discriminator

PermissionRequest

Details of the permission being requested

PermissionRequestCustomToolKind

Permission kind discriminator

PermissionRequestExtensionManagementKind

Permission kind discriminator

PermissionRequestExtensionPermissionAccessKind

Permission kind discriminator

PermissionRequestHookKind

Permission kind discriminator

PermissionRequestMcpKind

Permission kind discriminator

PermissionRequestMemoryAction

Whether this is a store or vote memory operation

PermissionRequestMemoryDirection

Vote direction (vote only)

PermissionRequestMemoryKind

Permission kind discriminator

PermissionRequestReadKind

Permission kind discriminator

PermissionRequestShellKind

Permission kind discriminator

PermissionRequestUrlKind

Permission kind discriminator

PermissionRequestWriteKind

Permission kind discriminator

PermissionResult

The result of the permission request

PlanChangedOperation

The type of operation performed on the plan file

ReasoningSummary

Reasoning summary mode used for model calls, if applicable (e.g. “none”, “concise”, “detailed”)

SessionEventData

Typed session event data, discriminated by the event type field.

SessionEventType

Identifies the kind of session event.

SessionLimitsExhaustedResponseAction

User action selected for an exhausted session limit.

SessionMode

The session mode the agent is operating in

ShutdownType

Whether the session ended normally (“routine”) or due to a crash/fatal error (“error”)

SkillInvokedTrigger

What triggered the skill invocation: user-invoked (explicit user action, such as via a slash command or UI affordance), agent-invoked (agent requested the skill), or context-load (loaded as part of another context, such as preloading skills configured on a custom agent or subagent)

SkillSource

Source location type (e.g., project, personal-copilot, plugin, builtin)

SystemMessageRole

Message role: “system” for system prompts, “developer” for developer-injected instructions

ToolExecutionCompleteContent

A content block within a tool result, which may be text, terminal output, image, audio, or a resource

ToolExecutionCompleteContentAudioType

Content block type discriminator

ToolExecutionCompleteContentImageType

Content block type discriminator

ToolExecutionCompleteContentResourceDetails

The embedded resource contents, either text or base64-encoded binary

ToolExecutionCompleteContentResourceLinkIconTheme

Theme variant this icon is intended for

ToolExecutionCompleteContentResourceLinkType

Content block type discriminator

ToolExecutionCompleteContentResourceType

Content block type discriminator

ToolExecutionCompleteContentShellExitType

Content block type discriminator

ToolExecutionCompleteContentTerminalType

Content block type discriminator

ToolExecutionCompleteContentTextType

Content block type discriminator

ToolExecutionCompleteToolDescriptionMetaUIVisibility

Allowed values for the ToolExecutionCompleteToolDescriptionMetaUIVisibility enumeration.

ToolExecutionStartToolDescriptionMetaUIVisibility

Allowed values for the ToolExecutionStartToolDescriptionMetaUIVisibility enumeration.

UserMessageAgentMode

The agent mode that was active when this message was sent

UserMessageDelivery

How this user message was delivered to the agentic loop, relative to whether the loop was already running. This is the timing axis only; the message’s origin (human vs. system/command/schedule/skill/etc.) is carried separately by source. A system-injected message has a delivery too — e.g. a background-task notification waking an idle agent is idle, the same mechanism as a human starting a fresh turn.

UserToolSessionApproval

The approval to add as a session-scoped rule

UserToolSessionApprovalCommandsKind

Command approval kind

UserToolSessionApprovalCustomToolKind

Custom tool approval kind

UserToolSessionApprovalExtensionManagementKind

Extension management approval kind

UserToolSessionApprovalExtensionPermissionAccessKind

Extension permission access approval kind

UserToolSessionApprovalMcpKind

MCP tool approval kind

UserToolSessionApprovalMemoryKind

Memory approval kind

UserToolSessionApprovalReadKind

Read approval kind

UserToolSessionApprovalWriteKind

Write approval kind

Verbosity

Output verbosity level used for supported model calls (e.g. “low”, “medium”, “high”)

WorkingDirectoryContextHostType

Hosting platform type of the repository (github or ado)

WorkspaceFileChangedOperation

Whether the file was newly created or updated