Uses of Annotation Interface
com.github.copilot.CopilotExperimental

Packages that use CopilotExperimental

Package	Description
com.github.copilot	Core classes for the GitHub Copilot SDK for Java.
com.github.copilot.generated	Auto-generated session event types for the GitHub Copilot SDK.
com.github.copilot.generated.rpc	Auto-generated RPC parameter and result types for the GitHub Copilot SDK.
com.github.copilot.rpc	Configuration classes and data transfer objects for the Copilot SDK.
com.github.copilot.tool

Uses of CopilotExperimental in com.github.copilot

Classes in com.github.copilot with annotations of type CopilotExperimental

Modifier and Type	Class	Description
final class	AhpHost	A ready, connection-owned AHP listener.
final record	AhpHostExit	A connection-owned listener's termination and cleanup outcome.
final class	AhpHostOptions	Options for in-process AHP hosting.
final record	AhpSessionCreateRequest	An application-owned AHP session creation request.
final record	AhpSessionResumeRequest	An application-owned durable AHP session resume request.
@interface	CopilotResponse	Generates a response schema using the same annotation processor and type mappings as @CopilotTool.
interface	SkillProvider	Provides session-scoped skills to the Copilot runtime.
final record	SkillProviderDescriptor	Catalog metadata for one skill supplied by a SkillProvider.

Methods in com.github.copilot with annotations of type CopilotExperimental

Modifier and Type	Method	Description
<T> CompletableFuture<T>	CopilotSession.sendAndWait(MessageOptions options, Class<T> responseType)	Sends a message using its result type's generated schema.
<T> CompletableFuture<T>	CopilotSession.sendAndWait(MessageOptions options, Class<T> responseType, long timeoutMs)	Infers a schema using the custom-tool annotation processor, then deserializes the last correlated root message without tool requests at non-autopilot idle.
<T> CompletableFuture<T>	CopilotSession.sendAndWait(String prompt, Class<T> responseType)	Sends a prompt using the schema generated for a CopilotResponse type.
CompletableFuture<SessionModelSwitchAutoTierResult>	CopilotSession.setAutoTier(AutoTier autoTier)	Changes the Auto routing preference without changing the selected model.
CompletableFuture<Void>	CopilotSession.setTools(List<ToolDefinition> tools)	Replaces this client's externally implemented tools on the live session.
CompletableFuture<AhpHost>	CopilotClient.startAhpHost(AhpHostOptions options)	Starts in-process AHP hosting owned by this client's current connection.

Uses of CopilotExperimental in com.github.copilot.generated

Classes in com.github.copilot.generated with annotations of type CopilotExperimental

Modifier and Type	Class	Description
final class	AssistantFusionPhaseActivityEvent	Session event "assistant.fusion_phase_activity".
static final record	AssistantFusionPhaseActivityEvent.AssistantFusionPhaseActivityEventData	Data payload for AssistantFusionPhaseActivityEvent.
final class	AssistantFusionPhaseCompletedEvent	Session event "assistant.fusion_phase_completed".
static final record	AssistantFusionPhaseCompletedEvent.AssistantFusionPhaseCompletedEventData	Data payload for AssistantFusionPhaseCompletedEvent.
final class	AssistantFusionPhaseFailedEvent	Session event "assistant.fusion_phase_failed".
static final record	AssistantFusionPhaseFailedEvent.AssistantFusionPhaseFailedEventData	Data payload for AssistantFusionPhaseFailedEvent.
final class	AssistantFusionPhaseStartedEvent	Session event "assistant.fusion_phase_started".
static final record	AssistantFusionPhaseStartedEvent.AssistantFusionPhaseStartedEventData	Data payload for AssistantFusionPhaseStartedEvent.
final record	AssistantMessageReasoningBlocks	Neutral provider-tagged reasoning content blocks preserved verbatim for round-tripping
final record	AssistantMessageServerTools	Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-tripping
final record	CanvasRegistryChangedCanvas	A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions.
final record	CanvasRegistryChangedCanvasAction	A single action within a canvas declaration, with its name, optional description, and optional input schema.
final record	CitableSource	A source supplied by a tool that should be made available to the model as citable content.
enum	CitationProvider	The system that produced a citation.
final record	CitationReference	A single citation occurrence linking a span of generated text to a supporting source.
final record	Citations	Provider-agnostic citations linking spans of the assistant's response to their supporting sources.
final record	CitationSource	A source that backs one or more cited spans in the assistant's response.
final record	CitationSpan	A contiguous span of generated assistant text and the source references that support it.
final record	FusionAttribution	Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it.
enum	FusionConversationScope	Conversation scope in which a HydraFusion phase executes.
final record	FusionCritic	Data type FusionCritic.
enum	FusionFollowUpAction	Server-recommended routing behavior for a later HydraFusion turn.
final record	FusionFollowUpRecommendation	Durable server recommendation for subsequent HydraFusion turns.
enum	FusionPattern	Validated HydraFusion execution pattern.
enum	FusionPhaseActivityKind	Content-safe activity observed while a HydraFusion phase is running.
enum	FusionPhaseKind	HydraFusion phase kind.
final record	FusionPhasePlanStep	Presentation-neutral phase planned for a HydraFusion turn.
enum	FusionPhaseStatus	Durable outcome status of a HydraFusion phase.
final record	FusionPhaseUsage	Aggregate concrete-model usage for one HydraFusion phase.
enum	FusionProjectionMode	How a durable phase checkpoint contributes its exact message to canonical root history.
final record	FusionScores	Validated HydraFusion routing capability scores.
final record	FusionStagedTerminal	Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it.
enum	FusionTurnKind	Kind of turn for which HydraFusion routing is running.
enum	ManagedPluginProgressPhase	Current phase of organization-required plugin preparation.
enum	ModelProviderKind	The neutral kind of a model provider — the model analog of `AccountKind`.
final record	ModelProviderRef	A neutral reference to the model provider that produced a model: an opaque id, a human-readable label, and the provider kind.
final class	PermissionAssentDetectedEvent	Session event "permission.assentDetected".
static final record	PermissionAssentDetectedEvent.PermissionAssentDetectedEventData	Data payload for PermissionAssentDetectedEvent.
final class	PermissionCarriedForwardEvent	Session event "permission.carriedForward".
static final record	PermissionCarriedForwardEvent.PermissionCarriedForwardEventData	Data payload for PermissionCarriedForwardEvent.
final class	PermissionContextualAuthorizationEvent	Session event "permission.contextualAuthorization".
static final record	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData	Data payload for PermissionContextualAuthorizationEvent.
final class	PermissionMessageAuthorizationDegradedEvent	Session event "permission.messageAuthorizationDegraded".
static final record	PermissionMessageAuthorizationDegradedEvent.PermissionMessageAuthorizationDegradedEventData	Data payload for PermissionMessageAuthorizationDegradedEvent.
final class	PermissionMessageAuthorizationEvent	Session event "permission.messageAuthorization".
static final record	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData	Data payload for PermissionMessageAuthorizationEvent.
enum	PermissionMessageAuthorizationPolarity	Direction stored in a historical extractor claim.
final class	PermissionMessageAuthorizationReadEvent	Session event "permission.messageAuthorizationRead".
static final record	PermissionMessageAuthorizationReadEvent.PermissionMessageAuthorizationReadEventData	Data payload for PermissionMessageAuthorizationReadEvent.
enum	PermissionMode	Permission mode for the session.
final record	ProviderQuotaState	An account quota reading.
final class	SessionAutoModeResolvedEvent	Session event "session.auto_mode_resolved".
static final record	SessionAutoModeResolvedEvent.SessionAutoModeResolvedEventData	Data payload for SessionAutoModeResolvedEvent.
final class	SessionAutoTierRecommendationEvent	Session event "session.auto_tier_recommendation".
static final record	SessionAutoTierRecommendationEvent.SessionAutoTierRecommendationEventData	Data payload for SessionAutoTierRecommendationEvent.
final class	SessionBinaryAssetEvent	Session event "session.binary_asset".
static final record	SessionBinaryAssetEvent.SessionBinaryAssetEventData	Data payload for SessionBinaryAssetEvent.
final class	SessionCanvasClosedEvent	Session event "session.canvas.closed".
static final record	SessionCanvasClosedEvent.SessionCanvasClosedEventData	Data payload for SessionCanvasClosedEvent.
final class	SessionCanvasOpenedEvent	Session event "session.canvas.opened".
static final record	SessionCanvasOpenedEvent.SessionCanvasOpenedEventData	Data payload for SessionCanvasOpenedEvent.
final class	SessionCanvasRecordedEvent	Session event "session.canvas.recorded".
static final record	SessionCanvasRecordedEvent.SessionCanvasRecordedEventData	Data payload for SessionCanvasRecordedEvent.
final class	SessionCanvasRegistryChangedEvent	Session event "session.canvas.registry_changed".
static final record	SessionCanvasRegistryChangedEvent.SessionCanvasRegistryChangedEventData	Data payload for SessionCanvasRegistryChangedEvent.
final class	SessionCanvasRemovedEvent	Session event "session.canvas.removed".
static final record	SessionCanvasRemovedEvent.SessionCanvasRemovedEventData	Data payload for SessionCanvasRemovedEvent.
final class	SessionCanvasUnavailableEvent	Session event "session.canvas.unavailable".
static final record	SessionCanvasUnavailableEvent.SessionCanvasUnavailableEventData	Data payload for SessionCanvasUnavailableEvent.
final class	SessionCompletionReceiptEvent	Session event "session.completion_receipt".
static final record	SessionCompletionReceiptEvent.SessionCompletionReceiptEventData	Data payload for SessionCompletionReceiptEvent.
final class	SessionFusionCompletedEvent	Session event "session.fusion_completed".
static final record	SessionFusionCompletedEvent.SessionFusionCompletedEventData	Data payload for SessionFusionCompletedEvent.
final class	SessionFusionResolvedEvent	Session event "session.fusion_resolved".
static final record	SessionFusionResolvedEvent.SessionFusionResolvedEventData	Data payload for SessionFusionResolvedEvent.
final class	SessionFusionRouteFailedEvent	Session event "session.fusion_route_failed".
static final record	SessionFusionRouteFailedEvent.SessionFusionRouteFailedEventData	Data payload for SessionFusionRouteFailedEvent.
final class	SessionFusionRouteStartedEvent	Session event "session.fusion_route_started".
static final record	SessionFusionRouteStartedEvent.SessionFusionRouteStartedEventData	Data payload for SessionFusionRouteStartedEvent.
final class	SessionManagedPluginProgressEvent	Session event "session.managed_plugin_progress".
static final record	SessionManagedPluginProgressEvent.SessionManagedPluginProgressEventData	Data payload for SessionManagedPluginProgressEvent.
final class	SessionManagedSettingsEnforcedEvent	Session event "session.managed_settings_enforced".
static final record	SessionManagedSettingsEnforcedEvent.SessionManagedSettingsEnforcedEventData	Data payload for SessionManagedSettingsEnforcedEvent.
final class	SessionManagedSettingsResolvedEvent	Session event "session.managed_settings_resolved".
static final record	SessionManagedSettingsResolvedEvent.SessionManagedSettingsResolvedEventData	Data payload for SessionManagedSettingsResolvedEvent.
final class	SessionPermissionsChangedEvent	Session event "session.permissions_changed".
static final record	SessionPermissionsChangedEvent.SessionPermissionsChangedEventData	Data payload for SessionPermissionsChangedEvent.
final class	SessionQuotaObservationEvent	Session event "session.quota_observation".
static final record	SessionQuotaObservationEvent.SessionQuotaObservationEventData	Data payload for SessionQuotaObservationEvent.
final class	SkillContextDeliveredEvent	Session event "skill.context_delivered".
static final record	SkillContextDeliveredEvent.SkillContextDeliveredEventData	Data payload for SkillContextDeliveredEvent.
final class	SkillContextDeliveredRefEvent	Session event "skill.context_delivered_ref".
static final record	SkillContextDeliveredRefEvent.SkillContextDeliveredRefEventData	Data payload for SkillContextDeliveredRefEvent.
final class	SkillInvokedRefEvent	Session event "skill.invoked_ref".
static final record	SkillInvokedRefEvent.SkillInvokedRefEventData	Data payload for SkillInvokedRefEvent.
final record	TaskBlocker	Structured reason that the task cannot continue without intervention
final record	ToolExecutionCompleteFileEdit	A file mutation that was actually committed by a built-in file editing tool.
final class	ToolExecutionCompleteFileEditKind	Kind of file mutation committed by a built-in editing tool.
final record	ToolExecutionCompleteShellExecution	Experimental shell completion facts retained independently of the full tool result.
final class	UiEphemeralQueryEvent	Session event "ui.ephemeral_query".
static final record	UiEphemeralQueryEvent.UiEphemeralQueryEventData	Data payload for UiEphemeralQueryEvent.
enum	UIEphemeralQueryPhase	Lifecycle phase for a Rust-owned ephemeral query stream.
final class	WorkflowRunSettledEvent	Session event "workflow.run_settled".
static final record	WorkflowRunSettledEvent.WorkflowRunSettledEventData	Data payload for WorkflowRunSettledEvent.
final class	WorkflowRunStartedEvent	Session event "workflow.run_started".
static final record	WorkflowRunStartedEvent.WorkflowRunStartedEventData	Data payload for WorkflowRunStartedEvent.
final class	WorkflowRunUpdatedEvent	Session event "workflow.run_updated".
static final record	WorkflowRunUpdatedEvent.WorkflowRunUpdatedEventData	Data payload for WorkflowRunUpdatedEvent.

Methods in com.github.copilot.generated with annotations of type CopilotExperimental

Modifier and Type	Method	Description
String	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.actionClass()	Returns the value of the actionClass record component.
Boolean	PermissionMessageAuthorizationReadEvent.PermissionMessageAuthorizationReadEventData.activatesExtraction()	Returns the value of the activatesExtraction record component.
String	SessionPermissionsChangedEvent.SessionPermissionsChangedEventData.assistedApprovalModel()	Returns the value of the assistedApprovalModel record component.
Citations	AssistantMessageEvent.AssistantMessageEventData.citations()	Returns the value of the citations record component.
Double	AssistantUsageEvent.AssistantUsageEventData.cost()	Returns the value of the cost record component.
List<FusionCritic>	SessionFusionResolvedEvent.SessionFusionResolvedEventData.critics()	Returns the value of the critics record component.
PermissionDecisionSource	PermissionCarriedForwardEvent.PermissionCarriedForwardEventData.decisionSource()	Returns the value of the decisionSource record component.
PermissionDecisionSource	PermissionCompletedEvent.PermissionCompletedEventData.decisionSource()	Returns the value of the decisionSource record component.
List<ToolExecutionCompleteFileEdit>	ToolExecutionCompleteEvent.ToolExecutionCompleteEventData.fileEdits()	Returns the value of the fileEdits record component.
FusionAttribution	AssistantMessageEvent.AssistantMessageEventData.fusion()	Returns the value of the fusion record component.
FusionAttribution	AssistantUsageEvent.AssistantUsageEventData.fusion()	Returns the value of the fusion record component.
FusionAttribution	ModelCallFailureEvent.ModelCallFailureEventData.fusion()	Returns the value of the fusion record component.
FusionAttribution	ModelCallStartEvent.ModelCallStartEventData.fusion()	Returns the value of the fusion record component.
FusionAttribution	ToolExecutionCompleteEvent.ToolExecutionCompleteEventData.fusion()	Returns the value of the fusion record component.
FusionAttribution	ToolExecutionStartEvent.ToolExecutionStartEventData.fusion()	Returns the value of the fusion record component.
String	SessionFusionResolvedEvent.SessionFusionResolvedEventData.hint()	Returns the value of the hint record component.
String	SessionFusionResolvedEvent.SessionFusionResolvedEventData.judgeModel()	Returns the value of the judgeModel record component.
Object	ToolExecutionCompleteEvent.ToolExecutionCompleteEventData.mcpMeta()	Returns the value of the mcpMeta record component.
PermissionMode	SessionPermissionsChangedEvent.SessionPermissionsChangedEventData.mode()	Returns the value of the mode record component.
List<FusionPhasePlanStep>	SessionFusionResolvedEvent.SessionFusionResolvedEventData.phasePlan()	Returns the value of the phasePlan record component.
PermissionMessageAuthorizationPolarity	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.polarity()	Returns the value of the polarity record component.
PermissionMessageAuthorizationPolarity	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.polarity()	Returns the value of the polarity record component.
PermissionMode	SessionPermissionsChangedEvent.SessionPermissionsChangedEventData.previousMode()	Returns the value of the previousMode record component.
String	AssistantFusionPhaseCompletedEvent.AssistantFusionPhaseCompletedEventData.reasoningEffort()	Returns the value of the reasoningEffort record component.
String	AssistantFusionPhaseFailedEvent.AssistantFusionPhaseFailedEventData.reasoningEffort()	Returns the value of the reasoningEffort record component.
String	AssistantFusionPhaseStartedEvent.AssistantFusionPhaseStartedEventData.reasoningEffort()	Returns the value of the reasoningEffort record component.
String	PermissionCarriedForwardEvent.PermissionCarriedForwardEventData.recordId()	Returns the value of the recordId record component.
String	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.recordId()	Returns the value of the recordId record component.
String	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.recordId()	Returns the value of the recordId record component.
String	SessionFusionResolvedEvent.SessionFusionResolvedEventData.repairModel()	Returns the value of the repairModel record component.
String	PermissionAssentDetectedEvent.PermissionAssentDetectedEventData.requestId()	Returns the value of the requestId record component.
String	PermissionCarriedForwardEvent.PermissionCarriedForwardEventData.requestId()	Returns the value of the requestId record component.
String	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.requestId()	Returns the value of the requestId record component.
ToolExecutionCompleteShellExecution	ToolExecutionCompleteEvent.ToolExecutionCompleteEventData.shellExecution()	Returns the value of the shellExecution record component.
Long	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.spanEnd()	Returns the value of the spanEnd record component.
Long	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.spanEnd()	Returns the value of the spanEnd record component.
Long	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.spanStart()	Returns the value of the spanStart record component.
Long	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.spanStart()	Returns the value of the spanStart record component.
Object	ToolExecutionProgressEvent.ToolExecutionProgressEventData.structuredContent()	Returns the value of the structuredContent record component.
List<String>	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.targetMembers()	Returns the value of the targetMembers record component.
String	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.task()	Returns the value of the task record component.
String	PermissionCarriedForwardEvent.PermissionCarriedForwardEventData.toolCallId()	Returns the value of the toolCallId record component.
Double	SessionShutdownEvent.SessionShutdownEventData.totalNanoAiu()	Returns the value of the totalNanoAiu record component.
Long	PermissionAssentDetectedEvent.PermissionAssentDetectedEventData.turnIndex()	Returns the value of the turnIndex record component.
Long	PermissionContextualAuthorizationEvent.PermissionContextualAuthorizationEventData.turnIndex()	Returns the value of the turnIndex record component.
Long	PermissionMessageAuthorizationDegradedEvent.PermissionMessageAuthorizationDegradedEventData.turnIndex()	Returns the value of the turnIndex record component.
Long	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.turnIndex()	Returns the value of the turnIndex record component.
Long	PermissionMessageAuthorizationReadEvent.PermissionMessageAuthorizationReadEventData.turnIndex()	Returns the value of the turnIndex record component.
Object	PermissionMessageAuthorizationEvent.PermissionMessageAuthorizationEventData.world()	Returns the value of the world record component.

Uses of CopilotExperimental in com.github.copilot.generated.rpc

Classes in com.github.copilot.generated.rpc with annotations of type CopilotExperimental

Modifier and Type	Class	Description
final record	AccountGetCurrentAuthResult	Current authentication state
final record	AccountGetQuotaParams	Request parameters for the account.getQuota RPC method.
final record	AccountGetQuotaResult	Quota usage snapshots for the resolved user, keyed by quota type.
enum	AccountKind	The provider kind stamped on a signed-in account.
final record	AccountLoginParams	Credentials to validate and store.
final record	AccountLoginResult	Result of a successful login; throws on failure
final record	AccountLogoutParams	User to log out
final record	AccountLogoutResult	Logout result indicating if more users remain
final record	AccountStatus	One signed-in account in the roster forest.
final record	AgentRegistrySpawnParams	Inputs to spawn a managed-server child via the controller's spawn delegate.
final record	AgentsDiscoverParams	Optional project paths to include in agent discovery.
final record	AgentsDiscoverResult	Agents discovered across user, project, plugin, and remote sources.
final record	AgentsGetDiscoveryPathsParams	Optional project paths to include when enumerating agent discovery directories.
final record	AgentsGetDiscoveryPathsResult	Canonical locations where custom agents can be created so the runtime will recognize them.
class	AuthEnumerateValue	The enumerated collection, keyed by the same selector as the query.
final record	AuthIdentityMetadata	Credential-free identity metadata.
final record	AuthLoginAccount	A credential-free account choice after sign-in.
final record	AuthLoginResultDto	Result of an interactive login flow.
enum	AuthLoginResultStatus	Disposition of a login attempt, including pending user decisions.
class	AuthLoginStep	One step in an interactive login flow.
final class	AuthLoginStepAwaiting	Variant awaiting of AuthLoginStep.
final class	AuthLoginStepCompleted	Variant completed of AuthLoginStep.
final class	AuthLoginStepError	Variant error of AuthLoginStep.
final class	AuthLoginStepInputRequired	Variant input-required of AuthLoginStep.
final class	AuthLoginStepNeedsInteraction	Variant needs-interaction of AuthLoginStep.
final class	AuthLoginStepOpenUrl	Variant open-url of AuthLoginStep.
class	AuthReadValue	The read result, keyed by the same selector as the query.
final class	AuthReadValueActiveAccount	Variant activeAccount of AuthReadValue.
final class	AuthReadValueLastErrors	Variant lastErrors of AuthReadValue.
final class	AuthReadValueStatus	Variant status of AuthReadValue.
final record	AuthStatusDto	Neutral authentication status summary.
final record	AutopilotObjectiveCreditLimit	Current per-window credit limit and consumption for an autopilot objective.
final record	AutopilotObjectiveState	Public, persistence-independent projection of an autopilot objective.
enum	AutopilotObjectiveStatus	Current normalized autopilot objective lifecycle status.
final record	BuiltinToolDescriptor	Rust-owned metadata and input schema for a built-in tool.
final record	BuiltinToolFormat	Custom grammar input format accepted by a built-in tool.
enum	BuiltinToolFormatType	Custom input-format kind.
final record	BuiltinToolInputSchema	JSON Schema object accepted by a built-in tool.
enum	BuiltinToolInputSchemaType	Root JSON Schema type for a built-in tool input.
final record	CanvasAction	Canvas action that the agent or host can invoke.
final record	CanvasActionInvokeParams	Canvas action invocation parameters sent to the provider.
final record	CanvasCloseParams	Canvas close parameters sent to the provider.
final record	CanvasHostContext	Host context supplied by the runtime.
final record	CanvasHostContextCapabilities	Host capabilities
final record	CanvasOpenParams	Canvas open parameters sent to the provider.
final record	CanvasOpenResult	Canvas open result returned by the provider.
final record	CanvasSessionContext	Session context supplied by the runtime.
final record	CatalogSearchParams	A bounded catalog search.
final class	CatalogSearchRequest	A bounded catalog search.
final record	CatalogSelectParams	Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
final record	CommandsListResult	Slash commands available in the session, after applying any include/exclude filters.
final record	ConnectorAuthorizationRequirement	Account-targeted authorization update required by the Connector service.
enum	ConnectorAuthorizationScope	Stable OAuth scope whose absence prevents Connector management.
enum	ConnectorAvailability	Availability of the EXPERIMENTAL session connector API.
final record	ConnectorCatalogEntry	Credential-free Connector catalog entry.
final record	ConnectorCatalogResult	Validated Connector catalog snapshot cached by the session.
enum	ConnectorCatalogStatus	Authoritative service connection state for one Connector.
class	ConnectorConnectResult	Typed result of initiating or continuing a Connector connection.
final class	ConnectorConnectResultConnected	The service is connected and the session MCP graph was reconciled.
final class	ConnectorConnectResultConsentRequired	Host-owned consent is required before bounded continuation can complete.
final class	ConnectorConnectResultPending	The service is still completing the connection without a consent URL.
final record	ConnectorDiscoveryAccount	Eligible account.
final record	ConnectorDiscoveryAuthInfo	Account metadata.
enum	ConnectorDiscoveryAvailability	Availability.
final record	ConnectorDiscoveryCatalogEntry	Entry.
enum	ConnectorMcpStatus	Live MCP status of one Connector-owned runtime server.
final record	ConnectorRuntimeStatus	Live status of one session-owned MCP projection.
final record	ConnectorSessionAccount	Session account selection.
final record	ConnectorsGetAccountsResult	Eligible accounts.
final record	ConnectorsGetCapabilitiesResult	Feature availability.
final record	ConnectorsListParams	Selected account.
final record	ConnectorsListResult	Entries for the selected account.
final record	ConnectorsRefreshParams	Selected account.
final record	ConnectorsRefreshResult	Entries for the selected account.
final record	ConnectorStatus	Authoritative session connector state.
final record	ContentExclusionPathCheck	Content-exclusion decision for one requested path.
final record	CustomizationReloadOutcome	Result of one customization reload component.
final class	CustomizationReloadStatus	Result of reloading a customization component.
final class	CustomizationReloadSubsystem	Component of session customization discovery.
final record	CustomizationsReloadResult	Results of reloading discovered session customizations.
final record	DiagnosticsConfiguration	Per-source session diagnostics configuration.
final record	DiscoveredCanvas	Canvas available in the current session.
final record	DiscoveredModel	A model offered for agent conversations.
final record	EnvironmentCapabilities	Hosting capabilities and session capacity advertised by an environment.
enum	EnvironmentKind	GitHub Mission Control compute kind.
final record	EnvironmentsDeleteParams	Identify a user-managed Mission Control environment to delete.
final record	EnvironmentsGetParams	Identify a Mission Control environment to retrieve.
final record	EnvironmentsGetResult	Safe discovery information for the requested environment.
final record	EnvironmentsListParams	Optional discovery filters supported by GitHub Mission Control.
final record	EnvironmentsListResult	Environments visible to the authenticated caller and matching the supplied filters.
final record	ExtensionLaunchProfile	Opaque integrator-owned process launch profile for one extension entrypoint.
final record	ExtensionLaunchProviderResolveRequest	A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile.
final record	ExtensionLaunchProviderResolveResult	The launch profile for a supported entrypoint.
final record	ExtensionsDisableParams	Source-qualified extension identifiers to persistently disable for future sessions.
final record	ExtensionsDiscoverResult	Extensions discovered from persisted Copilot home state and their effective loading mode.
final record	ExtensionsEnableParams	Source-qualified extension identifiers to persistently enable for future sessions.
final record	GitHubEnvironment	Safe discovery information.
final record	GitHubTelemetryClientInfo	Client environment metadata describing the process that produced a telemetry event.
final record	GitHubTelemetryEvent	A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts.
final record	GitHubTelemetryNotification	Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake.
final record	GitHubTokenAcquireRequest	Asks the SDK client to acquire a GitHub access token from an opaque callback registration.
class	GitHubTokenAcquireResult	SDK host response to a GitHub credential request.
final record	HooksDiscoverParams	Optional project paths and host-exclusion behavior for server-scoped hook discovery.
final record	HooksDiscoverResult	Server-discovered hook actions and partial-load diagnostics from user, repository, plugin, and managed-policy sources.
final record	HostDisposeParams	Stops a connection-owned listener and joins its teardown.
final record	HostEmptyResult	Empty acknowledgement for a completed host lifecycle operation.
final record	HostExitedNotification	Reports a supervised listener's hosting-task termination and cleanup outcome.
enum	HostExitReason	Values for HostExitReason.
final record	HostGitHubEnvironmentOptions	GitHub Mission Control registration options.
final record	HostListSessionsParams	Reads a running host's catalog or the runtime's saved default catalog.
final record	HostListSessionsResult	The complete live and dormant advertised catalog, without subscribing to sessions.
final record	HostLocalServerOptions	Local WebSocket transport options.
final record	HostPublishSessionParams	Publishes a resident session attached to the listener's owning connection.
final record	HostPublishSessionResult	The existing runtime identity and its resource on the listener.
final record	HostSessionSummary	Metadata advertised by the AHP host, not a guarantee that history can be resumed.
final record	HostStartParams	Starts a supervised AHP host with at least one explicitly selected transport.
final class	HostStartRequest	Starts a supervised AHP host with at least one explicitly selected transport.
final record	HostStartResult	Listener readiness, returned only after binding and the supervised participant's SDK handshake.
final record	InstallationsConfirmResult	A response is meaningful only on the connection and request that issued its challenge.
final record	InstructionsDiscoverParams	Optional project paths to include in instruction discovery.
final record	InstructionsDiscoverResult	Instruction sources discovered across user, repository, and plugin sources.
final record	InstructionsGetDiscoveryPathsParams	Optional project paths to include when enumerating instruction discovery targets.
final record	InstructionsGetDiscoveryPathsResult	Canonical files and directories where custom instructions can be created so the runtime will recognize them.
final record	LlmInferenceHttpRequestChunkResult	Acknowledgement.
final record	LlmInferenceHttpRequestStartResult	Acknowledgement.
final record	LlmInferenceHttpResponseChunkParams	A response body chunk or terminal error.
final record	LlmInferenceHttpResponseChunkResult	Whether the chunk was accepted.
final record	LlmInferenceHttpResponseStartParams	Response head.
final record	LlmInferenceHttpResponseStartResult	Whether the start frame was accepted.
final record	LlmInferenceSetProviderResult	Indicates whether the calling client was registered as the LLM inference provider.
enum	LoginProviderKind	A provider a consumer may interactively sign in with.
final record	ManagedPluginRetryEntry	Retry outcome for one plugin required by managed settings.
enum	ManagedPluginRetryStatus	What retrying did for one plugin required by managed settings.
final record	ManagedSettingMeta	Lock state and provenance of one managed setting.
enum	ManagedSettingsChannel	A channel accepted by managedSettings.compose.
final record	ManagedSettingsComposeLayer	One candidate channel; absent settings represents a channel that delivered no document.
final record	ManagedSettingsComposeParams	Candidate managed-settings documents to merge without applying them.
final record	ManagedSettingsComposeResult	The effective managed settings the runtime would enforce for the given documents, in the same shape `managedSettings.resolve` returns.
final record	ManagedSettingsDiagnostic	One validation finding for a managed-settings document.
enum	ManagedSettingsDiagnosticSeverity	Severity of a managed-settings validation finding.
final record	ManagedSettingsLayer	One managed-settings channel and the document it delivered.
final record	ManagedSettingsMeta	Per-key lock state and provenance for `ManagedSettingsValues`, with the same field names.
final record	ManagedSettingsReadResult	Validated device-managed settings discovered before a session exists.
final record	ManagedSettingsResolvedData	Effective enterprise managed settings and contributing channels.
final record	ManagedSettingsResolveParams	Request parameters for the managedSettings.resolve RPC method.
final record	ManagedSettingsResolveResult	Effective enterprise managed settings for an account, resolved without a session.
final record	ManagedSettingsSchemaResult	The authoring JSON schema for managed settings recognized by this runtime.
final record	ManagedSettingsValidateParams	A candidate managed-settings document to validate without applying it.
final record	ManagedSettingsValidateResult	Result of validating a managed-settings document.
final record	ManagedSettingsValues	Typed effective values of managed settings.
final record	McpApplyInstallParams	Applies exactly one previously prepared operation on its original connection.
final record	McpApplyUninstallParams	One-use application of the exact retained removal plan.
final record	McpConfigAddParams	MCP server name and configuration to add to user configuration.
final record	McpConfigDisableParams	MCP server names to disable for new sessions.
final record	McpConfigEnableParams	MCP server names to enable for new sessions.
final record	McpConfigListResult	User-configured MCP servers, keyed by server name.
final record	McpConfigRemoveParams	MCP server name to remove from user configuration.
final record	McpConfigUpdateParams	MCP server name and replacement configuration to write to user configuration.
final record	McpConfiguredServer	Effective MCP configuration entry.
final record	McpConfiguredServerState	Observational state for a matching already materialized MCP server.
final record	McpDiscoverParams	Optional working directory used as context for MCP server discovery.
final record	McpDiscoverResult	MCP servers discovered from user, workspace, plugin, and built-in sources.
final record	McpExecuteSamplingResult	MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'.
final record	McpInstallationsCancelParams	Existing-operation control.
final record	McpInstallationsListParams	New-work inventory or recovery request under an explicitly selected existing session.
final record	McpInstallationsRecoverParams	New-work inventory or recovery request under an explicitly selected existing session.
final record	McpInstallationsStatusParams	Existing-operation control.
final record	McpPlanInstallParams	A side-effect-free request for an MCP install plan.
final class	McpPlanInstallRequest	A side-effect-free request for an MCP install plan.
final record	McpPlanUninstallParams	Read-only preparation of one owned removal under fresh selected-session authority.
final record	McpPrepareInstallParams	Side-effect-free preparation of one original bound remote MCP choice.
final record	ModelArtifactDetails	Provider-reported model artifact metadata.
final record	ModelProviderAdapterDescriptor	A normalized model-provider adapter in the session's effective catalog.
final record	ModelProviderAdapterOperationDescriptor	An operation supported by a model-provider adapter.
final record	ModelProviderAttribution	Contributor attribution, independent of routing identity and authorization.
final record	ModelProviderAutomaticDiscoveryPolicy	Adapter-declared policy that tells clients whether discovery may run automatically.
final record	ModelProviderDescriptor	One model provider available to the session — the model analog of the account `ProviderDescriptor`.
final record	ModelProviderInstance	A normalized model-provider instance discovered by the runtime.
final record	ModelProviderInstanceReference	Serializable reference to a discovered provider instance.
enum	ModelProviderKind	The neutral kind of a model provider — the model analog of `AccountKind`.
final record	ModelProviderOperationOutcome	Typed provider-operation outcome.
final record	ModelProviderProvenance	Attribution for the adapter that produced a provider row.
final record	ModelProviderRef	A neutral reference to the model provider that produced a model: an opaque id, a human-readable label, and the provider kind.
final record	ModelProviderWarning	A non-fatal provider observation warning.
final record	ModelsGetBuiltInCatalogResult	The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata.
final record	ModelsListParams	Request parameters for the models.list RPC method.
final record	ModelsListResult	List of Copilot models available to the resolved user, including capabilities and billing metadata.
enum	ModelSwitchAutoTierStatus	Whether the requested preference was already effective or was accepted for later transactional activation.
final record	OpenCanvasInstance	Open canvas instance snapshot.
enum	PermissionMode	Current or requested permission mode.
enum	PermissionModeSource	Optional source for permission-mode telemetry.
final record	PingParams	Optional message to echo back to the caller.
final record	PingResult	Server liveness response, including the echoed message, current server timestamp, and protocol version.
final record	PluginsBuiltinSetParams	Trusted built-in plugin directories to use for this runtime process.
final record	PluginsDisableParams	Plugin names (or specs) to disable, plus the optional working directory the repository-controlled guard is evaluated against.
final record	PluginsEnableParams	Plugin names (or specs) to enable, plus the optional working directory the repository-controlled guard is evaluated against.
final record	PluginsInstallParams	Plugin source and optional working directory for relative-path resolution.
final record	PluginsInstallResult	Result of installing a plugin.
final record	PluginsListResult	Plugins installed in user/global state.
final record	PluginsMarketplacesAddParams	Marketplace source and optional working directory for relative-path resolution.
final record	PluginsMarketplacesAddResult	Result of registering a new marketplace.
final record	PluginsMarketplacesBrowseParams	Name of the marketplace whose plugin catalog to fetch.
final record	PluginsMarketplacesBrowseResult	Plugins advertised by the marketplace.
final record	PluginsMarketplacesListResult	All registered marketplaces, including built-in defaults.
final record	PluginsMarketplacesRefreshParams	Request parameters for the plugins.marketplaces.refresh RPC method.
final record	PluginsMarketplacesRefreshResult	Result of refreshing one or more marketplace catalogs.
final record	PluginsMarketplacesRemoveParams	Name of the marketplace to remove and an optional force flag.
final record	PluginsMarketplacesRemoveResult	Outcome of the remove attempt, including dependent-plugin info when applicable.
final record	PluginsUninstallParams	Name (or spec) of the plugin to uninstall.
final record	PluginsUpdateAllResult	Result of updating all installed plugins.
final record	PluginsUpdateParams	Name (or spec) of the plugin to update.
final record	PluginsUpdateResult	Result of updating a single plugin.
enum	ProtocolExternalToolDefer	Controls whether the runtime may defer loading an external tool definition.
final record	ProtocolExternalToolDefinition	Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection.
final record	ProviderConfig	Custom model-provider configuration (BYOK).
final record	ProviderDescriptor	A provider offered for interactive login.
final record	ProviderQuotaState	An account quota reading.
final record	ProviderTokenGetTokenParams	Asks the SDK client to acquire a bearer token for a BYOK provider whose config set `hasBearerTokenProvider: true`.
final record	ProviderTokenGetTokenResult	A bearer token supplied by the SDK client for a BYOK provider.
final record	SandboxConfig	Resolved sandbox configuration.
enum	SandboxConfigSource	Origin of the sandbox choice supplied by the host.
final record	SandboxGetHostSupportResult	Whether the host running this runtime can run the command sandbox.
final record	SandboxProxyCaCreateParams	Identifies the credential hosts that the persistent certificate authority of the sandbox credential proxy must cover.
final record	SandboxProxyCaCreateResult	Result of creating the persistent certificate authority of the sandbox credential proxy.
final record	SandboxProxyCaGetStatusParams	Identifies the credential hosts that the persistent certificate authority of the sandbox credential proxy must cover.
final record	SandboxProxyCaGetStatusResult	Status of the persistent certificate authority of the sandbox credential proxy.
final record	SandboxProxyCaRemoveResult	Status of the persistent certificate authority of the sandbox credential proxy.
final record	SandboxProxyCaRotateParams	Identifies the credential hosts that the persistent certificate authority of the sandbox credential proxy must cover.
final record	SandboxProxyCaRotateResult	Status of the persistent certificate authority of the sandbox credential proxy.
enum	SandboxProxyCaState	State of the persistent certificate authority of the sandbox credential proxy.
final record	SandboxProxyCaTrustParams	Identifies the credential hosts that the persistent certificate authority of the sandbox credential proxy must cover.
final record	SandboxProxyCaTrustResult	Status of the persistent certificate authority of the sandbox credential proxy.
final record	SecretsAddFilterValuesParams	Secret values to add to the redaction filter.
final record	SecretsAddFilterValuesResult	Confirmation that the secret values were registered.
final record	SessionAbortParams	Parameters for aborting the current turn
final record	SessionAbortResult	Result of aborting the current turn
final record	SessionAccountsEnumerateParams	Enumerate request carrying the typed collection query.
final record	SessionAccountsGetParams	Read request carrying the typed datum query.
final record	SessionAccountsLoginAdvanceParams	Advance an in-flight login flow, optionally fulfilling an input-required step.
final record	SessionAccountsLoginBeginParams	Begin an interactive login flow for a provider kind.
final record	SessionAccountsLoginBeginResult	A started login flow: its opaque id and first step.
final record	SessionAccountsLoginCancelParams	Cancel an in-flight login flow.
final record	SessionAccountsSetParams	Mutation request carrying the typed write command.
final record	SessionAccountsSetResult	Result of a non-interactive accounts mutation.
final record	SessionAgentDeselectParams	Identifies the target session.
final record	SessionAgentGetCurrentParams	Identifies the target session.
final record	SessionAgentGetCurrentResult	The currently selected custom agent, or null when using the default agent.
final record	SessionAgentListParams	Request parameters for the session.agent.list RPC method.
final record	SessionAgentListResult	Agents available to the session.
final record	SessionAgentReloadParams	Identifies the target session.
final record	SessionAgentReloadResult	Custom agents available to the session after reloading definitions from disk.
final record	SessionAgentSelectParams	Name of the custom agent to select for subsequent turns.
final record	SessionAgentSelectResult	The newly selected custom agent.
final record	SessionAgentSetPromptParams	An in-memory authored prompt override for an available agent.
final record	SessionAutopilotObjectiveGetStateParams	Identifies the target session.
final record	SessionAutopilotObjectiveGetStateResult	Canonical runtime state for the session's current autopilot objective.
final record	SessionCancelAllBackgroundAgentsParams	Identifies the target session.
final record	SessionCanvasActionInvokeParams	Canvas action invocation parameters.
final record	SessionCanvasActionInvokeResult	Canvas action invocation result.
final record	SessionCanvasCloseParams	Canvas close parameters.
final record	SessionCanvasListOpenParams	Identifies the target session.
final record	SessionCanvasListOpenResult	Live open-canvas snapshot.
final record	SessionCanvasListParams	Identifies the target session.
final record	SessionCanvasListResult	Declared canvases available in this session.
final record	SessionCanvasOpenParams	Canvas open parameters.
final record	SessionCanvasOpenResult	Open canvas instance snapshot.
final record	SessionCommandsEnqueueParams	Slash-prefixed command string to enqueue for FIFO processing.
final record	SessionCommandsExecuteParams	Slash command name and argument string to execute synchronously.
final record	SessionCommandsExecuteResult	Error message produced while executing the command, if any.
final record	SessionCommandsHandlePendingCommandParams	Pending command request ID and an optional error if the client handler failed.
final record	SessionCommandsHandlePendingCommandResult	Indicates whether the pending client-handled command was completed successfully.
final record	SessionCommandsInvokeParams	Slash command name and optional raw input string to invoke.
final record	SessionCommandsListParams	Request parameters for the session.commands.list RPC method.
final record	SessionCommandsListResult	Slash commands available in the session, after applying any include/exclude filters.
final record	SessionCommandsRespondToQueuedCommandParams	Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).
final record	SessionCommandsRespondToQueuedCommandResult	Indicates whether the queued-command response was matched to a pending request.
final record	SessionCompletionsGetTriggerCharactersParams	Identifies the target session.
final record	SessionCompletionsGetTriggerCharactersResult	Characters that, when typed in the composer, should trigger a `completions.request`.
final record	SessionCompletionsRequestParams	Request host-driven completions for the current composer input.
final record	SessionCompletionsRequestResult	Host-driven completion items for the current composer input.
final record	SessionConnectorsConnectParams	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
final record	SessionConnectorsContinueConnectionParams	Explicitly bounded continuation of a pending Connector connection.
final record	SessionConnectorsDisconnectParams	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
final record	SessionConnectorsDisconnectResult	Authoritative result after disconnect and MCP reconciliation.
final record	SessionConnectorsGetAccountParams	Identifies the target session.
final record	SessionConnectorsGetCapabilitiesParams	Identifies the target session.
final record	SessionConnectorsGetCapabilitiesResult	Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
final record	SessionConnectorsGetStatusParams	Identifies the target session.
final record	SessionConnectorsGetStatusResult	Authoritative session connector state.
final record	SessionConnectorsListParams	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
final record	SessionConnectorsListResult	Validated Connector catalog snapshot cached by the session.
final record	SessionConnectorsReconcileParams	Requests authoritative Connector-to-MCP reconciliation for the pinned account.
final class	SessionConnectorsReconcileRequest	Requests authoritative Connector-to-MCP reconciliation for the pinned account.
final record	SessionConnectorsReconcileResult	Authoritative session connector state.
final record	SessionConnectorsReconnectParams	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
final record	SessionConnectorsRefreshParams	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
final record	SessionConnectorsRefreshResult	Validated Connector catalog snapshot cached by the session.
final record	SessionContentExclusionCheckPathsParams	Local file system absolute paths within the session working directory to check against its content-exclusion policy.
final record	SessionContentExclusionCheckPathsResult	Batch content-exclusion result.
final record	SessionCustomizationsReloadParams	Identifies the target session.
final record	SessionDebugCollectLogsParams	Options for collecting a session debug bundle with configurable redaction.
final record	SessionDebugCollectLogsResult	Result of collecting a session debug bundle.
final record	SessionDiagnosticsConfigureParams	Patch session diagnostic thresholds for explicitly supplied sources.
final record	SessionDiagnosticsConfigureResult	Per-source session diagnostics configuration.
final record	SessionDiagnosticsReadParams	Cursor-based request for session diagnostics.
final record	SessionDiagnosticsReadResult	One cursor-addressed page of retained session diagnostics.
final record	SessionEventLogReadParams	Cursor, batch size, and optional long-poll/filter parameters for reading session events.
final record	SessionEventLogReadResult	Batch of session events returned by a read, with cursor and continuation metadata.
final record	SessionEventLogRegisterInterestParams	Event type to register consumer interest for, used by runtime gating logic.
final record	SessionEventLogRegisterInterestResult	Opaque handle representing an event-type interest registration.
final record	SessionEventLogReleaseInterestParams	Opaque handle previously returned by `registerInterest` to release.
final record	SessionEventLogReleaseInterestResult	Indicates whether the operation succeeded.
final record	SessionEventLogTailParams	Identifies the target session.
final record	SessionEventLogTailResult	Snapshot of the current tail cursor without returning any events.
final record	SessionExtensionsDisableParams	Source-qualified extension identifier to disable for the session.
final record	SessionExtensionsEnableParams	Source-qualified extension identifier to enable for the session.
final record	SessionExtensionsListParams	Identifies the target session.
final record	SessionExtensionsListResult	Extensions discovered for the session, with their current status.
final record	SessionExtensionsReconcileParams	Identifies the target session.
final record	SessionExtensionsReconcileResult	Extensions discovered for the session, with their current status.
final record	SessionExtensionsReloadParams	Identifies the target session.
final record	SessionExtensionsSendAttachmentsToMessageParams	Parameters for session.extensions.sendAttachmentsToMessage.
final record	SessionFleetStartParams	Parameters for starting fleet orchestration: an optional user prompt combined with the fleet instructions, plus the send options forwarded to the resulting turn.
final record	SessionFleetStartResult	Indicates whether fleet mode was successfully activated.
final record	SessionFsAppendFileParams	File path, content to append, and optional mode for the client-provided session filesystem.
final record	SessionFsExistsParams	Path to test for existence in the client-provided session filesystem.
final record	SessionFsExistsResult	Indicates whether the requested path exists in the client-provided session filesystem.
final record	SessionFsMkdirParams	Directory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode.
final record	SessionFsReaddirParams	Directory path whose entries should be listed from the client-provided session filesystem.
final record	SessionFsReaddirResult	Names of entries in the requested directory, or a filesystem error if the read failed.
final record	SessionFsReaddirWithTypesParams	Directory path whose entries (with type information) should be listed from the client-provided session filesystem.
final record	SessionFsReaddirWithTypesResult	Entries in the requested directory paired with file/directory type information, or a filesystem error if the read failed.
final record	SessionFsReadFileBytesParams	Path of the binary file to read from the client-provided session filesystem.
final record	SessionFsReadFileBytesResult	File bytes as standard base64, or a filesystem error if the read failed.
final record	SessionFsReadFileParams	Path of the file to read from the client-provided session filesystem.
final record	SessionFsReadFileResult	File content as a UTF-8 string, or a filesystem error if the read failed.
final record	SessionFsRenameParams	Source and destination paths for renaming or moving an entry in the client-provided session filesystem.
final record	SessionFsRmParams	Path to remove from the client-provided session filesystem, with options for recursive removal and force.
final record	SessionFsSetProviderParams	Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
final record	SessionFsSetProviderResult	Indicates whether the calling client was registered as the session filesystem provider.
final record	SessionFsSqliteExistsParams	Identifies the target session.
final record	SessionFsSqliteExistsResult	Indicates whether the per-session SQLite database already exists.
final record	SessionFsSqliteQueryParams	SQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.
final record	SessionFsSqliteTransactionError	Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried.
final record	SessionFsSqliteTransactionParams	Statements to execute atomically.
final record	SessionFsSqliteTransactionResult	Per-statement results, or a classified transaction error.
final record	SessionFsSqliteTransactionStatement	One statement in an atomic SQLite transaction.
final record	SessionFsStatParams	Path whose metadata should be returned from the client-provided session filesystem.
final record	SessionFsStatResult	Filesystem metadata for the requested path, or a filesystem error if the stat failed.
final record	SessionFsWriteFileBytesParams	File path, standard-base64-encoded bytes to write, and optional mode for the client-provided session filesystem.
final record	SessionFsWriteFileParams	File path, content to write, and optional mode for the client-provided session filesystem.
final record	SessionGitHubAuthGetStatusParams	Identifies the target session.
final record	SessionGitHubAuthGetStatusResult	Authentication status and account metadata for the session.
final record	SessionGitHubAuthSetCredentialsParams	New auth credentials to install on the session.
final record	SessionGitHubAuthSetCredentialsResult	Indicates whether the credential update succeeded.
final record	SessionHistoryAbortManualCompactionParams	Identifies the target session.
final record	SessionHistoryAbortManualCompactionResult	Indicates whether an in-progress manual compaction was aborted.
final record	SessionHistoryCancelBackgroundCompactionParams	Identifies the target session.
final record	SessionHistoryCancelBackgroundCompactionResult	Indicates whether an in-progress background compaction was cancelled.
final record	SessionHistoryClearContextParams	Parameters for clearing the conversation and seeding the window that replaces it.
final record	SessionHistoryClearContextResult	What a successful clear removed.
final record	SessionHistoryCompactParams	Request parameters for the session.history.compact RPC method.
final record	SessionHistoryCompactResult	Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.
final record	SessionHistoryListRewindPointsParams	Identifies the target session.
final record	SessionHistoryListRewindPointsResult	Rewind points and file-change-tracking availability for the session.
final record	SessionHistoryPreviewRewindParams	Event boundary to preview for conversation-and-files rewind.
final record	SessionHistoryPreviewRewindResult	Files and aggregate changes for a prospective rewind.
final record	SessionHistoryRewindParams	Boundary and mode for rewinding session history.
final record	SessionHistoryRewindResult	Structured outcome of a rewind request.
final record	SessionHistorySummarizeForHandoffParams	Identifies the target session.
final record	SessionHistorySummarizeForHandoffResult	Markdown summary of the conversation context (empty when not available).
final record	SessionHistoryTruncateParams	Identifier of the event to truncate to; this event and all later events are removed.
final record	SessionHistoryTruncateResult	Number of events that were removed by the truncation.
final record	SessionInstructionsGetSourcesParams	Identifies the target session.
final record	SessionInstructionsGetSourcesResult	Instruction sources loaded for the session, in merge order.
final record	SessionInstructionsReloadParams	Identifies the target session.
final record	SessionInterruptMainTurnParams	Parameters for interrupting the main agent turn.
final record	SessionInterruptMainTurnResult	Result of interrupting the main agent turn.
final record	SessionLimitPredictionPredictParams	Request parameters for the session.limitPrediction.predict RPC method.
final record	SessionLogParams	Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.
final record	SessionLogResult	Identifier of the session event that was emitted for the log message.
final record	SessionLspInitializeParams	Parameters for (re)loading the merged LSP configuration set.
final record	SessionManagedSettingsGetParams	Identifies the target session.
final record	SessionManagedSettingsGetResult	Effective enterprise managed settings and contributing channels.
final record	SessionMcpAppsCallToolParams	MCP server, tool name, and arguments to invoke from an MCP App view.
final record	SessionMcpAppsDiagnoseParams	MCP server to diagnose MCP Apps wiring for.
final record	SessionMcpAppsDiagnoseResult	Diagnostic snapshot of MCP Apps wiring for the named server.
final record	SessionMcpAppsGetHostContextParams	Identifies the target session.
final record	SessionMcpAppsGetHostContextResult	Current host context advertised to MCP App guests.
final record	SessionMcpAppsListToolsParams	MCP server to list app-callable tools for.
final record	SessionMcpAppsListToolsResult	App-callable tools from the named MCP server.
final record	SessionMcpAppsReadResourceParams	MCP server and resource URI to fetch.
final record	SessionMcpAppsReadResourceResult	Resource contents returned by the MCP server.
final record	SessionMcpAppsSetHostContextParams	Host context to advertise to MCP App guests.
final record	SessionMcpCancelSamplingExecutionParams	The requestId previously passed to executeSampling that should be cancelled.
final record	SessionMcpCancelSamplingExecutionResult	Indicates whether an in-flight sampling execution with the given requestId was found and cancelled.
final record	SessionMcpDisableParams	Name of the MCP server to disable for the session.
final class	SessionMcpDisableRequest	Name of the MCP server to disable for the session.
final record	SessionMcpEnableParams	Name of the MCP server to enable for the session.
final class	SessionMcpEnableRequest	Name of the MCP server to enable for the session.
final record	SessionMcpExecuteSamplingParams	Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.
final record	SessionMcpExecuteSamplingResult	Outcome of an MCP sampling execution: success result, failure error, or cancellation.
final record	SessionMcpHeadersHandlePendingHeadersRefreshRequestParams	MCP headers refresh request id and the host response.
final record	SessionMcpHeadersHandlePendingHeadersRefreshRequestResult	Indicates whether the pending MCP headers refresh response was accepted.
final record	SessionMcpIsServerRunningParams	Server name to check running status for.
final record	SessionMcpIsServerRunningResult	Whether the named MCP server is running.
final record	SessionMcpListConfiguredParams	Identifies the target session.
final record	SessionMcpListConfiguredResult	Effective MCP configuration with optional live observations from matching already materialized servers.
final record	SessionMcpListParams	Identifies the target session.
final record	SessionMcpListResult	MCP servers configured for the session, with their connection status and host-level state.
final record	SessionMcpListToolsParams	Server name whose tool list should be returned.
final record	SessionMcpListToolsResult	Tools exposed by the connected MCP server.
final record	SessionMcpMoveLoadingToBackgroundParams	Identifies the target session.
final record	SessionMcpMoveLoadingToBackgroundResult	Result of moving in-flight MCP loading to the background.
final record	SessionMcpOauthAuthenticationStateChangedParams	Identifies the MCP server whose persisted OAuth credentials were updated.
final record	SessionMcpOauthCancelLoginParams	Targets only the original prepared/applying owned login on this exact session requester.
final record	SessionMcpOauthCancelLoginResult	Honest terminal cancellation result; persistence or recovery failures remain RPC errors.
final record	SessionMcpOauthCompleteParams	Host-delivered callback for a runtime-managed MCP OAuth login.
final record	SessionMcpOauthHandlePendingRequestParams	Pending MCP OAuth request ID and host-provided token or cancellation response.
final record	SessionMcpOauthHandlePendingRequestResult	Indicates whether the pending MCP OAuth response was accepted.
final record	SessionMcpOauthLoginParams	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback handling, and static OAuth client selection.
final class	SessionMcpOauthLoginRequest	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback handling, and static OAuth client selection.
final record	SessionMcpOauthLoginResult	OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.
final record	SessionMcpOauthPrepareLoginParams	Effect-free preparation bound to the existing local session, requester and installation, with frozen options.
final record	SessionMcpOauthPrepareLoginResult	An inert runtime-issued login handle.
final record	SessionMcpOauthProbeParams	Remote MCP server name for a passive OAuth status probe.
final class	SessionMcpOauthProbeRequest	Remote MCP server name for a passive OAuth status probe.
final record	SessionMcpOauthRespondParams	Pending MCP OAuth request id to respond to.
final record	SessionMcpOauthRespondResult	Indicates whether the pending MCP OAuth response was accepted.
final record	SessionMcpPromptsGetParams	MCP server, prompt name, and optional string-valued arguments.
final record	SessionMcpPromptsGetResult	Prompt messages returned by the MCP server without sending them to the model.
final record	SessionMcpPromptsListParams	MCP server whose prompts to enumerate.
final record	SessionMcpPromptsListResult	One page of prompts advertised by the named MCP server.
final record	SessionMcpReloadParams	Identifies the target session.
final record	SessionMcpRemoveGitHubParams	Identifies the target session.
final record	SessionMcpRemoveGitHubResult	Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).
final record	SessionMcpResourcesListParams	MCP server whose resources to enumerate.
final record	SessionMcpResourcesListResult	One page of resources advertised by the named MCP server.
final record	SessionMcpResourcesListTemplatesParams	MCP server whose resource templates to enumerate.
final record	SessionMcpResourcesListTemplatesResult	One page of resource templates advertised by the named MCP server.
final record	SessionMcpResourcesReadParams	MCP server and resource URI to fetch.
final record	SessionMcpResourcesReadResult	Resource contents returned by the MCP server.
final record	SessionMcpRestartServerParams	Server name and optional replacement configuration for an individual MCP server restart.
final class	SessionMcpRestartServerRequest	Server name and optional replacement configuration for an individual MCP server restart.
final record	SessionMcpSetEnvValueModeParams	Mode controlling how MCP server env values are resolved (`direct` or `indirect`).
final record	SessionMcpSetEnvValueModeResult	Env-value mode recorded on the session after the update.
final record	SessionMcpStartServerParams	Server name and optional configuration for an individual MCP server start.
final class	SessionMcpStartServerRequest	Server name and optional configuration for an individual MCP server start.
final record	SessionMcpStopServerParams	Server name for an individual MCP server stop.
final class	SessionMcpStopServerRequest	Server name for an individual MCP server stop.
final record	SessionMetadataActivityParams	Identifies the target session.
final record	SessionMetadataActivityResult	Current activity flags for the session.
final record	SessionMetadataContextInfoParams	Model identifier and token limits used to compute the context-info breakdown.
final record	SessionMetadataContextInfoResult	Token breakdown for the session's current context window, or null if uninitialized.
final record	SessionMetadataGetClientMetadataParams	Identifies the target session.
final record	SessionMetadataGetContextAttributionParams	Identifies the target session.
final record	SessionMetadataGetContextAttributionResult	Per-source attribution breakdown for the session's current context window, or null if uninitialized.
final record	SessionMetadataGetContextHeaviestMessagesParams	Parameters for the heaviest-messages query.
final record	SessionMetadataGetContextHeaviestMessagesResult	The heaviest individual messages in the session's context window, most-expensive first.
final record	SessionMetadataIsProcessingParams	Identifies the target session.
final record	SessionMetadataIsProcessingResult	Indicates whether the local session is currently processing a turn or background continuation.
final record	SessionMetadataRecomputeContextTokensParams	Model identifier to use when re-tokenizing the session's existing messages.
final record	SessionMetadataRecomputeContextTokensResult	Re-tokenize the session's existing messages against `modelId` and return the token totals.
final record	SessionMetadataRecordContextChangeParams	Updated working-directory/git context to record on the session.
final record	SessionMetadataSetWorkingDirectoryParams	Absolute path to set as the session's new working directory.
final record	SessionMetadataSetWorkingDirectoryResult	Update the session's working directory.
final record	SessionMetadataSnapshotParams	Identifies the target session.
final record	SessionMetadataSnapshotResult	Point-in-time snapshot of slow-changing session identifier and state fields
final record	SessionMetadataUpdateClientMetadataParams	Atomic patch for client-owned session metadata.
final record	SessionModeGetParams	Identifies the target session.
final record	SessionModelGetCurrentParams	Identifies the target session.
final record	SessionModelGetCurrentResult	The session's authoritative model snapshot.
final record	SessionModelListParams	Request parameters for the session.model.list RPC method.
final record	SessionModelListResult	The list of models available to this session.
final record	SessionModelSetAllowedModelsParams	Host-supplied exact model selection IDs to allow for this running session.
final record	SessionModelSetAllowedModelsResult	The applied host allowlist and effective session model policy after intersection.
final record	SessionModelSetReasoningEffortParams	Reasoning effort level to apply to the currently selected model.
final record	SessionModelSetReasoningEffortResult	Update the session's reasoning effort without changing the selected model.
final record	SessionModelSwitchAutoTierParams	An Auto preference request for the session.
final record	SessionModelSwitchAutoTierResult	Immediate acknowledgement and Auto preference snapshot after a switch request.
final record	SessionModelSwitchToParams	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
final class	SessionModelSwitchToRequest	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
final record	SessionModelSwitchToResult	The model identifier active on the session after the switch.
final record	SessionModeSetParams	Agent interaction mode to apply to the session.
final record	SessionModeSetResult	Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform.
final record	SessionNameGetParams	Identifies the target session.
final record	SessionNameGetResult	The session's friendly name, or null when not yet set.
final record	SessionNameSetAutoParams	Auto-generated session summary to apply as the session's name when no user-set name exists.
final record	SessionNameSetAutoResult	Indicates whether the auto-generated summary was applied as the session's name.
final record	SessionNameSetParams	New friendly name to apply to the session.
final record	SessionOptionsUpdateParams	Patch of mutable session options to apply to the running session.
final record	SessionOptionsUpdateResult	Indicates whether the session options patch was applied successfully.
final record	SessionPermissionsConfigureParams	Patch of permission policy fields to apply (omit a field to leave it unchanged).
final record	SessionPermissionsConfigureResult	Indicates whether the operation succeeded.
final record	SessionPermissionsFolderTrustAddTrustedParams	Folder path to add to trusted folders.
final record	SessionPermissionsFolderTrustAddTrustedResult	Indicates whether the operation succeeded.
final record	SessionPermissionsFolderTrustIsTrustedParams	Folder path to check for trust.
final record	SessionPermissionsFolderTrustIsTrustedResult	Folder trust check result.
final record	SessionPermissionsGetModeParams	No parameters.
final record	SessionPermissionsGetModeResult	Current permission mode.
final record	SessionPermissionsHandlePendingPermissionRequestParams	Pending permission request ID and the decision to apply (approve/reject and scope).
final record	SessionPermissionsHandlePendingPermissionRequestResult	Indicates whether the permission decision was applied; false when the request was already resolved.
final record	SessionPermissionsLocationsAddToolApprovalParams	Location-scoped tool approval to persist.
final record	SessionPermissionsLocationsAddToolApprovalResult	Indicates whether the operation succeeded.
final record	SessionPermissionsLocationsApplyParams	Working directory to load persisted location permissions for.
final record	SessionPermissionsLocationsApplyResult	Summary of persisted location permissions applied to the session.
final record	SessionPermissionsLocationsResolveParams	Working directory to resolve into a location-permissions key.
final record	SessionPermissionsLocationsResolveResult	Resolved location-permissions key and type.
final record	SessionPermissionsModifyRulesParams	Scope and add/remove instructions for modifying session- or location-scoped permission rules.
final record	SessionPermissionsModifyRulesResult	Indicates whether the operation succeeded.
final record	SessionPermissionsNotifyPromptShownParams	Notification payload describing the permission prompt that the client just rendered.
final record	SessionPermissionsNotifyPromptShownResult	Indicates whether the operation succeeded.
final record	SessionPermissionsPathsAddParams	Directory path to add to the session's allowed directories.
final record	SessionPermissionsPathsAddResult	Indicates whether the operation succeeded.
final record	SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams	Path to evaluate against the session's allowed directories.
final record	SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult	Indicates whether the supplied path is within the session's allowed directories.
final record	SessionPermissionsPathsIsPathWithinWorkspaceParams	Path to evaluate against the session's workspace (primary) directory.
final record	SessionPermissionsPathsIsPathWithinWorkspaceResult	Indicates whether the supplied path is within the session's workspace directory.
final record	SessionPermissionsPathsListParams	No parameters; returns the session's recursive directory grants and exact session-approved paths.
final record	SessionPermissionsPathsListResult	Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
final record	SessionPermissionsPathsUpdatePrimaryParams	Directory path to set as the session's new primary working directory.
final record	SessionPermissionsPathsUpdatePrimaryResult	Indicates whether the operation succeeded.
final record	SessionPermissionsPendingRequestsParams	No parameters; returns currently-pending permission requests for the session.
final record	SessionPermissionsPendingRequestsResult	List of pending permission requests reconstructed from event history.
final record	SessionPermissionsResetSessionApprovalsParams	Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
final record	SessionPermissionsResetSessionApprovalsResult	Indicates whether the operation succeeded.
final record	SessionPermissionsSetApproveAllParams	Allow-all toggle for tool permission requests, with an optional telemetry source.
final record	SessionPermissionsSetApproveAllResult	Indicates whether the operation succeeded.
final record	SessionPermissionsSetModeParams	Permission mode to apply for the session.
final record	SessionPermissionsSetModeResult	Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode.
final record	SessionPermissionsSetRequiredParams	Toggles whether permission prompts should be bridged into session events for this client.
final record	SessionPermissionsSetRequiredResult	Indicates whether the operation succeeded.
final record	SessionPermissionsUrlsSetUnrestrictedModeParams	Whether the URL-permission policy should run in unrestricted mode.
final record	SessionPermissionsUrlsSetUnrestrictedModeResult	Indicates whether the operation succeeded.
final record	SessionPlanDeleteParams	Identifies the target session.
final record	SessionPlanReadParams	Identifies the target session.
final record	SessionPlanReadResult	Existence, contents, and resolved path of the session plan file.
final record	SessionPlanReadSqlTodosParams	Identifies the target session.
final record	SessionPlanReadSqlTodosResult	Todo rows read from the session SQL database.
final record	SessionPlanReadSqlTodosWithDependenciesParams	Identifies the target session.
final record	SessionPlanReadSqlTodosWithDependenciesResult	Todo rows + dependency edges read from the session SQL database.
final record	SessionPlanUpdateParams	Replacement contents to write to the session plan file.
final record	SessionPluginsDisableParams	Plugin names (or specs) to disable in the session's authoritative working directory.
final record	SessionPluginsEnableParams	Plugin names (or specs) to enable in the session's authoritative working directory.
final record	SessionPluginsInstallParams	Plugin source resolved relative to the session's authoritative working directory.
final record	SessionPluginsInstallResult	Result of installing a plugin.
final record	SessionPluginsListParams	Identifies the target session.
final record	SessionPluginsListResult	Plugins installed for the session, with their enabled state and version metadata.
final record	SessionPluginsMarketplacesAddParams	Marketplace source and optional working directory for relative-path resolution.
final record	SessionPluginsMarketplacesAddResult	Result of registering a new marketplace.
final record	SessionPluginsMarketplacesBrowseParams	Name of the marketplace whose plugin catalog to fetch.
final record	SessionPluginsMarketplacesBrowseResult	Plugins advertised by the marketplace.
final record	SessionPluginsMarketplacesListParams	Identifies the target session.
final record	SessionPluginsMarketplacesListResult	All registered marketplaces, including built-in defaults.
final record	SessionPluginsMarketplacesRefreshParams	Request parameters for the session.plugins.marketplaces.refresh RPC method.
final record	SessionPluginsMarketplacesRefreshResult	Result of refreshing one or more marketplace catalogs.
final record	SessionPluginsMarketplacesRemoveParams	Name of the marketplace to remove and an optional force flag.
final record	SessionPluginsMarketplacesRemoveResult	Outcome of the remove attempt, including dependent-plugin info when applicable.
final record	SessionPluginsReloadParams	Request parameters for the session.plugins.reload RPC method.
final record	SessionPluginsRetryManagedParams	Request parameters for the session.plugins.retryManaged RPC method.
final record	SessionPluginsRetryManagedResult	Per-plugin outcomes of retrying the plugins required by the session's managed settings.
final record	SessionPluginsUninstallParams	Name (or spec) of the plugin to uninstall.
final record	SessionPluginsUpdateParams	Name (or spec) of the plugin to update.
final record	SessionPluginsUpdateResult	Result of updating a single plugin.
final record	SessionProviderAddParams	BYOK providers and/or models to add to the session's registry at runtime.
final record	SessionProviderAddResult	The selectable model entries synthesized for the models added by this call.
final record	SessionProviderGetEndpointParams	Request parameters for the session.provider.getEndpoint RPC method.
final record	SessionProviderGetEndpointResult	A snapshot of the provider endpoint the session is currently configured to talk to.
final record	SessionProvidersDiscoverParams	Provider discovery parameters.
final record	SessionProvidersDiscoverResult	Provider instances found by a discovery operation.
final record	SessionProvidersGetCatalogParams	Identifies the target session.
final record	SessionProvidersGetCatalogResult	Normalized model-provider adapter definitions available to the session, not discovered instances.
final record	SessionProvidersGetStatusParams	Provider status request parameters.
final record	SessionProvidersGetStatusResult	Current health information for a provider instance.
final record	SessionProvidersModelsListParams	Provider model inventory request parameters.
final record	SessionProvidersModelsListResult	Models offered for agent conversations by one provider instance.
final record	SessionProvidersModelsPrepareConfigurationParams	A discovered instance and one of its models to translate into provider configuration.
final record	SessionProvidersModelsPrepareConfigurationResult	Provider configuration prepared from a discovered model.
final record	SessionProviderSyncParams	Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
final record	SessionProviderSyncResult	The selectable model entries and selection ids synthesized for the synchronized BYOK models.
final record	SessionProviderWithdrawParams	Host-managed model selection ids to withdraw from the session's BYOK registry.
final record	SessionProviderWithdrawResult	What the withdrawal actually removed from the registry.
final record	SessionQueueAppendSteeringParams	Append to one pending steering message without changing its identity or delivery position.
final record	SessionQueueAppendSteeringResult	Result of editing a queued message.
final record	SessionQueueClearParams	Identifies the target session.
final record	SessionQueueDuplicateAtParams	Parameters for duplicating a queued item.
final record	SessionQueueDuplicateAtResult	Result of duplicating a queued item.
final record	SessionQueueInsertAtParams	Parameters for inserting a queued message at a public visible position.
final record	SessionQueueInsertAtResult	Result of inserting a queued message.
final record	SessionQueueMoveItemParams	Parameters for moving a queued item by stable id.
final record	SessionQueueMoveItemResult	Result of moving a queued item.
final record	SessionQueuePendingItemsParams	Identifies the target session.
final record	SessionQueuePendingItemsResult	Snapshot of the session's pending queued items and immediate-steering messages.
final record	SessionQueueRemoveAtParams	Parameters for removing a queued item by stable id.
final record	SessionQueueRemoveAtResult	Result of removing a queued item.
final record	SessionQueueRemoveMostRecentParams	Identifies the target session.
final record	SessionQueueRemoveMostRecentResult	Indicates whether a user-facing pending item was removed.
final record	SessionQueueSendNowParams	Parameters for steering a queued message into a live turn.
final record	SessionQueueSendNowResult	Result of trying to steer a queued message into a live turn.
final record	SessionQueueSetDrainPausedParams	Parameters for acquiring or releasing the queued-lane drain pause.
final record	SessionQueueUpdateTextParams	Parameters for editing a single queued message.
final record	SessionQueueUpdateTextResult	Result of editing a queued message.
final record	SessionQueueWithdrawMessageParams	Conditional withdrawal of a single user message, from its queue or from the running turn it started.
final record	SessionQueueWithdrawMessageResult	Result of withdrawing a user message.
final record	SessionQuotaGetParams	Identifies the target session.
final record	SessionQuotaGetResult	The incumbent session-owned quota and account projection.
final record	SessionQuotaRefreshParams	Identifies the target session.
final record	SessionQuotaRefreshResult	The incumbent session-owned quota and account projection.
final record	SessionQuotaTakeWarningsParams	Identifies the target session.
final record	SessionRemoteDisableParams	Identifies the target session.
final record	SessionRemoteEnableParams	Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.
final record	SessionRemoteEnableResult	GitHub URL for the session and a flag indicating whether remote steering is enabled.
final record	SessionRemoteNotifySteerableChangedParams	New remote-steerability state to persist as a `session.remote_steerable_changed` event.
final record	SessionSandboxDisableForSessionParams	Request to disable sandboxing for the current session while resolving an active sandbox-bypass permission prompt.
final record	SessionSandboxDisableForSessionResult	Result of attempting to disable sandboxing for the current session.
final record	SessionSandboxGetEnforcementStatusParams	Identifies the target session.
final record	SessionSandboxGetEnforcementStatusResult	Managed sandbox enforcement state for a session.
final record	SessionSandboxGrantPathForRequestParams	Request to accept the sandbox path grant offered on an active sandbox escalation permission prompt.
final record	SessionSandboxGrantPathForRequestResult	Result of accepting a sandbox path grant.
final record	SessionsBulkDeleteParams	Session IDs to close, deactivate, and delete from disk.
final record	SessionsBulkDeleteResult	Map of sessionId -> bytes freed by removing the session's workspace directory.
final record	SessionsCheckInUseParams	Session IDs to test for live in-use locks.
final record	SessionsCheckInUseResult	Session IDs from the input set that are currently in use by another process.
final record	SessionScheduleListParams	Identifies the target session.
final record	SessionScheduleListResult	Snapshot of the currently active recurring prompts for this session.
final record	SessionScheduleStopParams	Identifier of the scheduled prompt to remove.
final record	SessionScheduleStopResult	Remove a scheduled prompt by id.
final record	SessionsCloseParams	Session ID to close.
final record	SessionsConnectParams	Remote session connection parameters.
final record	SessionsConnectResult	Remote session connection result.
final record	SessionSendMessagesParams	Parameters for sending zero or more user messages to the session in a single turn.
final record	SessionSendMessagesResult	Result of sending zero or more user messages
final record	SessionSendParams	Parameters for sending a user message to the session
final record	SessionSendResult	Result of sending a user message
final record	SessionsEnrichMetadataParams	Session metadata records to enrich with summary and context information.
final record	SessionsEnrichMetadataResult	The enriched metadata records, with summary and context fields backfilled where available.
final record	SessionsFindByPrefixParams	UUID prefix to resolve to a unique session ID.
final record	SessionsFindByPrefixResult	Session ID matching the prefix, omitted when no unique match exists.
final record	SessionsFindByTaskIdParams	GitHub task ID to look up.
final record	SessionsFindByTaskIdResult	ID of the local session bound to the given GitHub task, or omitted when none.
final record	SessionsForkParams	Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.
final record	SessionsForkResult	Identifier and optional friendly name assigned to the newly forked session.
final record	SessionsGetClientMetadataParams	Bounded batch request for client-owned metadata from persisted local sessions.
final record	SessionsGetLastForContextParams	Optional working-directory context used to score session relevance.
final record	SessionsGetLastForContextResult	Most-relevant session ID for the supplied context, or omitted when no sessions exist.
final record	SessionsGetRemoteControlStatusResult	Wrapper for the singleton's current status.
final record	SessionsGetSizesResult	Map of sessionId -> on-disk size in bytes for each session's workspace directory.
final record	SessionShellCancelUserRequestedParams	User-requested shell execution cancellation handle.
final record	SessionShellCancelUserRequestedResult	Cancellation result for a user-requested shell command.
final record	SessionShellExecParams	Shell command to run, with optional working directory and timeout in milliseconds.
final record	SessionShellExecResult	Identifier of the spawned shell process, usable with shell.kill while the process is running.
final record	SessionShellExecuteUserRequestedParams	User-requested shell command and cancellation handle.
final record	SessionShellExecuteUserRequestedResult	Result of a user-requested shell command.
final record	SessionShellKillParams	Identifier of a process previously returned by "shell.exec" and the signal to send.
final record	SessionShellKillResult	Indicates whether the signal was delivered; false if the process was unknown or already exited.
final record	SessionShutdownParams	Parameters for shutting down the session
final record	SessionSkillsDisableParams	Name of the skill to disable for the session.
final record	SessionSkillsEnableParams	Name of the skill to enable for the session.
final record	SessionSkillsEnsureLoadedParams	Identifies the target session.
final record	SessionSkillsGetInvokedParams	Identifies the target session.
final record	SessionSkillsGetInvokedResult	Skills invoked during this session, ordered by invocation time (most recent last).
final record	SessionSkillsListParams	Identifies the target session.
final record	SessionSkillsListResult	Skills available to the session, with their enabled state.
final record	SessionSkillsReloadParams	Identifies the target session.
final record	SessionSkillsReloadResult	Diagnostics from reloading skill definitions, with warnings and errors as separate lists.
final record	SessionsListParams	Optional source filter, metadata-load limit, and context filter applied to the returned sessions.
final record	SessionsListResult	Sessions matching the filter, ordered most-recently-modified first.
final record	SessionsLoadDeferredRepoHooksParams	Active session ID whose deferred repo-level hooks should be loaded.
final record	SessionsLoadDeferredRepoHooksResult	Queued repo-level startup prompts and the total hook command count after loading.
final record	SessionsOpenResult	Result of opening a session.
final record	SessionsPruneOldParams	Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).
final record	SessionsPruneOldResult	Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.
final record	SessionsReadPersistedEventsParams	Pagination options for reading an inactive or active local session's persisted event journal.
final record	SessionsReadPersistedEventsResult	Batch of session events returned by a read, with cursor and continuation metadata.
final record	SessionsReleaseLockParams	Session ID whose in-use lock should be released.
final record	SessionsReloadPluginHooksParams	Active session ID and an optional flag for deferring repo-level hooks until folder trust.
final record	SessionsSaveParams	Session ID whose pending events should be flushed to disk.
final record	SessionsSetAdditionalPluginsParams	Manager-wide additional plugins to register; replaces any previously-configured set.
final record	SessionsSetRemoteControlSteeringParams	Patch for the singleton's steering state.
final record	SessionsSetRemoteControlSteeringResult	Wrapper for the singleton's current status.
final record	SessionsStartRemoteControlParams	Parameters for attaching the remote-control singleton to a session.
final record	SessionsStartRemoteControlResult	Wrapper for the singleton's current status.
final record	SessionsStopRemoteControlParams	Request parameters for the sessions.stopRemoteControl RPC method.
final record	SessionsStopRemoteControlResult	Outcome of a stopRemoteControl call.
final record	SessionsTransferRemoteControlParams	Parameters for atomically rebinding the remote-control singleton.
final record	SessionsTransferRemoteControlResult	Outcome of a transferRemoteControl call.
final record	SessionSuspendParams	Identifies the target session.
final record	SessionTasksCancelParams	Identifier of the background task to cancel.
final record	SessionTasksCancelResult	Indicates whether the background task was successfully cancelled.
final record	SessionTasksGetCurrentPromotableParams	Identifies the target session.
final record	SessionTasksGetCurrentPromotableResult	The first sync-waiting task that can currently be promoted to background mode.
final record	SessionTasksGetProgressParams	Identifier of the background task to fetch progress for.
final record	SessionTasksGetProgressResult	Progress information for the task, or null when no task with that ID is tracked.
final record	SessionTasksListParams	Identifies the target session.
final record	SessionTasksListResult	Background tasks currently tracked by the session.
final record	SessionTasksPromoteCurrentToBackgroundParams	Identifies the target session.
final record	SessionTasksPromoteCurrentToBackgroundResult	The promoted task as it now exists in background mode, omitted if no promotable task was waiting.
final record	SessionTasksPromoteToBackgroundParams	Identifier of the task to promote to background mode.
final record	SessionTasksPromoteToBackgroundResult	Indicates whether the task was successfully promoted to background mode.
final record	SessionTasksRefreshParams	Identifies the target session.
final record	SessionTasksRegisterParams	Registers or reclaims a client-owned task.
final record	SessionTasksRegisterResult	Result of registering or reclaiming a client-owned task.
final record	SessionTasksRemoveParams	Identifier of the completed or cancelled task to remove from tracking.
final record	SessionTasksRemoveResult	Indicates whether the task was removed.
final record	SessionTasksSendMessageParams	Identifier of the target agent task, message content, and optional sender agent ID.
final record	SessionTasksSendMessageResult	Indicates whether the message was delivered, with an error message when delivery failed.
final record	SessionTasksStartAgentParams	Agent type, prompt, name, and optional description and model override for the new task.
final record	SessionTasksStartAgentResult	Identifier assigned to the newly started background agent task.
final record	SessionTasksUpdateParams	Updates a client-owned task.
final record	SessionTasksUpdateResult	Result of publishing a client-owned task update.
final record	SessionTasksWaitForPendingParams	Identifies the target session.
final record	SessionTelemetryGetEngagementIdParams	Identifies the target session.
final record	SessionTelemetryGetEngagementIdResult	Telemetry engagement ID for the session, when available.
final record	SessionTelemetrySetFeatureOverridesParams	Feature override key/value pairs to attach to subsequent telemetry events from this session.
final record	SessionToolsExecuteParams	A tool name and arguments to execute through the session's native invocation pipeline.
final record	SessionToolsGetBuiltinDescriptorsParams	Options controlling how Rust-owned built-in tool descriptors are materialized.
final record	SessionToolsGetBuiltinDescriptorsResult	Rust-owned built-in tool descriptors for the session.
final record	SessionToolsGetCurrentMetadataParams	Identifies the target session.
final record	SessionToolsGetCurrentMetadataResult	Current lightweight tool metadata snapshot for the session.
final record	SessionToolsHandlePendingToolCallParams	Pending external tool call request ID, with the tool result or an error describing why it failed.
final record	SessionToolsHandlePendingToolCallResult	Indicates whether the external tool call result was handled successfully.
final record	SessionToolsInitializeAndValidateParams	Identifies the target session.
final record	SessionToolsListPendingRequestsParams	No parameters; returns the external tool calls of the session and its sub-agents that are still waiting for a result.
final record	SessionToolsListPendingRequestsResult	External tool calls still waiting for a result.
final record	SessionToolsSetParams	Complete externally implemented tool list for the calling connection.
final record	SessionToolsTaskCompleteEventDataParams	Task-completion tool arguments and final result used to build a label-safe session event payload.
final record	SessionToolsTaskCompleteEventDataResult	Task completion notification with summary from the agent
final record	SessionToolsUpdateSubagentSettingsParams	Subagent settings to apply to the current session
final record	SessionUiElicitationParams	Prompt message and JSON schema describing the form fields to elicit from the user.
final record	SessionUiElicitationResult	The elicitation response (accept with form values, decline, or cancel)
final record	SessionUiEphemeralQueryParams	Transient question to answer without adding it to conversation history.
final record	SessionUiEphemeralQueryResult	Completed transient query.
final record	SessionUiHandlePendingAutoModeSwitchParams	Request ID of a pending `auto_mode_switch.requested` event and the user's response.
final record	SessionUiHandlePendingAutoModeSwitchResult	Indicates whether the pending UI request was resolved by this call.
final record	SessionUiHandlePendingElicitationParams	Pending elicitation request ID and the user's response (accept/decline/cancel + form values).
final record	SessionUiHandlePendingElicitationResult	Indicates whether the elicitation response was accepted; false if it was already resolved by another client.
final record	SessionUiHandlePendingExitPlanModeParams	Request ID of a pending `exit_plan_mode.requested` event and the user's response.
final record	SessionUiHandlePendingExitPlanModeResult	Indicates whether the pending UI request was resolved by this call.
final record	SessionUiHandlePendingSamplingParams	Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).
final record	SessionUiHandlePendingSamplingResult	Indicates whether the pending UI request was resolved by this call.
final record	SessionUiHandlePendingSessionLimitsExhaustedParams	Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action.
final record	SessionUiHandlePendingSessionLimitsExhaustedResult	Indicates whether the pending UI request was resolved by this call.
final record	SessionUiHandlePendingUserInputParams	Request ID of a pending `user_input.requested` event and the user's response.
final record	SessionUiHandlePendingUserInputResult	Indicates whether the pending UI request was resolved by this call.
final record	SessionUiRegisterDirectAutoModeSwitchHandlerParams	Identifies the target session.
final record	SessionUiRegisterDirectAutoModeSwitchHandlerResult	Register an in-process handler for `auto_mode_switch.requested` events.
final record	SessionUiUnregisterDirectAutoModeSwitchHandlerParams	Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.
final record	SessionUiUnregisterDirectAutoModeSwitchHandlerResult	Indicates whether the handle was active and the registration count was decremented.
final record	SessionUsageGetMetricsParams	Identifies the target session.
final record	SessionUsageGetMetricsResult	Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals.
final record	SessionVisibilityGetParams	Identifies the target session.
final record	SessionVisibilityGetResult	Current sharing status and shareable GitHub URL for a session.
final record	SessionVisibilitySetParams	Desired sharing status for the session.
final record	SessionVisibilitySetResult	Effective sharing status and shareable GitHub URL after updating session visibility.
final record	SessionWorkflowAgentParams	Parameters for one workflow-scoped subagent call.
final record	SessionWorkflowAgentResult	Result of one workflow-scoped subagent call.
final record	SessionWorkflowCancelParams	Parameters for cancelling a workflow run.
final record	SessionWorkflowCancelResult	Complete current or terminal workflow run envelope.
final record	SessionWorkflowGetRunDetailParams	Parameters for retrieving a workflow run.
final record	SessionWorkflowGetRunDetailResult	Full workflow run observability detail.
final record	SessionWorkflowGetRunParams	Parameters for retrieving a workflow run.
final record	SessionWorkflowGetRunProgressParams	Parameters for paging workflow progress.
final record	SessionWorkflowGetRunProgressResult	A bidirectional page of workflow progress.
final record	SessionWorkflowGetRunResult	Complete current or terminal workflow run envelope.
final record	SessionWorkflowJournalGetParams	Parameters for reading a workflow journal entry.
final record	SessionWorkflowJournalGetResult	Result of reading a workflow journal entry.
final record	SessionWorkflowJournalPutParams	Parameters for storing a workflow journal entry.
final record	SessionWorkflowListRunsParams	Parameters for paging workflow runs.
final record	SessionWorkflowListRunsResult	A page of workflow runs in durable creation order.
final record	SessionWorkflowLogParams	Parameters for recording workflow progress.
final record	SessionWorkflowPauseParams	Parameters for pausing a running workflow.
final record	SessionWorkflowPauseResult	Complete current or terminal workflow run envelope.
final record	SessionWorkflowResumeParams	Parameters for resuming a workflow run from its persisted identity.
final record	SessionWorkflowResumeResult	Resolved persisted workflow identity and resumed run envelope.
final record	SessionWorkflowRunParams	Parameters for invoking a registered workflow.
final record	SessionWorkflowRunResult	Complete current or terminal workflow run envelope.
final record	SessionWorkspacesAddSummaryParams	Compaction summary checkpoint to persist.
final record	SessionWorkspacesAddSummaryResult	Persisted summary metadata and refreshed workspace metadata.
final record	SessionWorkspacesAutopilotObjectiveExistsParams	Identifies the target session.
final record	SessionWorkspacesAutopilotObjectiveExistsResult	Whether the autopilot objective file exists.
final record	SessionWorkspacesCreateDirectoryParams	Directory to create within the session workspace files directory.
final record	SessionWorkspacesCreateFileParams	Relative path and UTF-8 content for the workspace file to create or overwrite.
final record	SessionWorkspacesDeleteAutopilotObjectiveParams	Identifies the target session.
final record	SessionWorkspacesDeleteAutopilotObjectiveResult	Result of deleting the autopilot objective file.
final record	SessionWorkspacesDiffParams	Parameters for computing a workspace diff.
final class	SessionWorkspacesDiffRequest	Parameters for computing a workspace diff.
final record	SessionWorkspacesDiffResult	Workspace diff result for the requested mode.
final record	SessionWorkspacesEnsureParams	Optional session context used when creating a local workspace.
final record	SessionWorkspacesEnsureResult	Current workspace metadata for the session, including its absolute filesystem path when available.
final record	SessionWorkspacesGetWorkspaceParams	Identifies the target session.
final record	SessionWorkspacesGetWorkspaceResult	Current workspace metadata for the session, including its absolute filesystem path when available.
final record	SessionWorkspacesListCheckpointsParams	Identifies the target session.
final record	SessionWorkspacesListCheckpointsResult	Workspace checkpoints in chronological order; empty when the workspace is not enabled.
final record	SessionWorkspacesListFilesParams	Identifies the target session.
final record	SessionWorkspacesListFilesResult	Relative paths of files stored in the session workspace files directory.
final record	SessionWorkspacesReadAutopilotObjectiveParams	Identifies the target session.
final record	SessionWorkspacesReadAutopilotObjectiveResult	Autopilot objective file content, or null when missing.
final record	SessionWorkspacesReadCheckpointParams	Checkpoint number to read.
final record	SessionWorkspacesReadCheckpointResult	Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.
final record	SessionWorkspacesReadFileParams	Relative path of the workspace file to read.
final record	SessionWorkspacesReadFileResult	Contents of the requested workspace file as a UTF-8 string.
final record	SessionWorkspacesRemovePathParams	File or directory to remove from the session workspace files directory.
final record	SessionWorkspacesRenamePathParams	Source and destination paths for a rename within the session workspace files directory.
final record	SessionWorkspacesSaveLargePasteParams	Pasted content to save as a UTF-8 file in the session workspace.
final record	SessionWorkspacesSaveLargePasteResult	Descriptor for the saved paste file, or null when the workspace is unavailable.
final record	SessionWorkspacesStatFileParams	Relative path of the workspace file or directory to inspect.
final record	SessionWorkspacesStatFileResult	Filesystem metadata for a path in the session workspace files directory.
final record	SessionWorkspacesTruncateSummariesParams	Rollback point for local workspace summaries.
final record	SessionWorkspacesTruncateSummariesResult	Current workspace metadata for the session, including its absolute filesystem path when available.
final record	SessionWorkspacesUpdateMetadataParams	Workspace metadata fields to update.
final record	SessionWorkspacesUpdateMetadataResult	Current workspace metadata for the session, including its absolute filesystem path when available.
final record	SessionWorkspacesWriteAutopilotObjectiveParams	Autopilot objective file content to persist.
final record	SessionWorkspacesWriteAutopilotObjectiveResult	Result of writing the autopilot objective file.
final record	ShellCredentials	Command-scoped GitHub credential injection for the shell commands an agent runs.
final record	SkillsApplyInstallParams	Applies exactly one retained verified Skill installation plan.
final record	SkillsApplyUninstallParams	One-use application of the exact retained Skill removal plan.
final record	SkillsConfigSetDisabledSkillsParams	Skill names to mark as disabled in global configuration, replacing any previous list.
final record	SkillsConfigSetSkillDisabledParams	Adds or removes a single skill from the global disabled list, leaving every other entry untouched.
final record	SkillsDiscoverParams	Optional project paths and additional skill directories to include in discovery.
final record	SkillsDiscoverResult	Skills discovered across global and project sources.
final record	SkillsGetDiscoveryPathsParams	Optional project paths to enumerate.
final record	SkillsGetDiscoveryPathsResult	Canonical locations where skills can be created so the runtime will recognize them.
final record	SkillsInstallationsCancelParams	Existing-operation control.
final record	SkillsInstallationsListParams	Inventory request under an explicitly selected existing session.
final record	SkillsInstallationsRecoverParams	Inventory request under an explicitly selected existing session.
final record	SkillsInstallationsSetEnabledParams	Persisted enablement update for one owned Skill installation.
final record	SkillsInstallationsStatusParams	Existing-operation control.
final record	SkillsPlanInstallParams	Side-effect-free planning of one verified Agent Finder Skill candidate.
final record	SkillsPlanUninstallParams	Read-only preparation of one owned Skill removal under fresh selected-session authority.
final record	TaskBlocker	Structured reason that the task cannot continue without intervention
final record	TasksCancelParams	Runtime-to-owner cancellation request for a client-owned task.
final record	TasksCancelResult	Whether the client authoritatively confirmed its external work stopped.
final record	ToolResultExpanded	Expanded canonical result returned by a session tool.
final record	ToolResultNewMessage	A message injected by a tool result.
enum	ToolResultType	Execution outcome classification.
final record	ToolsListParams	Optional model identifier whose tool overrides should be applied to the listing.
final record	ToolsListResult	Built-in tools available for the requested model, with their parameters and instructions.
final record	UserSettingsGetResult	Per-key metadata for every known user setting in settings.json, including settings left at their default.
final record	UserSettingsSetParams	Partial user settings to write to settings.json.
final record	WorkflowAbortParams	Parameters for cooperatively aborting a workflow body.
final record	WorkflowAgentOptions	Options for one workflow-scoped subagent call.
final record	WorkflowAgentSummary	Prompt-safe durable identity and live status for a direct workflow agent.
final record	WorkflowCurrentPhase	Current workflow phase identity.
final record	WorkflowDeclaredLimits	Declared or approved workflow resource ceilings.
final record	WorkflowExecuteParams	Parameters sent to the owning extension to execute a workflow closure.
final record	WorkflowExecuteResult	Result returned by an extension workflow closure.
final record	WorkflowLogLine	One ordered workflow progress line.
final record	WorkflowPhaseObservation	Durable lifecycle and timing for one workflow phase.
enum	WorkflowPhaseStatus	Derived lifecycle state of a workflow phase.
final record	WorkflowProgressLine	One durable workflow progress record.
final record	WorkflowProgressPage	A bidirectional page of workflow progress.
final record	WorkflowRunConsumed	Durable workflow resource consumption.
final record	WorkflowRunLimits	Wire-only per-invocation workflow resource ceiling overrides.
final record	WorkflowRunOptions	Options controlling workflow invocation.
final record	WorkflowRunSummary	Durable workflow run summary with read-time live overlays.
final record	WorkflowRunTerminal	Prompt-safe terminal workflow outcome.

Methods in com.github.copilot.generated.rpc with annotations of type CopilotExperimental

Modifier and Type	Method	Description
CompletableFuture<SessionAbortResult>	SessionRpc.abort(SessionAbortParams params)	Aborts the current agent turn.
CompletableFuture<SessionHistoryAbortManualCompactionResult>	SessionHistoryApi.abortManualCompaction()	Aborts any in-progress manual compaction on a local session.
CompletableFuture<SessionMetadataActivityResult>	SessionMetadataApi.activity()	Returns a snapshot of activity flags for the session.
CompletableFuture<Void>	ServerMcpConfigApi.add(McpConfigAddParams params)	Adds an MCP server to user configuration.
CompletableFuture<PluginsMarketplacesAddResult>	ServerPluginsMarketplacesApi.add(PluginsMarketplacesAddParams params)	Registers a new marketplace from a source (owner/repo, URL, or local path).
CompletableFuture<SessionPermissionsPathsAddResult>	SessionPermissionsPathsApi.add(SessionPermissionsPathsAddParams params)	Adds a directory to the session's allow-list and activates conventional skill and agent definitions under it.
CompletableFuture<SessionPluginsMarketplacesAddResult>	SessionPluginsMarketplacesApi.add(SessionPluginsMarketplacesAddParams params)	Adds a marketplace when permitted by the live session's retained managed policy.
CompletableFuture<SessionProviderAddResult>	SessionProviderApi.add(SessionProviderAddParams params)	Adds BYOK providers and/or models to the session's registry at runtime, extending the additive registry built from the session's `providers`/`models` options.
CompletableFuture<SecretsAddFilterValuesResult>	ServerSecretsApi.addFilterValues(SecretsAddFilterValuesParams params)	Registers secret values for redaction in session logs and exports.
CompletableFuture<SessionWorkspacesAddSummaryResult>	SessionWorkspacesApi.addSummary(SessionWorkspacesAddSummaryParams params)	Adds a compaction summary checkpoint to the local session workspace.
CompletableFuture<SessionPermissionsLocationsAddToolApprovalResult>	SessionPermissionsLocationsApi.addToolApproval(SessionPermissionsLocationsAddToolApprovalParams params)	Persists a tool approval for a permission location and applies its rules to this session's live permission service.
CompletableFuture<SessionPermissionsFolderTrustAddTrustedResult>	SessionPermissionsFolderTrustApi.addTrusted(SessionPermissionsFolderTrustAddTrustedParams params)	Adds a folder to the user's trusted folders list.
CompletableFuture<AuthLoginStep>	SessionAccountsLoginApi.advance(SessionAccountsLoginAdvanceParams params)	Advance an in-flight login flow, optionally fulfilling an input-required step, and return the next step.
CompletableFuture<SessionWorkflowAgentResult>	SessionWorkflowApi.agent(SessionWorkflowAgentParams params)	Runs one dynamic-workflow-scoped subagent and returns its result.
CompletableFuture<SessionQueueAppendSteeringResult>	SessionQueueApi.appendSteering(SessionQueueAppendSteeringParams params)	Atomically appends text and attachments to an unchanged, unconsumed local steering message.
CompletableFuture<SessionPermissionsLocationsApplyResult>	SessionPermissionsLocationsApi.apply(SessionPermissionsLocationsApplyParams params)	Applies persisted location-scoped tool approvals and allowed directories for a working directory to this session's permission service.
CompletableFuture<McpInstallationResult>	ServerMcpApi.applyInstall(McpApplyInstallParams params)	Consumes a retained prepared MCP operation once, revalidates its original authority, requests explicit human consent through installations.confirm on the original connection, then revalidates source and applies the sealed transaction.
CompletableFuture<SkillInstallationResult>	ServerSkillsApi.applyInstall(SkillsApplyInstallParams params)	Consumes one verified Skill installation plan, requests explicit human consent through installations.confirm on the original connection, then revalidates and installs the Skill disabled.
CompletableFuture<McpInstallationResult>	ServerMcpApi.applyUninstall(McpApplyUninstallParams params)	Consumes the original owned-removal plan once and requests fresh exact human confirmation on its original connection.
CompletableFuture<SkillInstallationResult>	ServerSkillsApi.applyUninstall(SkillsApplyUninstallParams params)	Consumes an owned Skill removal plan, requests explicit human consent through installations.confirm, refuses drift, and removes the exact owned files through quarantine.
CompletableFuture<Void>	SessionMcpOauthApi.authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams params)	Notifies the session that MCP OAuth authentication succeeded and updated credentials were persisted, so cached tool definitions can be refreshed.
CompletableFuture<SessionWorkspacesAutopilotObjectiveExistsResult>	SessionWorkspacesApi.autopilotObjectiveExists()	Checks whether the local session workspace has an autopilot objective state file.
CompletableFuture<SessionAccountsLoginBeginResult>	SessionAccountsLoginApi.begin(SessionAccountsLoginBeginParams params)	Begin an interactive login flow for a provider kind (dispatch is kind-only) and return its opaque flow id and first step.
CompletableFuture<PluginsMarketplacesBrowseResult>	ServerPluginsMarketplacesApi.browse(PluginsMarketplacesBrowseParams params)	Lists plugins advertised by a registered marketplace.
CompletableFuture<SessionPluginsMarketplacesBrowseResult>	SessionPluginsMarketplacesApi.browse(SessionPluginsMarketplacesBrowseParams params)	Browses a marketplace resolved through the live session's working directory and retained managed policy.
CompletableFuture<SessionsBulkDeleteResult>	ServerSessionsApi.bulkDelete(SessionsBulkDeleteParams params)	Closes, deactivates, and deletes a set of sessions, returning the bytes freed per session.
CompletableFuture<com.fasterxml.jackson.databind.JsonNode>	SessionMcpAppsApi.callTool(SessionMcpAppsCallToolParams params)	Call an MCP tool from an MCP App view (SEP-1865).
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.cancel(McpInstallationsCancelParams params)	Requests cancellation of a known operation on its original connection, including before apply or confirmation.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.cancel(SkillsInstallationsCancelParams params)	Requests cancellation of a known Skill installation operation before commit.
CompletableFuture<Void>	SessionAccountsLoginApi.cancel(SessionAccountsLoginCancelParams params)	Cancel an in-flight login flow and release its resources.
CompletableFuture<SessionTasksCancelResult>	SessionTasksApi.cancel(SessionTasksCancelParams params)	Cancels a background task.
CompletableFuture<SessionWorkflowCancelResult>	SessionWorkflowApi.cancel(SessionWorkflowCancelParams params)	Requests cancellation of a dynamic workflow run and returns its run envelope.
CompletableFuture<Void>	SessionRpc.cancelAllBackgroundAgents()	Cancels every running background agent (task-registry subagents plus sidekick agents) without interrupting the main agent loop.
CompletableFuture<SessionHistoryCancelBackgroundCompactionResult>	SessionHistoryApi.cancelBackgroundCompaction()	Cancels any in-progress background compaction on a local session.
CompletableFuture<SessionMcpOauthCancelLoginResult>	SessionMcpOauthApi.cancelLogin(SessionMcpOauthCancelLoginParams params)	Cancels the exact owned OAuth login issued to this original session requester, without clearing shared credentials.
CompletableFuture<SessionMcpCancelSamplingExecutionResult>	SessionMcpApi.cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params)	Cancels an in-flight MCP sampling execution by request ID.
CompletableFuture<SessionShellCancelUserRequestedResult>	SessionShellApi.cancelUserRequested(SessionShellCancelUserRequestedParams params)	Cancels a user-requested shell command by request ID.
CompletableFuture<SessionsCheckInUseResult>	ServerSessionsApi.checkInUse(SessionsCheckInUseParams params)	Returns the subset of the supplied session IDs that are currently held by another running process.
CompletableFuture<SessionContentExclusionCheckPathsResult>	SessionContentExclusionApi.checkPaths(SessionContentExclusionCheckPathsParams params)	Checks local file system absolute paths within the session working directory against its content-exclusion policy.
CompletableFuture<Void>	SessionQueueApi.clear()	Clears all pending queued items on the local session.
CompletableFuture<Void>	ServerManagedSettingsApi.clearCache()	Force-refreshes enterprise managed settings for every account: wipes the persistent server-policy cache (the whole `/managed-settings` directory) and drops this runtime process's in-memory retained server policy.
CompletableFuture<SessionHistoryClearContextResult>	SessionHistoryApi.clearContext(SessionHistoryClearContextParams params)	Clears the session's conversation history, keeping only system and developer messages, and seeds the fresh context window with a first user message.
CompletableFuture<Void>	ServerSessionsApi.close(SessionsCloseParams params)	Closes a session: emits shutdown, flushes pending events, releases the in-use lock, and disposes the active session.
CompletableFuture<Void>	SessionCanvasApi.close(SessionCanvasCloseParams params)	Closes an open canvas instance.
CompletableFuture<SessionDebugCollectLogsResult>	SessionDebugApi.collectLogs(SessionDebugCollectLogsParams params)	Collects a session debug log bundle into a local archive or staging directory.
CompletableFuture<SessionHistoryCompactResult>	SessionHistoryApi.compact()	Compacts the session history to reduce context usage.
CompletableFuture<SessionHistoryCompactResult>	SessionHistoryApi.compact(SessionHistoryCompactParams params)	Compacts the session history to reduce context usage.
CompletableFuture<Void>	SessionMcpOauthApi.complete(SessionMcpOauthCompleteParams params)	Completes a runtime-managed MCP OAuth login after the authorization server redirects to a host-managed callback URL.
CompletableFuture<ManagedSettingsComposeResult>	ServerManagedSettingsApi.compose(ManagedSettingsComposeParams params)	Merges candidate managed-settings documents for the device, server, and policy-helper channels into the effective settings the runtime would enforce on this host, using the same precedence and composition rules as live resolution, without applying them.
CompletableFuture<SessionDiagnosticsConfigureResult>	SessionDiagnosticsApi.configure(SessionDiagnosticsConfigureParams params)	Patches configured session diagnostic sources without restarting their producers.
CompletableFuture<SessionPermissionsConfigureResult>	SessionPermissionsApi.configure(SessionPermissionsConfigureParams params)	Replaces selected permission policy fields (rules, paths, URLs, exclusions, allow-all flags) on the session.
CompletableFuture<SessionsConnectResult>	ServerSessionsApi.connect(SessionsConnectParams params)	Connects to an existing remote session and exposes it as an SDK session.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.connect(SessionConnectorsConnectParams params)	Initiates an idempotent Connector connection request without opening a browser.
CompletableFuture<SessionMetadataContextInfoResult>	SessionMetadataApi.contextInfo(SessionMetadataContextInfoParams params)	Returns the token breakdown for the session's current context window for a given model.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.continueConnection(SessionConnectorsContinueConnectionParams params)	Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds.
CompletableFuture<SandboxProxyCaCreateResult>	ServerSandboxProxyCaApi.create(SandboxProxyCaCreateParams params)	Creates the persistent certificate authority of the sandbox credential proxy if none is stored, without changing OS trust, and returns the path of its public certificate.
CompletableFuture<Void>	SessionWorkspacesApi.createDirectory(SessionWorkspacesCreateDirectoryParams params)	Creates a directory in the session workspace files directory.
CompletableFuture<Void>	SessionWorkspacesApi.createFile(SessionWorkspacesCreateFileParams params)	Creates or overwrites a file in the session workspace files directory.
CompletableFuture<Void>	ServerEnvironmentsApi.delete(EnvironmentsDeleteParams params)	Deletes a user-managed GitHub Mission Control environment.
CompletableFuture<Void>	SessionPlanApi.delete()	Deletes the session plan file from the workspace.
CompletableFuture<SessionWorkspacesDeleteAutopilotObjectiveResult>	SessionWorkspacesApi.deleteAutopilotObjective()	Deletes the autopilot objective state file from the local session workspace.
CompletableFuture<Void>	SessionAgentApi.deselect()	Clears the selected custom agent and returns the session to the default agent.
CompletableFuture<SessionMcpAppsDiagnoseResult>	SessionMcpAppsApi.diagnose(SessionMcpAppsDiagnoseParams params)	Diagnose MCP Apps wiring for a specific MCP server.
CompletableFuture<SessionWorkspacesDiffResult>	SessionWorkspacesApi.diff(SessionWorkspacesDiffParams params)	Computes a diff for the session workspace.
CompletableFuture<SessionWorkspacesDiffResult>	SessionWorkspacesApi.diff(SessionWorkspacesDiffRequest request)	Computes a diff for the session workspace.
CompletableFuture<Void>	ServerExtensionsApi.disable(ExtensionsDisableParams params)	Persistently disables extension IDs for future sessions.
CompletableFuture<Void>	ServerMcpConfigApi.disable(McpConfigDisableParams params)	Disables MCP servers in user configuration for new sessions.
CompletableFuture<Void>	ServerPluginsApi.disable(PluginsDisableParams params)	Disables installed plugins for new sessions.
CompletableFuture<Void>	SessionExtensionsApi.disable(SessionExtensionsDisableParams params)	Disables an extension for the session and persists the preference when the session has a settings store.
CompletableFuture<Void>	SessionMcpApi.disable(SessionMcpDisableParams params)	Disables an MCP server for the session.
CompletableFuture<Void>	SessionMcpApi.disable(SessionMcpDisableRequest request)	Disables an MCP server for the session.
CompletableFuture<Void>	SessionPluginsApi.disable(SessionPluginsDisableParams params)	Disables installed plugins when permitted by the live session's retained managed policy.
CompletableFuture<Void>	SessionRemoteApi.disable()	Disables remote session export and steering.
CompletableFuture<Void>	SessionSkillsApi.disable(SessionSkillsDisableParams params)	Disables a skill for the session.
CompletableFuture<SessionSandboxDisableForSessionResult>	SessionSandboxApi.disableForSession(SessionSandboxDisableForSessionParams params)	Disables sandboxing for the remainder of the current session and approves the referenced pending sandbox-bypass permission request.
CompletableFuture<SessionConnectorsDisconnectResult>	SessionConnectorsApi.disconnect(SessionConnectorsDisconnectParams params)	Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.
CompletableFuture<AgentsDiscoverResult>	ServerAgentsApi.discover(AgentsDiscoverParams params)	Discovers custom agents across user, project, plugin, and remote sources.
CompletableFuture<ExtensionsDiscoverResult>	ServerExtensionsApi.discover()	Discovers user and enabled installed-plugin extensions from persisted Copilot home state, including enablement preferences.
CompletableFuture<HooksDiscoverResult>	ServerHooksApi.discover(HooksDiscoverParams params)	Discovers hook actions enabled under server-side discovery settings from user, repository, plugin, and managed-policy sources.
CompletableFuture<InstructionsDiscoverResult>	ServerInstructionsApi.discover(InstructionsDiscoverParams params)	Discovers instruction sources across user, repository, and plugin sources.
CompletableFuture<McpDiscoverResult>	ServerMcpApi.discover(McpDiscoverParams params)	Discovers MCP servers from user, workspace, plugin, and builtin sources.
CompletableFuture<SkillsDiscoverResult>	ServerSkillsApi.discover(SkillsDiscoverParams params)	Discovers skills across global and project sources.
CompletableFuture<SessionProvidersDiscoverResult>	SessionProvidersApi.discover(SessionProvidersDiscoverParams params)	Discovers reachable instances using an adapter from this session's effective provider catalog and provider-specific discovery input.
CompletableFuture<Void>	ServerHostApi.dispose(HostDisposeParams params)	Stops a listener owned by this SDK connection and joins its cleanup without deleting sessions.
CompletableFuture<SessionQueueDuplicateAtResult>	SessionQueueApi.duplicateAt(SessionQueueDuplicateAtParams params)	Duplicates an addressable queued item immediately after its source.
CompletableFuture<SessionUiElicitationResult>	SessionUiApi.elicitation(SessionUiElicitationParams params)	Requests structured input from a UI-capable client.
CompletableFuture<Void>	ServerExtensionsApi.enable(ExtensionsEnableParams params)	Persistently enables extension IDs for future sessions.
CompletableFuture<Void>	ServerMcpConfigApi.enable(McpConfigEnableParams params)	Enables MCP servers in user configuration for new sessions.
CompletableFuture<Void>	ServerPluginsApi.enable(PluginsEnableParams params)	Enables installed plugins for new sessions.
CompletableFuture<Void>	SessionExtensionsApi.enable(SessionExtensionsEnableParams params)	Enables an extension for the session and persists the preference when the session has a settings store.
CompletableFuture<Void>	SessionMcpApi.enable(SessionMcpEnableParams params)	Enables an MCP server for the session.
CompletableFuture<Void>	SessionMcpApi.enable(SessionMcpEnableRequest request)	Enables an MCP server for the session.
CompletableFuture<Void>	SessionPluginsApi.enable(SessionPluginsEnableParams params)	Enables installed plugins when permitted by the live session's retained managed policy.
CompletableFuture<SessionRemoteEnableResult>	SessionRemoteApi.enable(SessionRemoteEnableParams params)	Enables remote session export or steering.
CompletableFuture<Void>	SessionSkillsApi.enable(SessionSkillsEnableParams params)	Enables a skill for the session.
CompletableFuture<EnqueueCommandResult>	SessionCommandsApi.enqueue(SessionCommandsEnqueueParams params)	Enqueues a slash command for FIFO processing on the local session.
CompletableFuture<SessionsEnrichMetadataResult>	ServerSessionsApi.enrichMetadata(SessionsEnrichMetadataParams params)	Backfills missing summary and context fields on the supplied session metadata records.
CompletableFuture<SessionWorkspacesEnsureResult>	SessionWorkspacesApi.ensure(SessionWorkspacesEnsureParams params)	Ensures a local session workspace exists and returns it.
CompletableFuture<Void>	SessionSkillsApi.ensureLoaded()	Ensures the session's skill definitions have been loaded from disk.
CompletableFuture<AuthEnumerateValue>	SessionAccountsApi.enumerate(SessionAccountsEnumerateParams params)	Enumerate a typed accounts collection: the signed-in accounts, or the providers offered for interactive login.
CompletableFuture<SessionUiEphemeralQueryResult>	SessionUiApi.ephemeralQuery(SessionUiEphemeralQueryParams params)	Runs a transient no-tools model query against the current conversation context.
CompletableFuture<SessionShellExecResult>	SessionShellApi.exec(SessionShellExecParams params)	Starts a shell command, returning an RPC error if it cannot be spawned.
CompletableFuture<SessionCommandsExecuteResult>	SessionCommandsApi.execute(SessionCommandsExecuteParams params)	Executes a slash command synchronously and returns any error.
CompletableFuture<Void>	SessionToolsApi.execute(SessionToolsExecuteParams params)	Executes one tool from the session's currently offered tool set through the native invocation pipeline.
CompletableFuture<SessionMcpExecuteSamplingResult>	SessionMcpApi.executeSampling(SessionMcpExecuteSamplingParams params)	Runs an MCP sampling inference on behalf of an MCP server.
CompletableFuture<SessionShellExecuteUserRequestedResult>	SessionShellApi.executeUserRequested(SessionShellExecuteUserRequestedParams params)	Executes a user-requested shell command through the session runtime.
CompletableFuture<SessionsFindByPrefixResult>	ServerSessionsApi.findByPrefix(SessionsFindByPrefixParams params)	Resolves a UUID prefix to a unique session ID, if exactly one session matches.
CompletableFuture<SessionsFindByTaskIdResult>	ServerSessionsApi.findByTaskId(SessionsFindByTaskIdParams params)	Finds the local session bound to a GitHub task ID, if any.
CompletableFuture<SessionsForkResult>	ServerSessionsApi.fork(SessionsForkParams params)	Creates a new session by forking persisted history from an existing session.
CompletableFuture<EnvironmentsGetResult>	ServerEnvironmentsApi.get(EnvironmentsGetParams params)	Gets safe discovery information for a GitHub Mission Control environment without requiring a running host.
CompletableFuture<UserSettingsGetResult>	ServerUserSettingsApi.get()	Lists every known user setting from settings.json, each with its effective value, its default, and whether it is at the default — so settings the user has never set still appear with their default value.
CompletableFuture<AuthReadValue>	SessionAccountsApi.get(SessionAccountsGetParams params)	Read one typed accounts datum: the active account, a neutral status summary, or the last authentication errors.
CompletableFuture<SessionManagedSettingsGetResult>	SessionManagedSettingsApi.get()	Waits for the live session's in-flight managed-settings application, then returns the retained effective snapshot used by runtime enforcement and by `session.managed_settings_resolved`.
CompletableFuture<SessionMcpPromptsGetResult>	SessionMcpPromptsApi.get(SessionMcpPromptsGetParams params)	Get a prompt's messages from a connected MCP server (proxies MCP `prompts/get`).
CompletableFuture<SessionMode>	SessionModeApi.get()	Gets the current agent interaction mode.
CompletableFuture<SessionNameGetResult>	SessionNameApi.get()	Gets the session's friendly name.
CompletableFuture<SessionQuotaGetResult>	SessionQuotaApi.get()	Gets the session's current quota and account projection without making a network request.
CompletableFuture<SessionVisibilityGetResult>	SessionVisibilityApi.get()	Returns the session's current Mission Control sharing status and shareable GitHub URL.
CompletableFuture<SessionWorkflowJournalGetResult>	SessionWorkflowJournalApi.get(SessionWorkflowJournalGetParams params)	Reads a memoized dynamic workflow journal entry.
CompletableFuture<ConnectorSessionAccount>	SessionConnectorsApi.getAccount()	Returns the session account selection, or null.
CompletableFuture<ConnectorsGetAccountsResult>	ServerConnectorsApi.getAccounts()	Returns eligible accounts.
CompletableFuture<List<AccountAllUsers>>	ServerAccountApi.getAllUsers()	Gets all authenticated users available for account switching.
CompletableFuture<ModelsGetBuiltInCatalogResult>	ServerModelsApi.getBuiltInCatalog()	Returns the running runtime's complete catalog of well-known built-in model IDs without authentication or network access.
CompletableFuture<SessionToolsGetBuiltinDescriptorsResult>	SessionToolsApi.getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params)	Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set.
CompletableFuture<ConnectorsGetCapabilitiesResult>	ServerConnectorsApi.getCapabilities()	Returns feature availability.
CompletableFuture<SessionConnectorsGetCapabilitiesResult>	SessionConnectorsApi.getCapabilities()	Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API.
CompletableFuture<SessionProvidersGetCatalogResult>	SessionProvidersApi.getCatalog()	Returns adapter definitions and supported operations in this session's effective provider catalog, without running discovery.
CompletableFuture<List<Object>>	ServerSessionsApi.getClientMetadata(SessionsGetClientMetadataParams params)	Reads client-owned metadata for multiple persisted local sessions without opening them.
CompletableFuture<ClientMetadata>	SessionMetadataApi.getClientMetadata()	Returns the client-owned string metadata persisted with this local session.
CompletableFuture<SessionMetadataGetContextAttributionResult>	SessionMetadataApi.getContextAttribution()	Returns the experimental per-source attribution breakdown of the session's current context window as a flat list of entries (skills, subagents, MCP servers, built-in tools, plugin rollups, system/tool-definition costs, with nesting via parentId), plus the successful compaction count.
CompletableFuture<SessionMetadataGetContextHeaviestMessagesResult>	SessionMetadataApi.getContextHeaviestMessages(SessionMetadataGetContextHeaviestMessagesParams params)	Returns the largest individual messages currently in the session's context window, most-expensive first.
CompletableFuture<SessionAgentGetCurrentResult>	SessionAgentApi.getCurrent()	Gets the currently selected custom agent for the session.
CompletableFuture<SessionModelGetCurrentResult>	SessionModelApi.getCurrent()	Gets the session's authoritative model snapshot, including the committed Auto preference and any newer unclaimed Auto preference waiting for a future user turn.
CompletableFuture<AccountGetCurrentAuthResult>	ServerAccountApi.getCurrentAuth()	Gets the currently active authentication credentials from the global auth manager.
CompletableFuture<SessionToolsGetCurrentMetadataResult>	SessionToolsApi.getCurrentMetadata()	Returns lightweight metadata for the session's currently initialized tools.
CompletableFuture<SessionTasksGetCurrentPromotableResult>	SessionTasksApi.getCurrentPromotable()	Returns the first sync-waiting task that can currently be promoted to background mode.
CompletableFuture<AgentsGetDiscoveryPathsResult>	ServerAgentsApi.getDiscoveryPaths(AgentsGetDiscoveryPathsParams params)	Returns the canonical directories where a client may create custom agents that the runtime will recognize, including ones that do not exist yet.
CompletableFuture<InstructionsGetDiscoveryPathsResult>	ServerInstructionsApi.getDiscoveryPaths(InstructionsGetDiscoveryPathsParams params)	Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet.
CompletableFuture<SkillsGetDiscoveryPathsResult>	ServerSkillsApi.getDiscoveryPaths(SkillsGetDiscoveryPathsParams params)	Returns the canonical directories where a client may create skills that the runtime will recognize, including ones that do not exist yet.
CompletableFuture<SessionProviderGetEndpointResult>	SessionProviderApi.getEndpoint()	Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses.
CompletableFuture<SessionProviderGetEndpointResult>	SessionProviderApi.getEndpoint(SessionProviderGetEndpointParams params)	Returns the provider endpoint and credentials the session is currently configured to talk to, so the caller can make inference calls directly against the same backend the session uses.
CompletableFuture<SessionSandboxGetEnforcementStatusResult>	SessionSandboxApi.getEnforcementStatus()	Returns whether managed policy requires sandbox enforcement and whether an enforcement failure has permanently blocked the session.
CompletableFuture<SessionTelemetryGetEngagementIdResult>	SessionTelemetryApi.getEngagementId()	Gets the telemetry engagement ID currently associated with the session, when available.
CompletableFuture<SessionMcpAppsGetHostContextResult>	SessionMcpAppsApi.getHostContext()	Read the current host context advertised to MCP App guests.
CompletableFuture<SandboxGetHostSupportResult>	ServerSandboxApi.getHostSupport()	Reports whether the host running this runtime can run the command sandbox, without starting a session or spawning a sandboxed command.
CompletableFuture<SessionSkillsGetInvokedResult>	SessionSkillsApi.getInvoked()	Returns the skills that have been invoked during this session.
CompletableFuture<SessionsGetLastForContextResult>	ServerSessionsApi.getLastForContext(SessionsGetLastForContextParams params)	Returns the most-relevant prior session for a given working-directory context.
CompletableFuture<SessionUsageGetMetricsResult>	SessionUsageApi.getMetrics()	Gets accumulated usage metrics for the session.
CompletableFuture<SessionPermissionsGetModeResult>	SessionPermissionsApi.getMode()	Returns the current permission mode for the session.
CompletableFuture<SessionTasksGetProgressResult>	SessionTasksApi.getProgress(SessionTasksGetProgressParams params)	Returns progress information for a background task by ID.
CompletableFuture<AccountGetQuotaResult>	ServerAccountApi.getQuota()	Gets Copilot quota usage for the current or opaquely selected authenticated user.
CompletableFuture<AccountGetQuotaResult>	ServerAccountApi.getQuota(AccountGetQuotaParams params)	Gets Copilot quota usage for the current or opaquely selected authenticated user.
CompletableFuture<SessionsGetRemoteControlStatusResult>	ServerSessionsApi.getRemoteControlStatus()	Returns the current state of the remote-control singleton, including the attached session id and frontend URL when active.
CompletableFuture<SessionWorkflowGetRunResult>	SessionWorkflowApi.getRun(SessionWorkflowGetRunParams params)	Gets the current or settled envelope for a dynamic workflow run.
CompletableFuture<SessionWorkflowGetRunDetailResult>	SessionWorkflowApi.getRunDetail(SessionWorkflowGetRunDetailParams params)	Gets durable and live observability detail for one dynamic workflow run.
CompletableFuture<SessionWorkflowGetRunProgressResult>	SessionWorkflowApi.getRunProgress(SessionWorkflowGetRunProgressParams params)	Pages durable progress for one dynamic workflow run.
CompletableFuture<SessionsGetSizesResult>	ServerSessionsApi.getSizes()	Returns the on-disk byte size of each session's workspace directory.
CompletableFuture<SessionInstructionsGetSourcesResult>	SessionInstructionsApi.getSources()	Gets instruction sources loaded for the session.
CompletableFuture<SessionAutopilotObjectiveGetStateResult>	SessionAutopilotObjectiveApi.getState()	Reads the current canonical autopilot objective state for this session.
CompletableFuture<SandboxProxyCaGetStatusResult>	ServerSandboxProxyCaApi.getStatus(SandboxProxyCaGetStatusParams params)	Reports whether the persistent certificate authority of the sandbox credential proxy exists, whether OS trust includes it, and whether it must be rotated.
CompletableFuture<SessionConnectorsGetStatusResult>	SessionConnectorsApi.getStatus()	Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.
CompletableFuture<SessionGitHubAuthGetStatusResult>	SessionGitHubAuthApi.getStatus()	Gets authentication status and account metadata for the session.
CompletableFuture<SessionProvidersGetStatusResult>	SessionProvidersApi.getStatus(SessionProvidersGetStatusParams params)	Gets current health and version information for a discovered model-provider instance.
CompletableFuture<SessionCompletionsGetTriggerCharactersResult>	SessionCompletionsApi.getTriggerCharacters()	Gets the characters that should trigger host-driven completions for the session.
CompletableFuture<SessionWorkspacesGetWorkspaceResult>	SessionWorkspacesApi.getWorkspace()	Gets current workspace metadata for the session.
CompletableFuture<SessionSandboxGrantPathForRequestResult>	SessionSandboxApi.grantPathForRequest(SessionSandboxGrantPathForRequestParams params)	Adds the path offered by a pending sandbox escalation permission request's sandboxPathGrant to the session's sandbox policy and approves the request, so the blocked operation re-runs inside the sandbox rather than outside it.
CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult>	SessionUiApi.handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)	Resolves a pending `auto_mode_switch.requested` event with the user's accept/decline decision.
CompletableFuture<SessionCommandsHandlePendingCommandResult>	SessionCommandsApi.handlePendingCommand(SessionCommandsHandlePendingCommandParams params)	Reports completion of a pending client-handled slash command.
CompletableFuture<SessionUiHandlePendingElicitationResult>	SessionUiApi.handlePendingElicitation(SessionUiHandlePendingElicitationParams params)	Provides the user response for a pending elicitation request.
CompletableFuture<SessionUiHandlePendingExitPlanModeResult>	SessionUiApi.handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)	Resolves a pending `exit_plan_mode.requested` event with the user's response.
CompletableFuture<SessionMcpHeadersHandlePendingHeadersRefreshRequestResult>	SessionMcpHeadersApi.handlePendingHeadersRefreshRequest(SessionMcpHeadersHandlePendingHeadersRefreshRequestParams params)	Responds to a pending MCP dynamic headers refresh request.
CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult>	SessionPermissionsApi.handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)	Provides a decision for a pending tool permission request.
CompletableFuture<SessionMcpOauthHandlePendingRequestResult>	SessionMcpOauthApi.handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params)	Resolves a pending MCP OAuth request with a host-provided token or cancellation.
CompletableFuture<SessionUiHandlePendingSamplingResult>	SessionUiApi.handlePendingSampling(SessionUiHandlePendingSamplingParams params)	Resolves a pending `sampling.requested` event with a sampling result, or rejects it.
CompletableFuture<SessionUiHandlePendingSessionLimitsExhaustedResult>	SessionUiApi.handlePendingSessionLimitsExhausted(SessionUiHandlePendingSessionLimitsExhaustedParams params)	Resolves a pending `session_limits_exhausted.requested` event with the user's selected limit action.
CompletableFuture<SessionToolsHandlePendingToolCallResult>	SessionToolsApi.handlePendingToolCall(SessionToolsHandlePendingToolCallParams params)	Provides the result for a pending external tool call.
CompletableFuture<SessionUiHandlePendingUserInputResult>	SessionUiApi.handlePendingUserInput(SessionUiHandlePendingUserInputParams params)	Resolves a pending `user_input.requested` event with the user's response.
CompletableFuture<LlmInferenceHttpResponseChunkResult>	ServerLlmInferenceApi.httpResponseChunk(LlmInferenceHttpResponseChunkParams params)	Delivers a body byte range (or a terminal transport error) for an in-flight response, correlated by requestId.
CompletableFuture<LlmInferenceHttpResponseStartResult>	ServerLlmInferenceApi.httpResponseStart(LlmInferenceHttpResponseStartParams params)	Delivers the response head (status + headers) for an in-flight request, correlated by the requestId the runtime supplied in httpRequestStart.
CompletableFuture<Void>	SessionLspApi.initialize(SessionLspInitializeParams params)	Loads the merged LSP configuration set for the session's working directory.
CompletableFuture<Void>	SessionToolsApi.initializeAndValidate()	Resolves, builds, and validates the runtime tool list for the session.
CompletableFuture<SessionQueueInsertAtResult>	SessionQueueApi.insertAt(SessionQueueInsertAtParams params)	Inserts a new queued message at a public visible position.
CompletableFuture<PluginsInstallResult>	ServerPluginsApi.install(PluginsInstallParams params)	Installs a plugin from a marketplace, GitHub repo, URL, or local path.
CompletableFuture<SessionPluginsInstallResult>	SessionPluginsApi.install(SessionPluginsInstallParams params)	Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.
CompletableFuture<SessionInterruptMainTurnResult>	SessionRpc.interruptMainTurn(SessionInterruptMainTurnParams params)	Interrupts the current main agent turn while leaving running background work (subagents, sidekicks, and promoted attached shells) alive.
CompletableFuture<SessionCanvasActionInvokeResult>	SessionCanvasActionApi.invoke(SessionCanvasActionInvokeParams params)	Invokes an action on an open canvas instance.
CompletableFuture<SlashCommandInvocationResult>	SessionCommandsApi.invoke(SessionCommandsInvokeParams params)	Invokes a slash command in the session.
CompletableFuture<SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult>	SessionPermissionsPathsApi.isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params)	Reports whether a path falls within any of the session's allowed directories.
CompletableFuture<SessionPermissionsPathsIsPathWithinWorkspaceResult>	SessionPermissionsPathsApi.isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params)	Reports whether a path falls within the session's workspace (primary) directory.
CompletableFuture<SessionMetadataIsProcessingResult>	SessionMetadataApi.isProcessing()	Reports whether the local session is currently processing user/agent messages.
CompletableFuture<SessionMcpIsServerRunningResult>	SessionMcpApi.isServerRunning(SessionMcpIsServerRunningParams params)	Checks whether a named MCP server is currently running on the session's host.
CompletableFuture<SessionPermissionsFolderTrustIsTrustedResult>	SessionPermissionsFolderTrustApi.isTrusted(SessionPermissionsFolderTrustIsTrustedParams params)	Reports whether a folder is trusted according to the user's folder trust state.
CompletableFuture<SessionShellKillResult>	SessionShellApi.kill(SessionShellKillParams params)	Sends a signal to a shell process previously started via "shell.exec".
CompletableFuture<CommandsListResult>	ServerCommandsApi.list()	Lists the well-known built-in slash commands that work as the first message in a new session (e.g.
CompletableFuture<ConnectorsListResult>	ServerConnectorsApi.list(ConnectorsListParams params)	Lists entries for the selected account.
CompletableFuture<EnvironmentsListResult>	ServerEnvironmentsApi.list(EnvironmentsListParams params)	Lists GitHub Mission Control environments visible to the authenticated identity.
CompletableFuture<McpConfigListResult>	ServerMcpConfigApi.list()	Lists MCP servers from user configuration.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.list(McpInstallationsListParams params)	Reads receipt-owned MCP inventory for the selected account and host without activating servers or reconstructing missing ownership.
CompletableFuture<ModelsListResult>	ServerModelsApi.list()	Lists Copilot models available to the authenticated user.
CompletableFuture<ModelsListResult>	ServerModelsApi.list(ModelsListParams params)	Lists Copilot models available to the authenticated user.
CompletableFuture<PluginsListResult>	ServerPluginsApi.list()	Lists plugins installed in user/global state.
CompletableFuture<PluginsMarketplacesListResult>	ServerPluginsMarketplacesApi.list()	Lists all registered marketplaces (defaults + user-added).
CompletableFuture<SessionsListResult>	ServerSessionsApi.list()	Lists sessions, optionally filtered by source and working-directory context.
CompletableFuture<SessionsListResult>	ServerSessionsApi.list(SessionsListParams params)	Lists sessions, optionally filtered by source and working-directory context.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.list(SkillsInstallationsListParams params)	Lists owned verified Agent Finder Skill installations for the selected existing session.
CompletableFuture<ToolsListResult>	ServerToolsApi.list(ToolsListParams params)	Lists built-in tools available for a model.
CompletableFuture<SessionAgentListResult>	SessionAgentApi.list()	Lists agents available to the session.
CompletableFuture<SessionAgentListResult>	SessionAgentApi.list(SessionAgentListParams params)	Lists agents available to the session.
CompletableFuture<SessionCanvasListResult>	SessionCanvasApi.list()	Lists canvases declared for the session.
CompletableFuture<SessionCommandsListResult>	SessionCommandsApi.list()	Lists slash commands available in the session.
CompletableFuture<SessionCommandsListResult>	SessionCommandsApi.list(SessionCommandsListParams params)	Lists slash commands available in the session.
CompletableFuture<SessionConnectorsListResult>	SessionConnectorsApi.list(SessionConnectorsListParams params)	Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.
CompletableFuture<SessionExtensionsListResult>	SessionExtensionsApi.list()	Lists extensions discovered for the session and their current status.
CompletableFuture<SessionMcpListResult>	SessionMcpApi.list()	Lists materialized MCP servers and their connection status.
CompletableFuture<SessionMcpPromptsListResult>	SessionMcpPromptsApi.list(SessionMcpPromptsListParams params)	Enumerate one page of prompts a connected MCP server exposes (proxies MCP `prompts/list`).
CompletableFuture<SessionMcpResourcesListResult>	SessionMcpResourcesApi.list(SessionMcpResourcesListParams params)	Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`).
CompletableFuture<SessionModelListResult>	SessionModelApi.list()	Lists models available to this session using its own auth and integration context.
CompletableFuture<SessionModelListResult>	SessionModelApi.list(SessionModelListParams params)	Lists models available to this session using its own auth and integration context.
CompletableFuture<SessionPermissionsPathsListResult>	SessionPermissionsPathsApi.list()	Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
CompletableFuture<SessionPluginsListResult>	SessionPluginsApi.list()	Lists globally installed, live, built-in, and enterprise-managed desired plugins using the live session's authoritative account, working directory, and retained managed policy.
CompletableFuture<SessionPluginsMarketplacesListResult>	SessionPluginsMarketplacesApi.list()	Lists registered and enterprise-managed desired marketplaces using the live session's retained policy.
CompletableFuture<SessionProvidersModelsListResult>	SessionProvidersModelsApi.list(SessionProvidersModelsListParams params)	Lists models installed or otherwise available from a discovered model-provider instance.
CompletableFuture<SessionScheduleListResult>	SessionScheduleApi.list()	Lists the session's currently active scheduled prompts.
CompletableFuture<SessionSkillsListResult>	SessionSkillsApi.list()	Lists skills available to the session.
CompletableFuture<SessionTasksListResult>	SessionTasksApi.list()	Lists background tasks tracked by the session.
CompletableFuture<SessionWorkspacesListCheckpointsResult>	SessionWorkspacesApi.listCheckpoints()	Lists workspace checkpoints in chronological order.
CompletableFuture<SessionMcpListConfiguredResult>	SessionMcpApi.listConfigured()	Lists effective MCP configuration without starting, restarting, authenticating, or waiting for servers.
CompletableFuture<SessionWorkspacesListFilesResult>	SessionWorkspacesApi.listFiles()	Lists files stored in the session workspace files directory.
CompletableFuture<SessionCanvasListOpenResult>	SessionCanvasApi.listOpen()	Lists currently open canvas instances for the live session.
CompletableFuture<SessionToolsListPendingRequestsResult>	SessionToolsApi.listPendingRequests()	Lists the external tool calls of the session and its sub-agents that are still waiting for session.tools.handlePendingToolCall.
CompletableFuture<SessionHistoryListRewindPointsResult>	SessionHistoryApi.listRewindPoints()	Lists the user turns that the session can rewind to.
CompletableFuture<SessionWorkflowListRunsResult>	SessionWorkflowApi.listRuns(SessionWorkflowListRunsParams params)	Lists durable dynamic workflow runs for this session in creation order.
CompletableFuture<HostListSessionsResult>	ServerHostApi.listSessions(HostListSessionsParams params)	Reads the complete advertised live and dormant session catalog of an existing host owned by this connection.
CompletableFuture<SessionMcpResourcesListTemplatesResult>	SessionMcpResourcesApi.listTemplates(SessionMcpResourcesListTemplatesParams params)	Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`).
CompletableFuture<SessionMcpListToolsResult>	SessionMcpApi.listTools(SessionMcpListToolsParams params)	Lists the tools exposed by a connected MCP server on this session's host.
CompletableFuture<SessionMcpAppsListToolsResult>	SessionMcpAppsApi.listTools(SessionMcpAppsListToolsParams params)	List tools that an MCP App view is allowed to call (SEP-1865 visibility filter).
CompletableFuture<SessionsLoadDeferredRepoHooksResult>	ServerSessionsApi.loadDeferredRepoHooks(SessionsLoadDeferredRepoHooksParams params)	Loads previously-deferred repo-level hooks on the active session, returning queued startup prompts.
CompletableFuture<SessionLogResult>	SessionRpc.log(SessionLogParams params)	Emits a user-visible session log event.
CompletableFuture<Void>	SessionWorkflowApi.log(SessionWorkflowLogParams params)	Records a batch of ordered dynamic workflow progress lines.
CompletableFuture<AccountLoginResult>	ServerAccountApi.login(AccountLoginParams params)	Validates and stores authentication credentials.
CompletableFuture<SessionMcpOauthLoginResult>	SessionMcpOauthApi.login(SessionMcpOauthLoginParams params)	Starts OAuth authentication for a remote MCP server.
CompletableFuture<SessionMcpOauthLoginResult>	SessionMcpOauthApi.login(SessionMcpOauthLoginRequest request)	Starts OAuth authentication for a remote MCP server.
CompletableFuture<AccountLogoutResult>	ServerAccountApi.logout(AccountLogoutParams params)	Removes user authentication from keychain and persisted state.
CompletableFuture<SessionPermissionsModifyRulesResult>	SessionPermissionsApi.modifyRules(SessionPermissionsModifyRulesParams params)	Adds or removes session-scoped or location-scoped permission rules.
CompletableFuture<SessionQueueMoveItemResult>	SessionQueueApi.moveItem(SessionQueueMoveItemParams params)	Moves an addressable queued item to a public visible position.
CompletableFuture<SessionMcpMoveLoadingToBackgroundResult>	SessionMcpApi.moveLoadingToBackground()	Releases any turns waiting on an in-flight MCP load without cancelling the load, letting the agent proceed while MCP servers finish connecting in the background.
CompletableFuture<SessionPermissionsNotifyPromptShownResult>	SessionPermissionsApi.notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)	Notifies the runtime that a permission prompt UI has been shown to the user.
CompletableFuture<Void>	SessionRemoteApi.notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params)	Persists a remote-steerability change emitted by the host as a session event.
CompletableFuture<SessionsOpenResult>	ServerSessionsApi.open(SessionsOpenParams params)	Creates or resumes a local session and returns the opened session ID.
CompletableFuture<SessionCanvasOpenResult>	SessionCanvasApi.open(SessionCanvasOpenParams params)	Opens or focuses a canvas instance.
CompletableFuture<SessionWorkflowPauseResult>	SessionWorkflowApi.pause(SessionWorkflowPauseParams params)	Pauses a running dynamic workflow and returns its settled run envelope.
CompletableFuture<SessionQueuePendingItemsResult>	SessionQueueApi.pendingItems()	Returns the local session's pending user-facing queued items and steering messages.
CompletableFuture<SessionPermissionsPendingRequestsResult>	SessionPermissionsApi.pendingRequests()	Reconstructs the set of pending tool permission requests from the session's event history.
CompletableFuture<PingResult>	ServerRpc.ping(PingParams params)	Checks server responsiveness and returns protocol information.
CompletableFuture<McpPlanInstallResult>	ServerMcpApi.planInstall(McpPlanInstallParams params)	Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card.
CompletableFuture<McpPlanInstallResult>	ServerMcpApi.planInstall(McpPlanInstallRequest request)	Requests a side-effect-free MCP install plan from a catalog candidate handle or a caller-supplied card.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsApi.planInstall(SkillsPlanInstallParams params)	Plans installation of a verified Agent Finder Skill candidate without writing files.
CompletableFuture<McpInstallationManagementResult>	ServerMcpApi.planUninstall(McpPlanUninstallParams params)	Prepares a read-only removal plan for an exact owned receipt under the selected existing session.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsApi.planUninstall(SkillsPlanUninstallParams params)	Prepares a read-only removal plan for an owned verified Agent Finder Skill installation.
CompletableFuture<SessionLimitPredictionResult>	SessionLimitPredictionApi.predict()	Predicts an AI-credit session limit for the session's resolved model.
CompletableFuture<SessionLimitPredictionResult>	SessionLimitPredictionApi.predict(SessionLimitPredictionPredictParams params)	Predicts an AI-credit session limit for the session's resolved model.
CompletableFuture<SessionProvidersModelsPrepareConfigurationResult>	SessionProvidersModelsApi.prepareConfiguration(SessionProvidersModelsPrepareConfigurationParams params)	Translates a discovered model into the provider and model configuration needed to use it, and reports whether each is already registered in this session.
CompletableFuture<McpInstallationManagementResult>	ServerMcpApi.prepareInstall(McpPrepareInstallParams params)	Consumes a bound catalogue plan and retains one exact fully resolved personal remote MCP operation requiring no supplied values or configured secrets.
CompletableFuture<SessionMcpOauthPrepareLoginResult>	SessionMcpOauthApi.prepareLogin(SessionMcpOauthPrepareLoginParams params)	Prepares an inert, expiring owned OAuth login bound to the original session requester and exact installation.
CompletableFuture<SessionHistoryPreviewRewindResult>	SessionHistoryApi.previewRewind(SessionHistoryPreviewRewindParams params)	Previews the files that a conversation-and-files rewind would restore.
CompletableFuture<McpOauthProbeResult>	SessionMcpOauthApi.probe(SessionMcpOauthProbeParams params)	Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted.
CompletableFuture<McpOauthProbeResult>	SessionMcpOauthApi.probe(SessionMcpOauthProbeRequest request)	Passively probes a configured remote MCP server to classify whether OAuth is required or a cached/override token is accepted.
CompletableFuture<SessionTasksPromoteCurrentToBackgroundResult>	SessionTasksApi.promoteCurrentToBackground()	Atomically promotes the first promotable sync-waiting task to background mode and returns it.
CompletableFuture<SessionTasksPromoteToBackgroundResult>	SessionTasksApi.promoteToBackground(SessionTasksPromoteToBackgroundParams params)	Promotes an eligible synchronously-waited task so it continues running in the background.
CompletableFuture<SessionsPruneOldResult>	ServerSessionsApi.pruneOld(SessionsPruneOldParams params)	Deletes sessions older than the given threshold, with optional dry-run and exclusion list.
CompletableFuture<HostPublishSessionResult>	ServerHostApi.publishSession(HostPublishSessionParams params)	Publishes an attached resident session for this listener's lifetime without copying it.
CompletableFuture<Void>	SessionWorkflowJournalApi.put(SessionWorkflowJournalPutParams params)	Stores a memoized dynamic workflow journal entry.
CompletableFuture<ManagedSettingsReadResult>	ServerManagedSettingsApi.read()	Discovers device-managed settings from production MDM and managed-file sources, validates them against the runtime-owned managed-settings schema, and returns the canonical JSON without requiring a session.
CompletableFuture<SessionDiagnosticsReadResult>	SessionDiagnosticsApi.read(SessionDiagnosticsReadParams params)	Reads a bounded batch of retained session diagnostics for the selected sources.
CompletableFuture<SessionEventLogReadResult>	SessionEventLogApi.read(SessionEventLogReadParams params)	Reads a batch of session events from a cursor, optionally waiting for new events.
CompletableFuture<SessionMcpResourcesReadResult>	SessionMcpResourcesApi.read(SessionMcpResourcesReadParams params)	Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`).
CompletableFuture<SessionPlanReadResult>	SessionPlanApi.read()	Reads the session plan file from the workspace.
CompletableFuture<SessionWorkspacesReadAutopilotObjectiveResult>	SessionWorkspacesApi.readAutopilotObjective()	Reads the autopilot objective state file from the local session workspace.
CompletableFuture<SessionWorkspacesReadCheckpointResult>	SessionWorkspacesApi.readCheckpoint(SessionWorkspacesReadCheckpointParams params)	Reads the content of a workspace checkpoint by number.
CompletableFuture<SessionWorkspacesReadFileResult>	SessionWorkspacesApi.readFile(SessionWorkspacesReadFileParams params)	Reads a file from the session workspace files directory.
CompletableFuture<SessionsReadPersistedEventsResult>	ServerSessionsApi.readPersistedEvents(SessionsReadPersistedEventsParams params)	Reads a page of durable events directly from a local session's persisted journal without creating, resuming, or activating the session.
CompletableFuture<SessionMcpAppsReadResourceResult>	SessionMcpAppsApi.readResource(SessionMcpAppsReadResourceParams params)	Fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) from a connected server.
CompletableFuture<SessionPlanReadSqlTodosResult>	SessionPlanApi.readSqlTodos()	Reads todo rows from the session SQL database for plan rendering.
CompletableFuture<SessionPlanReadSqlTodosWithDependenciesResult>	SessionPlanApi.readSqlTodosWithDependencies()	Reads todo rows AND dependency edges from the session SQL database for structured progress UI.
CompletableFuture<SessionMetadataRecomputeContextTokensResult>	SessionMetadataApi.recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params)	Re-tokenizes the session's existing messages against a model and returns aggregate token totals.
CompletableFuture<SessionConnectorsReconcileResult>	SessionConnectorsApi.reconcile(SessionConnectorsReconcileParams params)	Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
CompletableFuture<SessionConnectorsReconcileResult>	SessionConnectorsApi.reconcile(SessionConnectorsReconcileRequest request)	Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
CompletableFuture<SessionExtensionsReconcileResult>	SessionExtensionsApi.reconcile()	Host-only reconciliation of authoritative session-effective extension membership and enablement.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.reconnect(SessionConnectorsReconnectParams params)	Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.
CompletableFuture<Void>	SessionMetadataApi.recordContextChange(SessionMetadataRecordContextChangeParams params)	Records a working-directory/git context change and emits a `session.context_changed` event.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.recover(McpInstallationsRecoverParams params)	Reconciles already-confirmed durable MCP transactions, then inspects owned inventory.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.recover(SkillsInstallationsRecoverParams params)	Reconciles interrupted owned Skill installation work for the selected existing session, then inspects owned inventory.
CompletableFuture<ConnectorsRefreshResult>	ServerConnectorsApi.refresh(ConnectorsRefreshParams params)	Refreshes entries for the selected account.
CompletableFuture<PluginsMarketplacesRefreshResult>	ServerPluginsMarketplacesApi.refresh()	Re-fetches one or all registered marketplace catalogs.
CompletableFuture<PluginsMarketplacesRefreshResult>	ServerPluginsMarketplacesApi.refresh(PluginsMarketplacesRefreshParams params)	Re-fetches one or all registered marketplace catalogs.
CompletableFuture<SessionConnectorsRefreshResult>	SessionConnectorsApi.refresh(SessionConnectorsRefreshParams params)	Refreshes and validates the Connector catalog for the pinned opaque account selection.
CompletableFuture<SessionPluginsMarketplacesRefreshResult>	SessionPluginsMarketplacesApi.refresh()	Refreshes marketplaces resolved through the live session's working directory and retained managed policy.
CompletableFuture<SessionPluginsMarketplacesRefreshResult>	SessionPluginsMarketplacesApi.refresh(SessionPluginsMarketplacesRefreshParams params)	Refreshes marketplaces resolved through the live session's working directory and retained managed policy.
CompletableFuture<SessionQuotaRefreshResult>	SessionQuotaApi.refresh()	Refreshes the session's provider model catalog bypassing its cache, folds quota snapshots into session state, and returns the updated projection.
CompletableFuture<Void>	SessionTasksApi.refresh()	Refreshes metadata for any detached background shells the runtime knows about.
CompletableFuture<SessionTasksRegisterResult>	SessionTasksApi.register(SessionTasksRegisterParams params)	Registers a client-owned task, or reclaims an orphaned task belonging to the same extension principal.
CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult>	SessionUiApi.registerDirectAutoModeSwitchHandler()	Registers an in-process handler for auto-mode-switch requests so the server bridge skips dispatch.
CompletableFuture<Void>	ServerRpc.registerExtensionLaunchProvider()	Registers the calling SDK client as the per-entrypoint extension launch provider.
CompletableFuture<SessionEventLogRegisterInterestResult>	SessionEventLogApi.registerInterest(SessionEventLogRegisterInterestParams params)	Registers consumer interest in an event type for runtime gating purposes.
CompletableFuture<SessionEventLogReleaseInterestResult>	SessionEventLogApi.releaseInterest(SessionEventLogReleaseInterestParams params)	Releases a consumer's previously-registered interest in an event type.
CompletableFuture<Void>	ServerSessionsApi.releaseLock(SessionsReleaseLockParams params)	Releases the in-use lock held by this process for a session.
CompletableFuture<Void>	ServerMcpConfigApi.reload()	Drops this runtime process's in-memory MCP server-definition cache so the next MCP config read observes disk.
CompletableFuture<SessionAgentReloadResult>	SessionAgentApi.reload()	Reloads custom agent definitions and returns the refreshed list.
CompletableFuture<CustomizationsReloadResult>	SessionCustomizationsApi.reload()	For local sessions, reconciles repository context and discovered instructions, plugins, skills, agents, hooks, MCP servers, and extensions after files appear or change under the working directory.
CompletableFuture<Void>	SessionExtensionsApi.reload()	Reloads extension definitions and processes for the session.
CompletableFuture<SessionInstructionsGetSourcesResult>	SessionInstructionsApi.reload()	For local sessions, invalidates instruction discovery and the model-facing prompt, then returns freshly discovered sources.
CompletableFuture<Void>	SessionMcpApi.reload()	Reloads MCP server connections for the session.
CompletableFuture<Void>	SessionPluginsApi.reload()	Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.
CompletableFuture<Void>	SessionPluginsApi.reload(SessionPluginsReloadParams params)	Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.
CompletableFuture<SessionSkillsReloadResult>	SessionSkillsApi.reload()	Reloads skill definitions for the session.
CompletableFuture<Void>	ServerSessionsApi.reloadPluginHooks(SessionsReloadPluginHooksParams params)	Reloads user, plugin, and (optionally) repo hooks on the active session.
CompletableFuture<Void>	ServerMcpConfigApi.remove(McpConfigRemoveParams params)	Removes an MCP server from user configuration.
CompletableFuture<PluginsMarketplacesRemoveResult>	ServerPluginsMarketplacesApi.remove(PluginsMarketplacesRemoveParams params)	Removes a previously-registered marketplace.
CompletableFuture<SandboxProxyCaRemoveResult>	ServerSandboxProxyCaApi.remove()	Removes the persistent certificate authority of the sandbox credential proxy from OS trust.
CompletableFuture<SessionPluginsMarketplacesRemoveResult>	SessionPluginsMarketplacesApi.remove(SessionPluginsMarketplacesRemoveParams params)	Removes a marketplace when permitted by the live session's retained managed policy.
CompletableFuture<SessionTasksRemoveResult>	SessionTasksApi.remove(SessionTasksRemoveParams params)	Removes a completed or cancelled background task from tracking.
CompletableFuture<SessionQueueRemoveAtResult>	SessionQueueApi.removeAt(SessionQueueRemoveAtParams params)	Removes an addressable queued item by its stable id.
CompletableFuture<SessionMcpRemoveGitHubResult>	SessionMcpApi.removeGitHub()	Removes the auto-managed `github` MCP server when present.
CompletableFuture<SessionQueueRemoveMostRecentResult>	SessionQueueApi.removeMostRecent()	Removes the most recently queued user-facing item (LIFO).
CompletableFuture<Void>	SessionWorkspacesApi.removePath(SessionWorkspacesRemovePathParams params)	Removes a file or directory from the session workspace files directory.
CompletableFuture<Void>	SessionWorkspacesApi.renamePath(SessionWorkspacesRenamePathParams params)	Renames a file or directory within the session workspace files directory.
CompletableFuture<SessionCompletionsRequestResult>	SessionCompletionsApi.request(SessionCompletionsRequestParams params)	Requests host-driven completion items for the current composer input.
CompletableFuture<SessionPermissionsResetSessionApprovalsResult>	SessionPermissionsApi.resetSessionApprovals(SessionPermissionsResetSessionApprovalsParams params)	Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
CompletableFuture<ManagedSettingsResolveResult>	ServerManagedSettingsApi.resolve()	Resolves the effective enterprise managed settings without a session, from the device channel and, when an account is available, the account's server policy through the same per-account cache sessions use.
CompletableFuture<ManagedSettingsResolveResult>	ServerManagedSettingsApi.resolve(ManagedSettingsResolveParams params)	Resolves the effective enterprise managed settings without a session, from the device channel and, when an account is available, the account's server policy through the same per-account cache sessions use.
CompletableFuture<SessionPermissionsLocationsResolveResult>	SessionPermissionsLocationsApi.resolve(SessionPermissionsLocationsResolveParams params)	Resolves the permission location key and type for a working directory.
CompletableFuture<SessionMcpOauthRespondResult>	SessionMcpOauthApi.respond(SessionMcpOauthRespondParams params)	Responds to a pending MCP OAuth authorization request by its request id.
CompletableFuture<SessionCommandsRespondToQueuedCommandResult>	SessionCommandsApi.respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params)	Reports whether the host actually executed a queued command and whether to continue processing.
CompletableFuture<Void>	SessionMcpApi.restartServer(SessionMcpRestartServerParams params)	Restarts an individual MCP server on the live session (stops then starts).
CompletableFuture<Void>	SessionMcpApi.restartServer(SessionMcpRestartServerRequest request)	Restarts an individual MCP server on the live session (stops then starts).
CompletableFuture<SessionWorkflowResumeResult>	SessionWorkflowApi.resume(SessionWorkflowResumeParams params)	Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.
CompletableFuture<SessionPluginsRetryManagedResult>	SessionPluginsApi.retryManaged()	Installs or updates the plugins the session's managed settings require now, without waiting for the next automatic attempt after a failure, then reloads plugins.
CompletableFuture<SessionPluginsRetryManagedResult>	SessionPluginsApi.retryManaged(SessionPluginsRetryManagedParams params)	Installs or updates the plugins the session's managed settings require now, without waiting for the next automatic attempt after a failure, then reloads plugins.
CompletableFuture<SessionHistoryRewindResult>	SessionHistoryApi.rewind(SessionHistoryRewindParams params)	Rewinds the session conversation, optionally restoring files changed by the discarded turns.
CompletableFuture<SandboxProxyCaRotateResult>	ServerSandboxProxyCaApi.rotate(SandboxProxyCaRotateParams params)	Replaces the persistent certificate authority of the sandbox credential proxy with a new one for the current credential hosts.
CompletableFuture<SessionWorkflowRunResult>	SessionWorkflowApi.run(SessionWorkflowRunParams params)	Runs a registered dynamic workflow by name at the top level.
CompletableFuture<Void>	ServerSessionsApi.save(SessionsSaveParams params)	Flushes a session's pending events to disk.
CompletableFuture<SessionWorkspacesSaveLargePasteResult>	SessionWorkspacesApi.saveLargePaste(SessionWorkspacesSaveLargePasteParams params)	Saves pasted content as a UTF-8 file in the session workspace.
CompletableFuture<ManagedSettingsSchemaResult>	ServerManagedSettingsApi.schema()	Returns the managed-settings authoring JSON schema with descriptive `x-composition` annotations aligned with the shared settings-engine vocabulary.
CompletableFuture<CatalogSearchResult>	ServerCatalogApi.search(CatalogSearchParams params)	Requests a bounded catalog search.
CompletableFuture<CatalogSearchResult>	ServerCatalogApi.search(CatalogSearchRequest request)	Requests a bounded catalog search.
CompletableFuture<CatalogSelectionResult>	ServerCatalogApi.select(CatalogSelectParams params)	Terminates one retained catalog selection group.
CompletableFuture<SessionAgentSelectResult>	SessionAgentApi.select(SessionAgentSelectParams params)	Selects a custom agent for subsequent turns in the session.
CompletableFuture<SessionSendResult>	SessionRpc.send(SessionSendParams params)	Sends a user message to the session and returns its message ID.
CompletableFuture<Void>	SessionExtensionsApi.sendAttachmentsToMessage(SessionExtensionsSendAttachmentsToMessageParams params)	Push attachments into the next user-message turn from an extension.
CompletableFuture<SessionTasksSendMessageResult>	SessionTasksApi.sendMessage(SessionTasksSendMessageParams params)	Sends a message to a background agent task.
CompletableFuture<SessionSendMessagesResult>	SessionRpc.sendMessages(SessionSendMessagesParams params)	Sends zero or more user messages to the session in a single turn and returns their message IDs.
CompletableFuture<SessionQueueSendNowResult>	SessionQueueApi.sendNow(SessionQueueSendNowParams params)	Moves an addressable queued message into the live turn's steering lane.
CompletableFuture<Void>	ServerPluginsBuiltinApi.set(PluginsBuiltinSetParams params)	Replaces this server's trusted built-in plugin directories while no sessions are active.
CompletableFuture<Void>	ServerUserSettingsApi.set(UserSettingsSetParams params)	Writes one or more user settings to settings.json, replacing each provided top-level key.
CompletableFuture<SessionAccountsSetResult>	SessionAccountsApi.set(SessionAccountsSetParams params)	Apply one non-interactive accounts mutation: switch the active account, log an account out, or set credentials from a token.
CompletableFuture<SessionModeSetResult>	SessionModeApi.set(SessionModeSetParams params)	Sets the current agent interaction mode.
CompletableFuture<Void>	SessionNameApi.set(SessionNameSetParams params)	Sets the session's friendly name.
CompletableFuture<Void>	SessionToolsApi.set(SessionToolsSetParams params)	Atomically replaces the complete externally implemented tool list supplied by the calling connection.
CompletableFuture<SessionVisibilitySetResult>	SessionVisibilityApi.set(SessionVisibilitySetParams params)	Sets the session's Mission Control sharing status, controlling whether the synced session is visible to repository readers.
CompletableFuture<Void>	ServerSessionsApi.setAdditionalPlugins(SessionsSetAdditionalPluginsParams params)	Replaces the manager-wide additional plugins registered with the session manager.
CompletableFuture<SessionModelSetAllowedModelsResult>	SessionModelApi.setAllowedModels(SessionModelSetAllowedModelsParams params)	Replaces or clears the host-supplied model allowlist for a running session.
CompletableFuture<SessionPermissionsSetApproveAllResult>	SessionPermissionsApi.setApproveAll(SessionPermissionsSetApproveAllParams params)	Enables or disables automatic approval of tool permission requests for the session.
CompletableFuture<SessionNameSetAutoResult>	SessionNameApi.setAuto(SessionNameSetAutoParams params)	Persists an auto-generated session summary as the session's name when no user-set name exists.
CompletableFuture<SessionGitHubAuthSetCredentialsResult>	SessionGitHubAuthApi.setCredentials(SessionGitHubAuthSetCredentialsParams params)	Updates the session's auth credentials used for outbound model and API requests.
CompletableFuture<Void>	ServerSkillsConfigApi.setDisabledSkills(SkillsConfigSetDisabledSkillsParams params)	Replaces the global list of disabled skills.
CompletableFuture<Void>	SessionQueueApi.setDrainPaused(SessionQueueSetDrainPausedParams params)	Acquires or releases the queued-lane drain pause.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.setEnabled(SkillsInstallationsSetEnabledParams params)	Atomically persists enablement for one owned Agent Finder Skill and reconciles the selected bound session.
CompletableFuture<SessionMcpSetEnvValueModeResult>	SessionMcpApi.setEnvValueMode(SessionMcpSetEnvValueModeParams params)	Sets how environment-variable values supplied to MCP servers are resolved (direct or indirect).
CompletableFuture<Void>	SessionTelemetryApi.setFeatureOverrides(SessionTelemetrySetFeatureOverridesParams params)	Sets feature override key/value pairs to attach to subsequent telemetry events for the session.
CompletableFuture<Void>	SessionMcpAppsApi.setHostContext(SessionMcpAppsSetHostContextParams params)	Replace the host context returned to MCP App guests on `ui/initialize`.
CompletableFuture<SessionPermissionsSetModeResult>	SessionPermissionsApi.setMode(SessionPermissionsSetModeParams params)	Sets the permission mode for the session.
CompletableFuture<Void>	SessionAgentApi.setPrompt(SessionAgentSetPromptParams params)	Sets an in-memory authored prompt override for an available agent.
CompletableFuture<LlmInferenceSetProviderResult>	ServerLlmInferenceApi.setProvider()	Registers an SDK client as the LLM inference callback provider.
CompletableFuture<SessionFsSetProviderResult>	ServerSessionFsApi.setProvider(SessionFsSetProviderParams params)	Registers an SDK client as the session filesystem provider.
CompletableFuture<SessionModelSetReasoningEffortResult>	SessionModelApi.setReasoningEffort(SessionModelSetReasoningEffortParams params)	Updates the session's reasoning effort without changing the selected model.
CompletableFuture<SessionsSetRemoteControlSteeringResult>	ServerSessionsApi.setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params)	Patches the steering state of the active remote-control singleton.
CompletableFuture<SessionPermissionsSetRequiredResult>	SessionPermissionsApi.setRequired(SessionPermissionsSetRequiredParams params)	Sets whether the client wants permission prompts bridged into session events.
CompletableFuture<Void>	ServerSkillsConfigApi.setSkillDisabled(SkillsConfigSetSkillDisabledParams params)	Atomically adds or removes one skill from the disabled list.
CompletableFuture<SessionPermissionsUrlsSetUnrestrictedModeResult>	SessionPermissionsUrlsApi.setUnrestrictedMode(SessionPermissionsUrlsSetUnrestrictedModeParams params)	Toggles the runtime's URL-permission policy between unrestricted and restricted modes.
CompletableFuture<SessionMetadataSetWorkingDirectoryResult>	SessionMetadataApi.setWorkingDirectory(SessionMetadataSetWorkingDirectoryParams params)	Updates the session's working directory.
CompletableFuture<Void>	ServerRuntimeApi.shutdown()	Gracefully shuts down an SDK-owned runtime.
CompletableFuture<Void>	SessionRpc.shutdown(SessionShutdownParams params)	Shuts down the session and persists its final state.
CompletableFuture<SessionMetadataSnapshotResult>	SessionMetadataApi.snapshot()	Returns a snapshot of the session's identifying metadata, mode, agent, and remote info.
CompletableFuture<AgentRegistrySpawnResult>	ServerAgentRegistryApi.spawn(AgentRegistrySpawnParams params)	Spawns a managed-server child with the supplied configuration and returns a discriminated-union result.
CompletableFuture<HostStartResult>	ServerHostApi.start(HostStartParams params)	Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.
CompletableFuture<HostStartResult>	ServerHostApi.start(HostStartRequest request)	Starts a connection-owned AHP host with explicit localServer and/or githubEnvironment transports as a supervised SDK participant.
CompletableFuture<SessionFleetStartResult>	SessionFleetApi.start(SessionFleetStartParams params)	Starts fleet mode by submitting the fleet orchestration prompt to the session.
CompletableFuture<SessionTasksStartAgentResult>	SessionTasksApi.startAgent(SessionTasksStartAgentParams params)	Starts a background agent task in the session.
CompletableFuture<SessionsStartRemoteControlResult>	ServerSessionsApi.startRemoteControl(SessionsStartRemoteControlParams params)	Attaches the runtime-managed remote-control singleton to a session, awaiting initial setup.
CompletableFuture<Void>	SessionMcpApi.startServer(SessionMcpStartServerParams params)	Starts an individual MCP server on the live session.
CompletableFuture<Void>	SessionMcpApi.startServer(SessionMcpStartServerRequest request)	Starts an individual MCP server on the live session.
CompletableFuture<SessionWorkspacesStatFileResult>	SessionWorkspacesApi.statFile(SessionWorkspacesStatFileParams params)	Returns metadata for a file or directory in the session workspace files directory.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.status(McpInstallationsStatusParams params)	Inspects a known operation only on its original connection.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.status(SkillsInstallationsStatusParams params)	Inspects a known Skill installation operation on its original runtime connection.
CompletableFuture<SessionScheduleStopResult>	SessionScheduleApi.stop(SessionScheduleStopParams params)	Removes a scheduled prompt by id.
CompletableFuture<SessionsStopRemoteControlResult>	ServerSessionsApi.stopRemoteControl()	Stops the remote-control singleton.
CompletableFuture<SessionsStopRemoteControlResult>	ServerSessionsApi.stopRemoteControl(SessionsStopRemoteControlParams params)	Stops the remote-control singleton.
CompletableFuture<Void>	SessionMcpApi.stopServer(SessionMcpStopServerParams params)	Stops an individual MCP server on the session's host.
CompletableFuture<Void>	SessionMcpApi.stopServer(SessionMcpStopServerRequest request)	Stops an individual MCP server on the session's host.
CompletableFuture<SessionHistorySummarizeForHandoffResult>	SessionHistoryApi.summarizeForHandoff()	Produces a markdown summary of the session's conversation context for hand-off scenarios.
CompletableFuture<Void>	SessionRpc.suspend()	Suspends the session while preserving persisted state for later resume.
CompletableFuture<SessionModelSwitchAutoTierResult>	SessionModelApi.switchAutoTier(SessionModelSwitchAutoTierParams params)	Requests an Auto preference change without changing the session's selected model.
CompletableFuture<SessionModelSwitchToResult>	SessionModelApi.switchTo(SessionModelSwitchToParams params)	Switches the session to a model and optional reasoning configuration.
CompletableFuture<SessionModelSwitchToResult>	SessionModelApi.switchTo(SessionModelSwitchToRequest request)	Switches the session to a model and optional reasoning configuration.
CompletableFuture<SessionProviderSyncResult>	SessionProviderApi.sync(SessionProviderSyncParams params)	Atomically updates the session's BYOK provider and model registry by applying the supplied snapshot, replacing existing entries, updating models, or removing entries absent from the snapshot.
CompletableFuture<SessionEventLogTailResult>	SessionEventLogApi.tail()	Returns a snapshot of the current tail cursor without consuming events.
CompletableFuture<List<QuotaWarningProjection>>	SessionQuotaApi.takeWarnings()	Returns and clears the session's pending quota warnings.
CompletableFuture<SessionToolsTaskCompleteEventDataResult>	SessionToolsApi.taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params)	Projects a completed task_complete tool call into its label-safe session event payload.
CompletableFuture<SessionsTransferRemoteControlResult>	ServerSessionsApi.transferRemoteControl(SessionsTransferRemoteControlParams params)	Atomically rebinds the remote-control singleton to a different session, preserving the underlying Mission Control connection.
CompletableFuture<SessionHistoryTruncateResult>	SessionHistoryApi.truncate(SessionHistoryTruncateParams params)	Truncates persisted session history to a specific event.
CompletableFuture<SessionWorkspacesTruncateSummariesResult>	SessionWorkspacesApi.truncateSummaries(SessionWorkspacesTruncateSummariesParams params)	Truncates local workspace compaction summaries after a rollback.
CompletableFuture<SandboxProxyCaTrustResult>	ServerSandboxProxyCaApi.trust(SandboxProxyCaTrustParams params)	Adds the persistent certificate authority of the sandbox credential proxy to OS trust, so sandboxed clients that read only OS trust accept the proxy.
CompletableFuture<Void>	ServerPluginsApi.uninstall(PluginsUninstallParams params)	Uninstalls an installed plugin.
CompletableFuture<Void>	SessionPluginsApi.uninstall(SessionPluginsUninstallParams params)	Uninstalls a plugin when permitted by the live session's retained managed policy.
CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult>	SessionUiApi.unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)	Unregisters a previously-registered in-process auto-mode-switch handler by its opaque handle.
CompletableFuture<Void>	ServerMcpConfigApi.update(McpConfigUpdateParams params)	Updates an MCP server in user configuration.
CompletableFuture<PluginsUpdateResult>	ServerPluginsApi.update(PluginsUpdateParams params)	Updates an installed plugin to its latest published version.
CompletableFuture<SessionOptionsUpdateResult>	SessionOptionsApi.update(SessionOptionsUpdateParams params)	Patches the genuinely-mutable subset of session options.
CompletableFuture<Void>	SessionPlanApi.update(SessionPlanUpdateParams params)	Writes new content to the session plan file.
CompletableFuture<SessionPluginsUpdateResult>	SessionPluginsApi.update(SessionPluginsUpdateParams params)	Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.
CompletableFuture<SessionTasksUpdateResult>	SessionTasksApi.update(SessionTasksUpdateParams params)	Publishes generic progress or a terminal outcome for a client-owned task.
CompletableFuture<PluginsUpdateAllResult>	ServerPluginsApi.updateAll()	Updates every installed plugin to its latest published version.
CompletableFuture<ClientMetadata>	SessionMetadataApi.updateClientMetadata(SessionMetadataUpdateClientMetadataParams params)	Atomically patches the client-owned string metadata persisted with this local session and returns the committed bag.
CompletableFuture<SessionWorkspacesUpdateMetadataResult>	SessionWorkspacesApi.updateMetadata(SessionWorkspacesUpdateMetadataParams params)	Updates workspace metadata for a local session and returns the refreshed workspace.
CompletableFuture<SessionPermissionsPathsUpdatePrimaryResult>	SessionPermissionsPathsApi.updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params)	Updates the session's primary working directory used by the permission policy.
CompletableFuture<Void>	SessionToolsApi.updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params)	Sets the current session's live subagent settings override, which takes precedence over persisted user settings until cleared.
CompletableFuture<SessionQueueUpdateTextResult>	SessionQueueApi.updateText(SessionQueueUpdateTextParams params)	Updates the text of an addressable single-message queue item.
CompletableFuture<ManagedSettingsValidateResult>	ServerManagedSettingsApi.validate(ManagedSettingsValidateParams params)	Validates a candidate managed-settings document the way the runtime validates delivered policy, without applying it.
CompletableFuture<Void>	SessionTasksApi.waitForPending()	Waits for all in-flight background tasks and any follow-up turns to settle.
CompletableFuture<SessionProviderWithdrawResult>	SessionProviderApi.withdraw(SessionProviderWithdrawParams params)	Withdraws named host-managed models from the session's BYOK registry, leaving every other entry untouched.
CompletableFuture<SessionQueueWithdrawMessageResult>	SessionQueueApi.withdrawMessage(SessionQueueWithdrawMessageParams params)	Atomically withdraws an unchanged user message of a local session: from the queued or steering lane while unconsumed, or from the running turn it started while the model has not answered it and nothing the user sent after it is pending.
CompletableFuture<SessionWorkspacesWriteAutopilotObjectiveResult>	SessionWorkspacesApi.writeAutopilotObjective(SessionWorkspacesWriteAutopilotObjectiveParams params)	Writes the autopilot objective state file in the local session workspace.

Uses of CopilotExperimental in com.github.copilot.rpc

Classes in com.github.copilot.rpc with annotations of type CopilotExperimental

Modifier and Type	Interface	Description
interface	BearerTokenProvider	Functional interface for supplying per-provider bearer tokens for BYOK provider requests.
interface	ExtensionLaunchProvider	Resolves launch profiles for extension entrypoints discovered by the runtime.
class	ImageGenerationConfig	Experimental. This API may change or be removed in a future release.
final class	InProcessRuntimeConnection	Hosts the runtime in-process by loading its native library and communicating over the C ABI — no child process is spawned by the SDK for JSON-RPC transport.
final class	InstallationConfirmationContext	Cancellation signal for one installation confirmation request.
interface	InstallationConfirmationHandler	Handles connection-global installation confirmation requests from the runtime.
class	NamedProviderConfig	A named BYOK (Bring Your Own Key) provider connection in the multi-provider registry.
class	ProviderModelConfig	A BYOK (Bring Your Own Key) model definition in the multi-provider registry.
class	ProviderTokenArgs	Arguments passed to a BYOK bearer-token provider callback.
class	RuntimeConnection	Configures how a CopilotClient connects to the Copilot runtime.
final class	StdioRuntimeConnection	Spawns a runtime child process and communicates over its stdin/stdout.
final class	TcpRuntimeConnection	Spawns a runtime child process listening on a TCP socket and connects to it.
final class	UriRuntimeConnection	Connects to an already-running runtime at the configured URL.

Methods in com.github.copilot.rpc with annotations of type CopilotExperimental

Modifier and Type	Method	Description
ResumeSessionConfig	ResumeSessionConfig.clearEnableCitations()	Clears the enableCitations setting, reverting to the default behavior.
SessionConfig	SessionConfig.clearEnableCitations()	Clears the enableCitations setting, reverting to the default behavior.
ResumeSessionConfig	ResumeSessionConfig.clearSessionLimits()	Clears the sessionLimits setting, reverting to the default behavior.
SessionConfig	SessionConfig.clearSessionLimits()	Clears the sessionLimits setting, reverting to the default behavior.
ToolDefinition	ToolDefinition.defer(ToolDefer value)	Returns a copy with the defer mode set.
static InProcessRuntimeConnection	RuntimeConnection.forInProcess()	Hosts the runtime in-process by loading its native library and communicating over the C ABI — no child process is spawned by the SDK for JSON-RPC transport.
static <T1,T2,R> ToolDefinition	ToolDefinition.from(String name, String description, Param<T1> p1, Param<T2> p2, BiFunction<T1,T2,R> handler)	Creates a tool definition with a two-argument synchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.from(String name, String description, Param<T1> p1, Function<T1,R> handler)	Creates a tool definition with a one-argument synchronous handler.
static <R> ToolDefinition	ToolDefinition.from(String name, String description, Supplier<R> handler)	Creates a tool definition with a zero-argument synchronous handler.
static <T1,T2,R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Param<T1> p1, Param<T2> p2, BiFunction<T1, T2, CompletableFuture<R>> handler)	Creates a tool definition with a two-argument asynchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Param<T1> p1, Function<T1, CompletableFuture<R>> handler)	Creates a tool definition with a one-argument asynchronous handler.
static <R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Supplier<CompletableFuture<R>> handler)	Creates a tool definition with a zero-argument asynchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.fromAsyncWithToolInvocation(String name, String description, Param<T1> p1, BiFunction<T1, ToolInvocation, CompletableFuture<R>> handler)	Creates a tool definition with a one-argument asynchronous handler that also receives the ToolInvocation context.
static <R> ToolDefinition	ToolDefinition.fromAsyncWithToolInvocation(String name, String description, Function<ToolInvocation, CompletableFuture<R>> handler)	Creates a tool definition with a zero-argument asynchronous handler that receives the ToolInvocation context.
static List<ToolDefinition>	ToolDefinition.fromClass(Class<?> clazz)	Discovers tool definitions from a class with static @CopilotTool-annotated methods.
static List<ToolDefinition>	ToolDefinition.fromObject(Object instance)	Discovers tool definitions from an object whose methods are annotated with @CopilotTool.
static <T1,R> ToolDefinition	ToolDefinition.fromWithToolInvocation(String name, String description, Param<T1> p1, BiFunction<T1, ToolInvocation, R> handler)	Creates a tool definition with a one-argument synchronous handler that also receives the ToolInvocation context.
static <R> ToolDefinition	ToolDefinition.fromWithToolInvocation(String name, String description, Function<ToolInvocation, R> handler)	Creates a tool definition with a zero-argument synchronous handler that receives the ToolInvocation context.
String	ToolInvocation.getAgentId()	Gets the sub-agent instance that issued this call.
AutoTier	SetModelOptions.getAutoTier()	Gets the requested Auto routing preference.
RuntimeConnection	CopilotClientOptions.getConnection()	Gets the connection that selects how the client reaches the Copilot runtime.
Optional<Boolean>	ResumeSessionConfig.getEnableCitations()	Gets whether native model citations are enabled.
Optional<Boolean>	SessionConfig.getEnableCitations()	Gets whether native model citations are enabled.
ExtensionLaunchProvider	CopilotClientOptions.getExtensionLaunchProvider()	Gets the connection-level extension launch profile provider.
ImageGenerationConfig	ResumeSessionConfig.getImageGeneration()	Gets the non-persisted image generation opt-in.
ImageGenerationConfig	SessionConfig.getImageGeneration()	Gets the non-persisted image generation opt-in.
InstallationConfirmationHandler	CopilotClientOptions.getInstallationConfirmationHandler()	Gets the connection-level installation confirmation handler.
List<ProviderModelConfig>	CreateSessionRequest.getModels()	Gets the BYOK model definitions.
List<ProviderModelConfig>	ResumeSessionConfig.getModels()	Gets the BYOK model definitions.
List<ProviderModelConfig>	ResumeSessionRequest.getModels()	Gets the BYOK model definitions.
List<ProviderModelConfig>	SessionConfig.getModels()	Gets the BYOK model definitions.
Function<GitHubTelemetryNotification, CompletableFuture<Void>>	CopilotClientOptions.getOnGitHubTelemetry()	Gets the connection-level GitHub telemetry forwarding handler.
List<NamedProviderConfig>	CreateSessionRequest.getProviders()	Gets the named provider connections.
List<NamedProviderConfig>	ResumeSessionConfig.getProviders()	Gets the named BYOK provider connections.
List<NamedProviderConfig>	ResumeSessionRequest.getProviders()	Gets the named provider connections.
List<NamedProviderConfig>	SessionConfig.getProviders()	Gets the named BYOK provider connections.
String	ToolInvocation.getRequestId()	Gets the runtime request id of this call.
Map<String,Object>	MessageOptions.getResponseSchema()	Gets this run's output schema.
SessionLimitsConfig	ResumeSessionConfig.getSessionLimits()	Gets the limits for this session's current accounting window.
SessionLimitsConfig	SessionConfig.getSessionLimits()	Gets the limits for this session's current accounting window.
SkillProvider	ResumeSessionConfig.getSkillProvider()	Gets the session-scoped skill provider for the resumed session.
SkillProvider	SessionConfig.getSkillProvider()	Gets the session-scoped skill provider.
boolean	SetModelOptions.isResetAutoTier()	Gets whether the request returns to provider-default Auto routing.
ToolDefinition	ToolDefinition.isTerminal(boolean value)	Returns a copy with the isTerminal flag set.
ToolDefinition	ToolDefinition.metadata(Map<String,Object> value)	Returns a copy with the opaque metadata bag set.
ToolDefinition	ToolDefinition.overridesBuiltInTool(boolean value)	Returns a copy with the overridesBuiltInTool flag set.
ToolInvocation	ToolInvocation.setAgentId(String agentId)	Sets the sub-agent instance that issued this call.
SetModelOptions	SetModelOptions.setAutoTier(AutoTier autoTier)	Requests an Auto routing preference alongside the model switch.
CopilotClientOptions	CopilotClientOptions.setConnection(RuntimeConnection connection)	Sets the connection that selects how the client reaches the Copilot runtime.
ResumeSessionConfig	ResumeSessionConfig.setEnableCitations(boolean enableCitations)	Enables or disables native model citations for supported providers.
SessionConfig	SessionConfig.setEnableCitations(boolean enableCitations)	Enables or disables native model citations for supported providers.
CopilotClientOptions	CopilotClientOptions.setExtensionLaunchProvider(ExtensionLaunchProvider extensionLaunchProvider)	Sets the connection-level extension launch profile provider.
ResumeSessionConfig	ResumeSessionConfig.setImageGeneration(ImageGenerationConfig imageGeneration)	Sets the image generation opt-in.
SessionConfig	SessionConfig.setImageGeneration(ImageGenerationConfig imageGeneration)	Sets the image generation opt-in.
CopilotClientOptions	CopilotClientOptions.setInstallationConfirmationHandler(InstallationConfirmationHandler installationConfirmationHandler)	Sets the connection-level installation confirmation handler.
void	CreateSessionRequest.setModels(List<ProviderModelConfig> models)	Sets the BYOK model definitions.
ResumeSessionConfig	ResumeSessionConfig.setModels(List<ProviderModelConfig> models)	Re-supplies the BYOK model definitions on resume, each referencing a named provider supplied via ResumeSessionConfig.setProviders(List).
void	ResumeSessionRequest.setModels(List<ProviderModelConfig> models)	Sets the BYOK model definitions.
SessionConfig	SessionConfig.setModels(List<ProviderModelConfig> models)	Sets the BYOK model definitions, each referencing a named provider supplied via SessionConfig.setProviders(List).
CopilotClientOptions	CopilotClientOptions.setOnGitHubTelemetry(Function<GitHubTelemetryNotification, CompletableFuture<Void>> onGitHubTelemetry)	Sets a connection-level handler for GitHub telemetry forwarding (experimental).
void	CreateSessionRequest.setProviders(List<NamedProviderConfig> providers)	Sets the named provider connections.
ResumeSessionConfig	ResumeSessionConfig.setProviders(List<NamedProviderConfig> providers)	Re-supplies the named BYOK provider connections on resume (additive multi-provider registry).
void	ResumeSessionRequest.setProviders(List<NamedProviderConfig> providers)	Sets the named provider connections.
SessionConfig	SessionConfig.setProviders(List<NamedProviderConfig> providers)	Sets the named BYOK provider connections (additive multi-provider registry).
ToolInvocation	ToolInvocation.setRequestId(String requestId)	Sets the runtime request id of this call.
SetModelOptions	SetModelOptions.setResetAutoTier(boolean resetAutoTier)	Requests a return to the provider's default Auto routing.
MessageOptions	MessageOptions.setResponseSchema(Map<String,Object> responseSchema)	Requests provider-native JSON Schema output for this run.
ResumeSessionConfig	ResumeSessionConfig.setSessionLimits(SessionLimitsConfig sessionLimits)	Sets limits for this session's current accounting window.
SessionConfig	SessionConfig.setSessionLimits(SessionLimitsConfig sessionLimits)	Sets limits for this session's current accounting window.
ResumeSessionConfig	ResumeSessionConfig.setSkillProvider(SkillProvider skillProvider)	Sets the session-scoped skill provider for the resumed session.
SessionConfig	SessionConfig.setSkillProvider(SkillProvider skillProvider)	Sets the session-scoped skill provider.
ToolDefinition	ToolDefinition.skipPermission(boolean value)	Returns a copy with the skipPermission flag set.

Uses of CopilotExperimental in com.github.copilot.tool

Classes in com.github.copilot.tool with annotations of type CopilotExperimental

Modifier and Type	Class	Description
class	CopilotResponseProcessor	Generates response metadata using the existing custom-tool schema generator.
@interface	CopilotTool	Marks a method as a Copilot tool.
interface	CopilotToolMetadataProvider<T>	Contract for classes that provide ToolDefinition metadata for @CopilotTool-annotated methods.
@interface	CopilotToolParam	Annotates a parameter of a CopilotTool-annotated method to provide metadata about the parameter that is sent to the model.
class	CopilotToolProcessor	JSR 269 annotation processor that finds CopilotTool-annotated methods and generates $$CopilotToolMeta companion classes containing tool definitions, JSON Schema, and invocation lambdas.
final class	Param<T>	Runtime parameter metadata for lambda-defined tools.
class	SchemaGenerator	Compile-time utility that maps javax.lang.model types to JSON Schema represented as Java source code literals (Map.of(...) expressions).