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
@interface	CopilotResponse	Generates a response schema using the same annotation processor and type mappings as @CopilotTool.

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.

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 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	PermissionMessageAuthorizationPolarity	Direction stored in a historical extractor claim.
enum	PermissionMode	Permission mode for the session.
final record	TaskBlocker	Structured reason that the task cannot continue without intervention
final record	ToolExecutionCompleteShellExecution	Experimental shell completion facts retained independently of the full tool result.
enum	UIEphemeralQueryPhase	Lifecycle phase for a Rust-owned ephemeral query stream.

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	AccountsAcquireEntraTokenParams	OneAuth token request supplied by a trusted host application.
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	AuthLoginResultDto	Terminal result of an interactive login flow.
enum	AuthLoginResultStatus	Terminal disposition of a login persistence attempt.
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.
enum	CommandsInvocationEffectOutcome	Whether a pending slash-command invocation effect was applied or cancelled by the host.
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.
enum	ConnectorMcpStatus	Live MCP status of one Connector-owned runtime server.
final record	ConnectorRuntimeStatus	Live status of one session-owned MCP projection.
final record	ConnectorStatus	Authoritative session connector state.
final record	ConnectParams	Connection-level opt-ins for the `server.connect` handshake.
final record	ConnectResult	Handshake result reporting the server's protocol version and package version on success.
final record	ContentExclusionPathCheck	Content-exclusion decision for one requested path.
final record	DiagnosticsConfiguration	Per-source session diagnostics configuration.
final record	DiscoveredCanvas	Canvas available in the current session.
class	EntraTokenAcquireResult	Result of a OneAuth token acquisition.
enum	EntraTokenInteraction	How far OneAuth may go to acquire the requested token.
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	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	HooksInvokeResult	Optional output returned by an SDK callback hook.
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	ManagedSettingsReadResult	Validated device-managed settings discovered before a session exists.
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	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	ModelProviderDescriptor	One model provider available to the session — the model analog of the account `ProviderDescriptor`.
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 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	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.
final record	SandboxGetHostSupportResult	Whether the host running this runtime can run the command sandbox.
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	SessionCanvasProviderRegisterParams	Internal canvas provider registration parameters.
final record	SessionCanvasProviderUnregisterParams	Internal canvas provider unregistration parameters.
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	SessionCommandsFinalizeInvocationEffectParams	The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it.
final record	SessionCommandsFinalizeInvocationEffectResult	Whether finalizing the invocation effect succeeded, and the failure reason when it did not.
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	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	SessionConnectorsReconcileForStartupParams	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
final record	SessionConnectorsReconcileForStartupResult	Authoritative session connector state.
final record	SessionConnectorsReconcileParams	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	SessionConnectorsWithdrawProjectionParams	Identifies the target session.
final record	SessionConnectorsWithdrawProjectionResult	Authoritative session connector state.
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	SessionCustomizationsReloadResult	Diagnostics from reloading skill definitions, with warnings and errors as separate lists.
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	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	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	SessionFsWriteFileParams	File path, content to write, and optional mode for the client-provided session filesystem.
final record	SessionGitHubAuthGetAllAuthAvailableParams	Identifies the target session.
final record	SessionGitHubAuthGetCurrentAuthInfoParams	Identifies the target session.
final record	SessionGitHubAuthGetStatusParams	Identifies the target session.
final record	SessionGitHubAuthGetStatusResult	Authentication status and account metadata for the session.
final record	SessionGitHubAuthLastAuthErrorsParams	Identifies the target session.
final record	SessionGitHubAuthLoginParams	Internal GitHub login parameters.
final record	SessionGitHubAuthLogoutParams	Identifies the target session.
final record	SessionGitHubAuthLogoutUserParams	Parameters identifying a GitHub authentication to log out.
final record	SessionGitHubAuthRefreshCopilotUserParams	Identifies the target session.
final record	SessionGitHubAuthSetCredentialsParams	New auth credentials to install on the session.
final record	SessionGitHubAuthSetCredentialsResult	Indicates whether the credential update succeeded.
final record	SessionGitHubAuthSwitchToAuthParams	Parameters for switching the session's active authentication.
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	Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed.
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	SessionMcpConfigureGitHubParams	Credential-free authentication identity used to configure GitHub MCP.
final record	SessionMcpConfigureGitHubResult	Result of configuring GitHub MCP.
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	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	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 success-page copy, and static OAuth client selection.
final class	SessionMcpOauthLoginRequest	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, 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	SessionMcpRegisterExternalClientParams	Registration parameters for an external MCP client.
final record	SessionMcpReloadParams	Identifies the target session.
final record	SessionMcpReloadWithConfigParams	Opaque MCP reload configuration.
final record	SessionMcpReloadWithConfigResult	MCP server startup filtering result.
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	SessionMcpUnregisterExternalClientParams	Server name identifying the external client to remove.
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	SessionModelApplyStartupOverlayParams	Managed, repository, and CLI model overrides to overlay onto the session at startup.
final record	SessionModelApplyStartupOverlayResult	The model identifier active on the session after the switch.
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 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	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	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	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	SessionQueueBeginDeferredIdleDrainParams	Inputs for starting a deferred-idle drain.
final record	SessionQueueBeginDeferredIdleDrainResult	Whether a deferred-idle drain should run.
final record	SessionQueueClearParams	Identifies the target session.
final record	SessionQueueConsumeSystemNotificationsParams	Internal filter for consuming queued system notifications.
final record	SessionQueueConsumeSystemNotificationsResult	Indicates whether a user-facing pending item was removed.
final record	SessionQueueDeferSessionIdleParams	Inputs for marking session.idle deferred in native state.
final record	SessionQueueDuplicateAtParams	Parameters for duplicating a queued item.
final record	SessionQueueDuplicateAtResult	Result of duplicating a queued item.
final record	SessionQueueEnqueueResumePendingParams	Identifies the target session.
final record	SessionQueueEnqueueResumePendingResult	Result of enqueueing the resume-pending wake item.
final record	SessionQueueFinishDeferredIdleDrainParams	Inputs for completing a deferred-idle drain.
final record	SessionQueueFinishDeferredIdleDrainResult	Action selected by the native deferred-idle drain.
final record	SessionQueueHasPendingParams	Identifies the target session.
final record	SessionQueueHasPendingResult	Whether the native queue has pending work.
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	SessionQueueProcessParams	Identifies the target session.
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	SessionQueueSnapshotParams	Identifies the target session.
final record	SessionQueueSnapshotResult	Internal snapshot of native queue state for local session orchestration.
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	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	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	SessionScheduleAddAtParams	Register an absolute-time scheduled prompt.
final record	SessionScheduleAddAtResult	Result of registering or re-arming a scheduled prompt.
final record	SessionScheduleAddCronParams	Register a cron scheduled prompt.
final record	SessionScheduleAddCronResult	Result of registering or re-arming a scheduled prompt.
final record	SessionScheduleAddParams	Register a relative-interval scheduled prompt.
final record	SessionScheduleAddResult	Result of registering or re-arming a scheduled prompt.
final record	SessionScheduleAddSelfPacedParams	Register a self-paced scheduled prompt.
final record	SessionScheduleAddSelfPacedResult	Result of registering or re-arming a scheduled prompt.
final record	SessionScheduleHasSelfPacedParams	Identifies the target session.
final record	SessionScheduleHasSelfPacedResult	Whether the session currently has an active self-paced schedule.
final record	SessionScheduleHydrateParams	Identifies the target session.
final record	SessionScheduleListParams	Identifies the target session.
final record	SessionScheduleListResult	Snapshot of the currently active recurring prompts for this session.
final record	SessionScheduleRearmSelfPacedParams	Re-arm a self-paced scheduled prompt.
final record	SessionScheduleRearmSelfPacedResult	Result of registering or re-arming a scheduled prompt.
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	SessionsConfigureSessionExtensionsParams	Params to attach or detach an in-process ExtensionController delegate.
final record	SessionsConnectParams	Remote session connection parameters.
final record	SessionsConnectResult	Remote session connection result.
final record	SessionsDeleteParams	Session ID to delete from disk.
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	SessionSendSystemNotificationParams	Internal request for sending a system notification.
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	SessionSettingsEvaluatePredicateParams	Named Rust-owned settings predicate to evaluate for this session.
final record	SessionSettingsEvaluatePredicateResult	Result of evaluating a Rust-owned settings predicate.
final record	SessionSettingsSnapshotParams	Identifies the target session.
final record	SessionSettingsSnapshotResult	Redacted, serializable view of session runtime settings for SDK boundary consumers.
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	SessionsGetBoardEntryCountParams	Session ID whose board entry count should be returned.
final record	SessionsGetBoardEntryCountResult	Dynamic-context board entry count, when available.
final record	SessionsGetClientMetadataParams	Bounded batch request for client-owned metadata from persisted local sessions.
final record	SessionsGetEventFilePathParams	Session ID whose event-log file path to compute.
final record	SessionsGetEventFilePathResult	Absolute path to the session's events.jsonl file on disk.
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	SessionsGetMetadataParams	Session ID whose persisted metadata should be read.
final record	SessionsGetMetadataResult	Persisted local session metadata when the session exists.
final record	SessionsGetPersistedRemoteSteerableParams	Session ID to look up the persisted remote-steerable flag for.
final record	SessionsGetPersistedRemoteSteerableResult	The session's persisted remote-steerable flag, or omitted when no value has been persisted.
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 process, used to correlate streamed output and exit notifications.
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	SessionsListNonEmptySessionIdsParams	Limit for non-empty local session IDs.
final record	SessionsListNonEmptySessionIdsResult	Recent local session IDs that contain user-visible history.
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	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	SessionWorkflowPauseAtCheckpointParams	Parameters for an owned durable pause checkpoint.
final record	SessionWorkflowPauseAtCheckpointResult	Result for the session.workflow.pauseAtCheckpoint RPC method.
final record	SessionWorkflowPauseParams	Parameters for pausing a running workflow.
final record	SessionWorkflowPauseResult	Complete current or terminal workflow run envelope.
final record	SessionWorkflowResumeFromToolParams	Internal parameters for resuming a workflow run from a tool.
final record	SessionWorkflowResumeFromToolResult	Resolved persisted workflow identity and resumed 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	SessionWorkflowRunFromToolParams	Internal parameters for invoking a registered workflow from a tool.
final record	SessionWorkflowRunFromToolResult	Complete current or terminal workflow 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 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	SkillProviderListParams	Identifies the target session.
final record	SkillProviderListResult	Catalog metadata returned by an SDK session's skill provider.
final record	SkillProviderReadParams	Identifies one SDK-provided skill by invocation name.
final record	SkillProviderReadResult	Complete text-only SKILL.md content returned by an SDK session's skill provider.
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 (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default.
final record	UserSettingsSetParams	Partial user settings to write to settings.json.
final record	UserSettingsSetResult	Outcome of writing user settings.
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.
final record	WorkflowToolRunOptions	Options for an internal tool-originated workflow invocation.

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

Modifier and Type	Method	Description
CompletableFuture<SessionAbortResult>	SessionRpc.abort(SessionAbortParams params)	Parameters for aborting the current turn
CompletableFuture<SessionHistoryAbortManualCompactionResult>	SessionHistoryApi.abortManualCompaction()	Identifies the target session.
CompletableFuture<EntraTokenAcquireResult>	ServerAccountsApi.acquireEntraToken(AccountsAcquireEntraTokenParams params)	OneAuth token request supplied by a trusted host application.
CompletableFuture<SessionMetadataActivityResult>	SessionMetadataApi.activity()	Identifies the target session.
CompletableFuture<Void>	ServerMcpConfigApi.add(McpConfigAddParams params)	MCP server name and configuration to add to user configuration.
CompletableFuture<PluginsMarketplacesAddResult>	ServerPluginsMarketplacesApi.add(PluginsMarketplacesAddParams params)	Marketplace source and optional working directory for relative-path resolution.
CompletableFuture<SessionPermissionsPathsAddResult>	SessionPermissionsPathsApi.add(SessionPermissionsPathsAddParams params)	Directory path to add to the session's allowed directories.
CompletableFuture<SessionPluginsMarketplacesAddResult>	SessionPluginsMarketplacesApi.add(SessionPluginsMarketplacesAddParams params)	Marketplace source and optional working directory for relative-path resolution.
CompletableFuture<SessionProviderAddResult>	SessionProviderApi.add(SessionProviderAddParams params)	BYOK providers and/or models to add to the session's registry at runtime.
CompletableFuture<SessionScheduleAddResult>	SessionScheduleApi.add(SessionScheduleAddParams params)	Register a relative-interval scheduled prompt.
CompletableFuture<SessionScheduleAddAtResult>	SessionScheduleApi.addAt(SessionScheduleAddAtParams params)	Register an absolute-time scheduled prompt.
CompletableFuture<SessionScheduleAddCronResult>	SessionScheduleApi.addCron(SessionScheduleAddCronParams params)	Register a cron scheduled prompt.
CompletableFuture<SecretsAddFilterValuesResult>	ServerSecretsApi.addFilterValues(SecretsAddFilterValuesParams params)	Secret values to add to the redaction filter.
CompletableFuture<SessionScheduleAddSelfPacedResult>	SessionScheduleApi.addSelfPaced(SessionScheduleAddSelfPacedParams params)	Register a self-paced scheduled prompt.
CompletableFuture<SessionWorkspacesAddSummaryResult>	SessionWorkspacesApi.addSummary(SessionWorkspacesAddSummaryParams params)	Compaction summary checkpoint to persist.
CompletableFuture<SessionPermissionsLocationsAddToolApprovalResult>	SessionPermissionsLocationsApi.addToolApproval(SessionPermissionsLocationsAddToolApprovalParams params)	Location-scoped tool approval to persist.
CompletableFuture<SessionPermissionsFolderTrustAddTrustedResult>	SessionPermissionsFolderTrustApi.addTrusted(SessionPermissionsFolderTrustAddTrustedParams params)	Folder path to add to trusted folders.
CompletableFuture<AuthLoginStep>	SessionAccountsLoginApi.advance(SessionAccountsLoginAdvanceParams params)	Advance an in-flight login flow, optionally fulfilling an input-required step.
CompletableFuture<SessionWorkflowAgentResult>	SessionWorkflowApi.agent(SessionWorkflowAgentParams params)	Parameters for one workflow-scoped subagent call.
CompletableFuture<SessionQueueAppendSteeringResult>	SessionQueueApi.appendSteering(SessionQueueAppendSteeringParams params)	Append to one pending steering message without changing its identity or delivery position.
CompletableFuture<SessionPermissionsLocationsApplyResult>	SessionPermissionsLocationsApi.apply(SessionPermissionsLocationsApplyParams params)	Working directory to load persisted location permissions for.
CompletableFuture<McpInstallationResult>	ServerMcpApi.applyInstall(McpApplyInstallParams params)	Applies exactly one previously prepared operation on its original connection.
CompletableFuture<SkillInstallationResult>	ServerSkillsApi.applyInstall(SkillsApplyInstallParams params)	Applies exactly one retained verified Skill installation plan.
CompletableFuture<SessionModelApplyStartupOverlayResult>	SessionModelApi.applyStartupOverlay(SessionModelApplyStartupOverlayParams params)	Managed, repository, and CLI model overrides to overlay onto the session at startup.
CompletableFuture<McpInstallationResult>	ServerMcpApi.applyUninstall(McpApplyUninstallParams params)	One-use application of the exact retained removal plan.
CompletableFuture<SkillInstallationResult>	ServerSkillsApi.applyUninstall(SkillsApplyUninstallParams params)	One-use application of the exact retained Skill removal plan.
CompletableFuture<Void>	SessionMcpOauthApi.authenticationStateChanged(SessionMcpOauthAuthenticationStateChangedParams params)	Identifies the MCP server whose persisted OAuth credentials were updated.
CompletableFuture<SessionWorkspacesAutopilotObjectiveExistsResult>	SessionWorkspacesApi.autopilotObjectiveExists()	Identifies the target session.
CompletableFuture<SessionAccountsLoginBeginResult>	SessionAccountsLoginApi.begin(SessionAccountsLoginBeginParams params)	Begin an interactive login flow for a provider kind.
CompletableFuture<SessionQueueBeginDeferredIdleDrainResult>	SessionQueueApi.beginDeferredIdleDrain(SessionQueueBeginDeferredIdleDrainParams params)	Inputs for starting a deferred-idle drain.
CompletableFuture<PluginsMarketplacesBrowseResult>	ServerPluginsMarketplacesApi.browse(PluginsMarketplacesBrowseParams params)	Name of the marketplace whose plugin catalog to fetch.
CompletableFuture<SessionPluginsMarketplacesBrowseResult>	SessionPluginsMarketplacesApi.browse(SessionPluginsMarketplacesBrowseParams params)	Name of the marketplace whose plugin catalog to fetch.
CompletableFuture<SessionsBulkDeleteResult>	ServerSessionsApi.bulkDelete(SessionsBulkDeleteParams params)	Session IDs to close, deactivate, and delete from disk.
CompletableFuture<com.fasterxml.jackson.databind.JsonNode>	SessionMcpAppsApi.callTool(SessionMcpAppsCallToolParams params)	MCP server, tool name, and arguments to invoke from an MCP App view.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.cancel(McpInstallationsCancelParams params)	Existing-operation control.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.cancel(SkillsInstallationsCancelParams params)	Existing-operation control.
CompletableFuture<Void>	SessionAccountsLoginApi.cancel(SessionAccountsLoginCancelParams params)	Cancel an in-flight login flow.
CompletableFuture<SessionTasksCancelResult>	SessionTasksApi.cancel(SessionTasksCancelParams params)	Identifier of the background task to cancel.
CompletableFuture<SessionWorkflowCancelResult>	SessionWorkflowApi.cancel(SessionWorkflowCancelParams params)	Parameters for cancelling a workflow run.
CompletableFuture<Void>	SessionRpc.cancelAllBackgroundAgents()	Identifies the target session.
CompletableFuture<SessionHistoryCancelBackgroundCompactionResult>	SessionHistoryApi.cancelBackgroundCompaction()	Identifies the target session.
CompletableFuture<SessionMcpOauthCancelLoginResult>	SessionMcpOauthApi.cancelLogin(SessionMcpOauthCancelLoginParams params)	Targets only the original prepared/applying owned login on this exact session requester.
CompletableFuture<SessionMcpCancelSamplingExecutionResult>	SessionMcpApi.cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params)	The requestId previously passed to executeSampling that should be cancelled.
CompletableFuture<SessionShellCancelUserRequestedResult>	SessionShellApi.cancelUserRequested(SessionShellCancelUserRequestedParams params)	User-requested shell execution cancellation handle.
CompletableFuture<SessionsCheckInUseResult>	ServerSessionsApi.checkInUse(SessionsCheckInUseParams params)	Session IDs to test for live in-use locks.
CompletableFuture<SessionContentExclusionCheckPathsResult>	SessionContentExclusionApi.checkPaths(SessionContentExclusionCheckPathsParams params)	Local file system absolute paths within the session working directory to check against its content-exclusion policy.
CompletableFuture<Void>	SessionQueueApi.clear()	Identifies the target session.
CompletableFuture<Void>	ServerManagedSettingsApi.clearCache()	Invokes managedSettings.clearCache.
CompletableFuture<SessionHistoryClearContextResult>	SessionHistoryApi.clearContext(SessionHistoryClearContextParams params)	Parameters for clearing the conversation and seeding the window that replaces it.
CompletableFuture<Void>	ServerSessionsApi.close(SessionsCloseParams params)	Session ID to close.
CompletableFuture<Void>	SessionCanvasApi.close(SessionCanvasCloseParams params)	Canvas close parameters.
CompletableFuture<SessionDebugCollectLogsResult>	SessionDebugApi.collectLogs(SessionDebugCollectLogsParams params)	Options for collecting a session debug bundle with configurable redaction.
CompletableFuture<SessionHistoryCompactResult>	SessionHistoryApi.compact()	Optional compaction parameters.
CompletableFuture<SessionHistoryCompactResult>	SessionHistoryApi.compact(SessionHistoryCompactParams params)	Optional compaction parameters.
CompletableFuture<SessionDiagnosticsConfigureResult>	SessionDiagnosticsApi.configure(SessionDiagnosticsConfigureParams params)	Patch session diagnostic thresholds for explicitly supplied sources.
CompletableFuture<SessionPermissionsConfigureResult>	SessionPermissionsApi.configure(SessionPermissionsConfigureParams params)	Patch of permission policy fields to apply (omit a field to leave it unchanged).
CompletableFuture<SessionMcpConfigureGitHubResult>	SessionMcpApi.configureGitHub(SessionMcpConfigureGitHubParams params)	Credential-free authentication identity used to configure GitHub MCP.
CompletableFuture<Void>	ServerSessionsApi.configureSessionExtensions(SessionsConfigureSessionExtensionsParams params)	Params to attach or detach an in-process ExtensionController delegate.
CompletableFuture<ConnectResult>	ServerRpc.connect(ConnectParams params)	Connection-level opt-ins for the `server.connect` handshake.
CompletableFuture<SessionsConnectResult>	ServerSessionsApi.connect(SessionsConnectParams params)	Remote session connection parameters.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.connect(SessionConnectorsConnectParams params)	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
CompletableFuture<SessionQueueConsumeSystemNotificationsResult>	SessionQueueApi.consumeSystemNotifications(SessionQueueConsumeSystemNotificationsParams params)	Internal filter for consuming queued system notifications.
CompletableFuture<SessionMetadataContextInfoResult>	SessionMetadataApi.contextInfo(SessionMetadataContextInfoParams params)	Model identifier and token limits used to compute the context-info breakdown.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.continueConnection(SessionConnectorsContinueConnectionParams params)	Explicitly bounded continuation of a pending Connector connection.
CompletableFuture<Void>	SessionWorkspacesApi.createDirectory(SessionWorkspacesCreateDirectoryParams params)	Directory to create within the session workspace files directory.
CompletableFuture<Void>	SessionWorkspacesApi.createFile(SessionWorkspacesCreateFileParams params)	Relative path and UTF-8 content for the workspace file to create or overwrite.
CompletableFuture<Void>	SessionQueueApi.deferSessionIdle(SessionQueueDeferSessionIdleParams params)	Inputs for marking session.idle deferred in native state.
CompletableFuture<Void>	ServerSessionsApi.delete(SessionsDeleteParams params)	Session ID to delete from disk.
CompletableFuture<Void>	SessionPlanApi.delete()	Identifies the target session.
CompletableFuture<SessionWorkspacesDeleteAutopilotObjectiveResult>	SessionWorkspacesApi.deleteAutopilotObjective()	Identifies the target session.
CompletableFuture<Void>	SessionAgentApi.deselect()	Identifies the target session.
CompletableFuture<SessionMcpAppsDiagnoseResult>	SessionMcpAppsApi.diagnose(SessionMcpAppsDiagnoseParams params)	MCP server to diagnose MCP Apps wiring for.
CompletableFuture<SessionWorkspacesDiffResult>	SessionWorkspacesApi.diff(SessionWorkspacesDiffParams params)	Parameters for computing a workspace diff.
CompletableFuture<Void>	ServerExtensionsApi.disable(ExtensionsDisableParams params)	Source-qualified extension identifiers to persistently disable for future sessions.
CompletableFuture<Void>	ServerMcpConfigApi.disable(McpConfigDisableParams params)	MCP server names to disable for new sessions.
CompletableFuture<Void>	ServerPluginsApi.disable(PluginsDisableParams params)	Plugin names (or specs) to disable, plus the optional working directory the repository-controlled guard is evaluated against.
CompletableFuture<Void>	SessionExtensionsApi.disable(SessionExtensionsDisableParams params)	Source-qualified extension identifier to disable for the session.
CompletableFuture<Void>	SessionMcpApi.disable(SessionMcpDisableParams params)	Name of the MCP server to disable for the session.
CompletableFuture<Void>	SessionMcpApi.disable(SessionMcpDisableRequest request)	Name of the MCP server to disable for the session.
CompletableFuture<Void>	SessionPluginsApi.disable(SessionPluginsDisableParams params)	Plugin names (or specs) to disable in the session's authoritative working directory.
CompletableFuture<Void>	SessionRemoteApi.disable()	Identifies the target session.
CompletableFuture<Void>	SessionSkillsApi.disable(SessionSkillsDisableParams params)	Name of the skill to disable for the session.
CompletableFuture<SessionSandboxDisableForSessionResult>	SessionSandboxApi.disableForSession(SessionSandboxDisableForSessionParams params)	Request to disable sandboxing for the current session while resolving an active sandbox-bypass permission prompt.
CompletableFuture<SessionConnectorsDisconnectResult>	SessionConnectorsApi.disconnect(SessionConnectorsDisconnectParams params)	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
CompletableFuture<AgentsDiscoverResult>	ServerAgentsApi.discover(AgentsDiscoverParams params)	Optional project paths to include in agent discovery.
CompletableFuture<ExtensionsDiscoverResult>	ServerExtensionsApi.discover()	Extensions discovered from persisted Copilot home state and their effective loading mode.
CompletableFuture<HooksDiscoverResult>	ServerHooksApi.discover(HooksDiscoverParams params)	Optional project paths and host-exclusion behavior for server-scoped hook discovery.
CompletableFuture<InstructionsDiscoverResult>	ServerInstructionsApi.discover(InstructionsDiscoverParams params)	Optional project paths to include in instruction discovery.
CompletableFuture<McpDiscoverResult>	ServerMcpApi.discover(McpDiscoverParams params)	Optional working directory used as context for MCP server discovery.
CompletableFuture<SkillsDiscoverResult>	ServerSkillsApi.discover(SkillsDiscoverParams params)	Optional project paths and additional skill directories to include in discovery.
CompletableFuture<SessionQueueDuplicateAtResult>	SessionQueueApi.duplicateAt(SessionQueueDuplicateAtParams params)	Parameters for duplicating a queued item.
CompletableFuture<SessionUiElicitationResult>	SessionUiApi.elicitation(SessionUiElicitationParams params)	Prompt message and JSON schema describing the form fields to elicit from the user.
CompletableFuture<Void>	ServerExtensionsApi.enable(ExtensionsEnableParams params)	Source-qualified extension identifiers to persistently enable for future sessions.
CompletableFuture<Void>	ServerMcpConfigApi.enable(McpConfigEnableParams params)	MCP server names to enable for new sessions.
CompletableFuture<Void>	ServerPluginsApi.enable(PluginsEnableParams params)	Plugin names (or specs) to enable, plus the optional working directory the repository-controlled guard is evaluated against.
CompletableFuture<Void>	SessionExtensionsApi.enable(SessionExtensionsEnableParams params)	Source-qualified extension identifier to enable for the session.
CompletableFuture<Void>	SessionMcpApi.enable(SessionMcpEnableParams params)	Name of the MCP server to enable for the session.
CompletableFuture<Void>	SessionMcpApi.enable(SessionMcpEnableRequest request)	Name of the MCP server to enable for the session.
CompletableFuture<Void>	SessionPluginsApi.enable(SessionPluginsEnableParams params)	Plugin names (or specs) to enable in the session's authoritative working directory.
CompletableFuture<SessionRemoteEnableResult>	SessionRemoteApi.enable(SessionRemoteEnableParams params)	Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.
CompletableFuture<Void>	SessionSkillsApi.enable(SessionSkillsEnableParams params)	Name of the skill to enable for the session.
CompletableFuture<EnqueueCommandResult>	SessionCommandsApi.enqueue(SessionCommandsEnqueueParams params)	Slash-prefixed command string to enqueue for FIFO processing.
CompletableFuture<SessionQueueEnqueueResumePendingResult>	SessionQueueApi.enqueueResumePending()	Identifies the target session.
CompletableFuture<SessionsEnrichMetadataResult>	ServerSessionsApi.enrichMetadata(SessionsEnrichMetadataParams params)	Session metadata records to enrich with summary and context information.
CompletableFuture<SessionWorkspacesEnsureResult>	SessionWorkspacesApi.ensure(SessionWorkspacesEnsureParams params)	Optional session context used when creating a local workspace.
CompletableFuture<Void>	SessionSkillsApi.ensureLoaded()	Identifies the target session.
CompletableFuture<AuthEnumerateValue>	SessionAccountsApi.enumerate(SessionAccountsEnumerateParams params)	Enumerate request carrying the typed collection query.
CompletableFuture<SessionUiEphemeralQueryResult>	SessionUiApi.ephemeralQuery(SessionUiEphemeralQueryParams params)	Transient question to answer without adding it to conversation history.
CompletableFuture<SessionSettingsEvaluatePredicateResult>	SessionSettingsApi.evaluatePredicate(SessionSettingsEvaluatePredicateParams params)	Named Rust-owned settings predicate to evaluate for this session.
CompletableFuture<SessionShellExecResult>	SessionShellApi.exec(SessionShellExecParams params)	Shell command to run, with optional working directory and timeout in milliseconds.
CompletableFuture<SessionCommandsExecuteResult>	SessionCommandsApi.execute(SessionCommandsExecuteParams params)	Slash command name and argument string to execute synchronously.
CompletableFuture<Void>	SessionToolsApi.execute(SessionToolsExecuteParams params)	A tool name and arguments to execute through the session's native invocation pipeline.
CompletableFuture<SessionMcpExecuteSamplingResult>	SessionMcpApi.executeSampling(SessionMcpExecuteSamplingParams params)	Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.
CompletableFuture<SessionShellExecuteUserRequestedResult>	SessionShellApi.executeUserRequested(SessionShellExecuteUserRequestedParams params)	User-requested shell command and cancellation handle.
CompletableFuture<SessionCommandsFinalizeInvocationEffectResult>	SessionCommandsApi.finalizeInvocationEffect(SessionCommandsFinalizeInvocationEffectParams params)	The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it.
CompletableFuture<SessionsFindByPrefixResult>	ServerSessionsApi.findByPrefix(SessionsFindByPrefixParams params)	UUID prefix to resolve to a unique session ID.
CompletableFuture<SessionsFindByTaskIdResult>	ServerSessionsApi.findByTaskId(SessionsFindByTaskIdParams params)	GitHub task ID to look up.
CompletableFuture<SessionQueueFinishDeferredIdleDrainResult>	SessionQueueApi.finishDeferredIdleDrain(SessionQueueFinishDeferredIdleDrainParams params)	Inputs for completing a deferred-idle drain.
CompletableFuture<SessionsForkResult>	ServerSessionsApi.fork(SessionsForkParams params)	Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.
CompletableFuture<UserSettingsGetResult>	ServerUserSettingsApi.get()	Per-key metadata for every known user setting (settings.json overlaid with the legacy config.json, config.json wins), including settings left at their default.
CompletableFuture<AuthReadValue>	SessionAccountsApi.get(SessionAccountsGetParams params)	Read request carrying the typed datum query.
CompletableFuture<SessionManagedSettingsGetResult>	SessionManagedSettingsApi.get()	Identifies the target session.
CompletableFuture<SessionMode>	SessionModeApi.get()	Identifies the target session.
CompletableFuture<SessionNameGetResult>	SessionNameApi.get()	Identifies the target session.
CompletableFuture<SessionVisibilityGetResult>	SessionVisibilityApi.get()	Identifies the target session.
CompletableFuture<SessionWorkflowJournalGetResult>	SessionWorkflowJournalApi.get(SessionWorkflowJournalGetParams params)	Parameters for reading a workflow journal entry.
CompletableFuture<List<SessionAuthStatus>>	SessionGitHubAuthApi.getAllAuthAvailable()	Identifies the target session.
CompletableFuture<List<AccountAllUsers>>	ServerAccountApi.getAllUsers()	List of all authenticated users
CompletableFuture<SessionsGetBoardEntryCountResult>	ServerSessionsApi.getBoardEntryCount(SessionsGetBoardEntryCountParams params)	Session ID whose board entry count should be returned.
CompletableFuture<ModelsGetBuiltInCatalogResult>	ServerModelsApi.getBuiltInCatalog()	The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata.
CompletableFuture<SessionToolsGetBuiltinDescriptorsResult>	SessionToolsApi.getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params)	Options controlling how Rust-owned built-in tool descriptors are materialized.
CompletableFuture<SessionConnectorsGetCapabilitiesResult>	SessionConnectorsApi.getCapabilities()	Identifies the target session.
CompletableFuture<List<Object>>	ServerSessionsApi.getClientMetadata(SessionsGetClientMetadataParams params)	Bounded batch request for client-owned metadata from persisted local sessions.
CompletableFuture<ClientMetadata>	SessionMetadataApi.getClientMetadata()	Identifies the target session.
CompletableFuture<SessionMetadataGetContextAttributionResult>	SessionMetadataApi.getContextAttribution()	Identifies the target session.
CompletableFuture<SessionMetadataGetContextHeaviestMessagesResult>	SessionMetadataApi.getContextHeaviestMessages(SessionMetadataGetContextHeaviestMessagesParams params)	Parameters for the heaviest-messages query.
CompletableFuture<SessionAgentGetCurrentResult>	SessionAgentApi.getCurrent()	Identifies the target session.
CompletableFuture<SessionModelGetCurrentResult>	SessionModelApi.getCurrent()	Identifies the target session.
CompletableFuture<AccountGetCurrentAuthResult>	ServerAccountApi.getCurrentAuth()	Current authentication state
CompletableFuture<Void>	SessionGitHubAuthApi.getCurrentAuthInfo()	Identifies the target session.
CompletableFuture<SessionToolsGetCurrentMetadataResult>	SessionToolsApi.getCurrentMetadata()	Identifies the target session.
CompletableFuture<SessionTasksGetCurrentPromotableResult>	SessionTasksApi.getCurrentPromotable()	Identifies the target session.
CompletableFuture<AgentsGetDiscoveryPathsResult>	ServerAgentsApi.getDiscoveryPaths(AgentsGetDiscoveryPathsParams params)	Optional project paths to include when enumerating agent discovery directories.
CompletableFuture<InstructionsGetDiscoveryPathsResult>	ServerInstructionsApi.getDiscoveryPaths(InstructionsGetDiscoveryPathsParams params)	Optional project paths to include when enumerating instruction discovery targets.
CompletableFuture<SkillsGetDiscoveryPathsResult>	ServerSkillsApi.getDiscoveryPaths(SkillsGetDiscoveryPathsParams params)	Optional project paths to enumerate.
CompletableFuture<SessionProviderGetEndpointResult>	SessionProviderApi.getEndpoint()	Optional model identifier to scope the endpoint snapshot to.
CompletableFuture<SessionProviderGetEndpointResult>	SessionProviderApi.getEndpoint(SessionProviderGetEndpointParams params)	Optional model identifier to scope the endpoint snapshot to.
CompletableFuture<SessionSandboxGetEnforcementStatusResult>	SessionSandboxApi.getEnforcementStatus()	Identifies the target session.
CompletableFuture<SessionTelemetryGetEngagementIdResult>	SessionTelemetryApi.getEngagementId()	Identifies the target session.
CompletableFuture<SessionsGetEventFilePathResult>	ServerSessionsApi.getEventFilePath(SessionsGetEventFilePathParams params)	Session ID whose event-log file path to compute.
CompletableFuture<SessionMcpAppsGetHostContextResult>	SessionMcpAppsApi.getHostContext()	Identifies the target session.
CompletableFuture<SandboxGetHostSupportResult>	ServerSandboxApi.getHostSupport()	Whether the host running this runtime can run the command sandbox.
CompletableFuture<SessionSkillsGetInvokedResult>	SessionSkillsApi.getInvoked()	Identifies the target session.
CompletableFuture<SessionsGetLastForContextResult>	ServerSessionsApi.getLastForContext(SessionsGetLastForContextParams params)	Optional working-directory context used to score session relevance.
CompletableFuture<SessionsGetMetadataResult>	ServerSessionsApi.getMetadata(SessionsGetMetadataParams params)	Session ID whose persisted metadata should be read.
CompletableFuture<SessionUsageGetMetricsResult>	SessionUsageApi.getMetrics()	Identifies the target session.
CompletableFuture<SessionPermissionsGetModeResult>	SessionPermissionsApi.getMode()	No parameters.
CompletableFuture<SessionsGetPersistedRemoteSteerableResult>	ServerSessionsApi.getPersistedRemoteSteerable(SessionsGetPersistedRemoteSteerableParams params)	Session ID to look up the persisted remote-steerable flag for.
CompletableFuture<SessionTasksGetProgressResult>	SessionTasksApi.getProgress(SessionTasksGetProgressParams params)	Identifier of the background task to fetch progress for.
CompletableFuture<AccountGetQuotaResult>	ServerAccountApi.getQuota()	Optional opaque account selection or compatibility GitHub token used to look up quota.
CompletableFuture<AccountGetQuotaResult>	ServerAccountApi.getQuota(AccountGetQuotaParams params)	Optional opaque account selection or compatibility GitHub token used to look up quota.
CompletableFuture<SessionsGetRemoteControlStatusResult>	ServerSessionsApi.getRemoteControlStatus()	Wrapper for the singleton's current status.
CompletableFuture<SessionWorkflowGetRunResult>	SessionWorkflowApi.getRun(SessionWorkflowGetRunParams params)	Parameters for retrieving a workflow run.
CompletableFuture<SessionWorkflowGetRunDetailResult>	SessionWorkflowApi.getRunDetail(SessionWorkflowGetRunDetailParams params)	Parameters for retrieving a workflow run.
CompletableFuture<SessionWorkflowGetRunProgressResult>	SessionWorkflowApi.getRunProgress(SessionWorkflowGetRunProgressParams params)	Parameters for paging workflow progress.
CompletableFuture<SessionsGetSizesResult>	ServerSessionsApi.getSizes()	Map of sessionId -> on-disk size in bytes for each session's workspace directory.
CompletableFuture<SessionInstructionsGetSourcesResult>	SessionInstructionsApi.getSources()	Identifies the target session.
CompletableFuture<SessionAutopilotObjectiveGetStateResult>	SessionAutopilotObjectiveApi.getState()	Identifies the target session.
CompletableFuture<SessionConnectorsGetStatusResult>	SessionConnectorsApi.getStatus()	Identifies the target session.
CompletableFuture<SessionGitHubAuthGetStatusResult>	SessionGitHubAuthApi.getStatus()	Identifies the target session.
CompletableFuture<SessionCompletionsGetTriggerCharactersResult>	SessionCompletionsApi.getTriggerCharacters()	Identifies the target session.
CompletableFuture<SessionWorkspacesGetWorkspaceResult>	SessionWorkspacesApi.getWorkspace()	Identifies the target session.
CompletableFuture<SessionUiHandlePendingAutoModeSwitchResult>	SessionUiApi.handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params)	Request ID of a pending `auto_mode_switch.requested` event and the user's response.
CompletableFuture<SessionCommandsHandlePendingCommandResult>	SessionCommandsApi.handlePendingCommand(SessionCommandsHandlePendingCommandParams params)	Pending command request ID and an optional error if the client handler failed.
CompletableFuture<SessionUiHandlePendingElicitationResult>	SessionUiApi.handlePendingElicitation(SessionUiHandlePendingElicitationParams params)	Pending elicitation request ID and the user's response (accept/decline/cancel + form values).
CompletableFuture<SessionUiHandlePendingExitPlanModeResult>	SessionUiApi.handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params)	Request ID of a pending `exit_plan_mode.requested` event and the user's response.
CompletableFuture<SessionMcpHeadersHandlePendingHeadersRefreshRequestResult>	SessionMcpHeadersApi.handlePendingHeadersRefreshRequest(SessionMcpHeadersHandlePendingHeadersRefreshRequestParams params)	MCP headers refresh request id and the host response.
CompletableFuture<SessionPermissionsHandlePendingPermissionRequestResult>	SessionPermissionsApi.handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params)	Pending permission request ID and the decision to apply (approve/reject and scope).
CompletableFuture<SessionMcpOauthHandlePendingRequestResult>	SessionMcpOauthApi.handlePendingRequest(SessionMcpOauthHandlePendingRequestParams params)	Pending MCP OAuth request ID and host-provided token or cancellation response.
CompletableFuture<SessionUiHandlePendingSamplingResult>	SessionUiApi.handlePendingSampling(SessionUiHandlePendingSamplingParams params)	Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).
CompletableFuture<SessionUiHandlePendingSessionLimitsExhaustedResult>	SessionUiApi.handlePendingSessionLimitsExhausted(SessionUiHandlePendingSessionLimitsExhaustedParams params)	Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action.
CompletableFuture<SessionToolsHandlePendingToolCallResult>	SessionToolsApi.handlePendingToolCall(SessionToolsHandlePendingToolCallParams params)	Pending external tool call request ID, with the tool result or an error describing why it failed.
CompletableFuture<SessionUiHandlePendingUserInputResult>	SessionUiApi.handlePendingUserInput(SessionUiHandlePendingUserInputParams params)	Request ID of a pending `user_input.requested` event and the user's response.
CompletableFuture<SessionQueueHasPendingResult>	SessionQueueApi.hasPending()	Identifies the target session.
CompletableFuture<SessionScheduleHasSelfPacedResult>	SessionScheduleApi.hasSelfPaced()	Identifies the target session.
CompletableFuture<LlmInferenceHttpResponseChunkResult>	ServerLlmInferenceApi.httpResponseChunk(LlmInferenceHttpResponseChunkParams params)	A response body chunk or terminal error.
CompletableFuture<LlmInferenceHttpResponseStartResult>	ServerLlmInferenceApi.httpResponseStart(LlmInferenceHttpResponseStartParams params)	Response head.
CompletableFuture<Void>	SessionScheduleApi.hydrate()	Identifies the target session.
CompletableFuture<Void>	SessionLspApi.initialize(SessionLspInitializeParams params)	Parameters for (re)loading the merged LSP configuration set.
CompletableFuture<Void>	SessionToolsApi.initializeAndValidate()	Identifies the target session.
CompletableFuture<SessionQueueInsertAtResult>	SessionQueueApi.insertAt(SessionQueueInsertAtParams params)	Parameters for inserting a queued message at a public visible position.
CompletableFuture<PluginsInstallResult>	ServerPluginsApi.install(PluginsInstallParams params)	Plugin source and optional working directory for relative-path resolution.
CompletableFuture<SessionPluginsInstallResult>	SessionPluginsApi.install(SessionPluginsInstallParams params)	Plugin source resolved relative to the session's authoritative working directory.
CompletableFuture<SessionInterruptMainTurnResult>	SessionRpc.interruptMainTurn(SessionInterruptMainTurnParams params)	Parameters for interrupting the main agent turn.
CompletableFuture<SessionCanvasActionInvokeResult>	SessionCanvasActionApi.invoke(SessionCanvasActionInvokeParams params)	Canvas action invocation parameters.
CompletableFuture<SlashCommandInvocationResult>	SessionCommandsApi.invoke(SessionCommandsInvokeParams params)	Slash command name and optional raw input string to invoke.
CompletableFuture<SessionPermissionsPathsIsPathWithinAllowedDirectoriesResult>	SessionPermissionsPathsApi.isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params)	Path to evaluate against the session's allowed directories.
CompletableFuture<SessionPermissionsPathsIsPathWithinWorkspaceResult>	SessionPermissionsPathsApi.isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params)	Path to evaluate against the session's workspace (primary) directory.
CompletableFuture<SessionMetadataIsProcessingResult>	SessionMetadataApi.isProcessing()	Identifies the target session.
CompletableFuture<SessionMcpIsServerRunningResult>	SessionMcpApi.isServerRunning(SessionMcpIsServerRunningParams params)	Server name to check running status for.
CompletableFuture<SessionPermissionsFolderTrustIsTrustedResult>	SessionPermissionsFolderTrustApi.isTrusted(SessionPermissionsFolderTrustIsTrustedParams params)	Folder path to check for trust.
CompletableFuture<SessionShellKillResult>	SessionShellApi.kill(SessionShellKillParams params)	Identifier of a process previously returned by "shell.exec" and the signal to send.
CompletableFuture<List<AuthValidationError>>	SessionGitHubAuthApi.lastAuthErrors()	Identifies the target session.
CompletableFuture<CommandsListResult>	ServerCommandsApi.list()	Slash commands available in the session, after applying any include/exclude filters.
CompletableFuture<McpConfigListResult>	ServerMcpConfigApi.list()	User-configured MCP servers, keyed by server name.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.list(McpInstallationsListParams params)	New-work inventory or recovery request under an explicitly selected existing session.
CompletableFuture<ModelsListResult>	ServerModelsApi.list()	Optional opaque account selection or compatibility GitHub token used to list models.
CompletableFuture<ModelsListResult>	ServerModelsApi.list(ModelsListParams params)	Optional opaque account selection or compatibility GitHub token used to list models.
CompletableFuture<PluginsListResult>	ServerPluginsApi.list()	Plugins installed in user/global state.
CompletableFuture<PluginsMarketplacesListResult>	ServerPluginsMarketplacesApi.list()	All registered marketplaces, including built-in defaults.
CompletableFuture<SessionsListResult>	ServerSessionsApi.list()	Optional source filter, metadata-load limit, and context filter applied to the returned sessions.
CompletableFuture<SessionsListResult>	ServerSessionsApi.list(SessionsListParams params)	Optional source filter, metadata-load limit, and context filter applied to the returned sessions.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.list(SkillsInstallationsListParams params)	Inventory request under an explicitly selected existing session.
CompletableFuture<ToolsListResult>	ServerToolsApi.list(ToolsListParams params)	Optional model identifier whose tool overrides should be applied to the listing.
CompletableFuture<SessionAgentListResult>	SessionAgentApi.list()	Controls whether built-in agents and authored prompt text are included.
CompletableFuture<SessionAgentListResult>	SessionAgentApi.list(SessionAgentListParams params)	Controls whether built-in agents and authored prompt text are included.
CompletableFuture<SessionCanvasListResult>	SessionCanvasApi.list()	Identifies the target session.
CompletableFuture<SessionCommandsListResult>	SessionCommandsApi.list()	Optional filters controlling which command sources to include in the listing.
CompletableFuture<SessionCommandsListResult>	SessionCommandsApi.list(SessionCommandsListParams params)	Optional filters controlling which command sources to include in the listing.
CompletableFuture<SessionConnectorsListResult>	SessionConnectorsApi.list(SessionConnectorsListParams params)	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
CompletableFuture<SessionExtensionsListResult>	SessionExtensionsApi.list()	Identifies the target session.
CompletableFuture<SessionMcpListResult>	SessionMcpApi.list()	Identifies the target session.
CompletableFuture<SessionMcpResourcesListResult>	SessionMcpResourcesApi.list(SessionMcpResourcesListParams params)	MCP server whose resources to enumerate.
CompletableFuture<SessionModelListResult>	SessionModelApi.list()	Optional listing options.
CompletableFuture<SessionModelListResult>	SessionModelApi.list(SessionModelListParams params)	Optional listing options.
CompletableFuture<SessionPermissionsPathsListResult>	SessionPermissionsPathsApi.list()	No parameters; returns the session's recursive directory grants and exact session-approved paths.
CompletableFuture<SessionPluginsListResult>	SessionPluginsApi.list()	Identifies the target session.
CompletableFuture<SessionPluginsMarketplacesListResult>	SessionPluginsMarketplacesApi.list()	Identifies the target session.
CompletableFuture<SessionScheduleListResult>	SessionScheduleApi.list()	Identifies the target session.
CompletableFuture<SessionSkillsListResult>	SessionSkillsApi.list()	Identifies the target session.
CompletableFuture<SessionTasksListResult>	SessionTasksApi.list()	Identifies the target session.
CompletableFuture<SessionWorkspacesListCheckpointsResult>	SessionWorkspacesApi.listCheckpoints()	Identifies the target session.
CompletableFuture<SessionWorkspacesListFilesResult>	SessionWorkspacesApi.listFiles()	Identifies the target session.
CompletableFuture<SessionsListNonEmptySessionIdsResult>	ServerSessionsApi.listNonEmptySessionIds(SessionsListNonEmptySessionIdsParams params)	Limit for non-empty local session IDs.
CompletableFuture<SessionCanvasListOpenResult>	SessionCanvasApi.listOpen()	Identifies the target session.
CompletableFuture<SessionHistoryListRewindPointsResult>	SessionHistoryApi.listRewindPoints()	Identifies the target session.
CompletableFuture<SessionWorkflowListRunsResult>	SessionWorkflowApi.listRuns(SessionWorkflowListRunsParams params)	Parameters for paging workflow runs.
CompletableFuture<SessionMcpResourcesListTemplatesResult>	SessionMcpResourcesApi.listTemplates(SessionMcpResourcesListTemplatesParams params)	MCP server whose resource templates to enumerate.
CompletableFuture<SessionMcpListToolsResult>	SessionMcpApi.listTools(SessionMcpListToolsParams params)	Server name whose tool list should be returned.
CompletableFuture<SessionMcpAppsListToolsResult>	SessionMcpAppsApi.listTools(SessionMcpAppsListToolsParams params)	MCP server to list app-callable tools for.
CompletableFuture<SessionsLoadDeferredRepoHooksResult>	ServerSessionsApi.loadDeferredRepoHooks(SessionsLoadDeferredRepoHooksParams params)	Active session ID whose deferred repo-level hooks should be loaded.
CompletableFuture<SessionLogResult>	SessionRpc.log(SessionLogParams params)	Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.
CompletableFuture<Void>	SessionWorkflowApi.log(SessionWorkflowLogParams params)	Parameters for recording workflow progress.
CompletableFuture<AccountLoginResult>	ServerAccountApi.login(AccountLoginParams params)	Credentials to validate and store.
CompletableFuture<AuthInfo>	SessionGitHubAuthApi.login(SessionGitHubAuthLoginParams params)	Internal GitHub login parameters.
CompletableFuture<SessionMcpOauthLoginResult>	SessionMcpOauthApi.login(SessionMcpOauthLoginParams params)	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.
CompletableFuture<SessionMcpOauthLoginResult>	SessionMcpOauthApi.login(SessionMcpOauthLoginRequest request)	Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.
CompletableFuture<AccountLogoutResult>	ServerAccountApi.logout(AccountLogoutParams params)	User to log out
CompletableFuture<Void>	SessionGitHubAuthApi.logout()	Identifies the target session.
CompletableFuture<Void>	SessionGitHubAuthApi.logoutUser(SessionGitHubAuthLogoutUserParams params)	Parameters identifying a GitHub authentication to log out.
CompletableFuture<SessionPermissionsModifyRulesResult>	SessionPermissionsApi.modifyRules(SessionPermissionsModifyRulesParams params)	Scope and add/remove instructions for modifying session- or location-scoped permission rules.
CompletableFuture<SessionQueueMoveItemResult>	SessionQueueApi.moveItem(SessionQueueMoveItemParams params)	Parameters for moving a queued item by stable id.
CompletableFuture<SessionMcpMoveLoadingToBackgroundResult>	SessionMcpApi.moveLoadingToBackground()	Identifies the target session.
CompletableFuture<SessionPermissionsNotifyPromptShownResult>	SessionPermissionsApi.notifyPromptShown(SessionPermissionsNotifyPromptShownParams params)	Notification payload describing the permission prompt that the client just rendered.
CompletableFuture<Void>	SessionRemoteApi.notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params)	New remote-steerability state to persist as a `session.remote_steerable_changed` event.
CompletableFuture<SessionsOpenResult>	ServerSessionsApi.open(SessionsOpenParams params)	Open a session by creating, resuming, attaching, connecting to a remote, or handing off.
CompletableFuture<SessionCanvasOpenResult>	SessionCanvasApi.open(SessionCanvasOpenParams params)	Canvas open parameters.
CompletableFuture<SessionWorkflowPauseResult>	SessionWorkflowApi.pause(SessionWorkflowPauseParams params)	Parameters for pausing a running workflow.
CompletableFuture<SessionWorkflowPauseAtCheckpointResult>	SessionWorkflowApi.pauseAtCheckpoint(SessionWorkflowPauseAtCheckpointParams params)	Parameters for an owned durable pause checkpoint.
CompletableFuture<SessionQueuePendingItemsResult>	SessionQueueApi.pendingItems()	Identifies the target session.
CompletableFuture<SessionPermissionsPendingRequestsResult>	SessionPermissionsApi.pendingRequests()	No parameters; returns currently-pending permission requests for the session.
CompletableFuture<PingResult>	ServerRpc.ping(PingParams params)	Optional message to echo back to the caller.
CompletableFuture<McpPlanInstallResult>	ServerMcpApi.planInstall(McpPlanInstallParams params)	A side-effect-free request for an MCP install plan.
CompletableFuture<McpPlanInstallResult>	ServerMcpApi.planInstall(McpPlanInstallRequest request)	A side-effect-free request for an MCP install plan.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsApi.planInstall(SkillsPlanInstallParams params)	Side-effect-free planning of one verified Agent Finder Skill candidate.
CompletableFuture<McpInstallationManagementResult>	ServerMcpApi.planUninstall(McpPlanUninstallParams params)	Read-only preparation of one owned removal under fresh selected-session authority.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsApi.planUninstall(SkillsPlanUninstallParams params)	Read-only preparation of one owned Skill removal under fresh selected-session authority.
CompletableFuture<SessionLimitPredictionResult>	SessionLimitPredictionApi.predict()	Parameters for predicting an AI-credit session limit.
CompletableFuture<SessionLimitPredictionResult>	SessionLimitPredictionApi.predict(SessionLimitPredictionPredictParams params)	Parameters for predicting an AI-credit session limit.
CompletableFuture<McpInstallationManagementResult>	ServerMcpApi.prepareInstall(McpPrepareInstallParams params)	Side-effect-free preparation of one original bound remote MCP choice.
CompletableFuture<SessionMcpOauthPrepareLoginResult>	SessionMcpOauthApi.prepareLogin(SessionMcpOauthPrepareLoginParams params)	Effect-free preparation bound to the existing local session, requester and installation, with frozen options.
CompletableFuture<SessionHistoryPreviewRewindResult>	SessionHistoryApi.previewRewind(SessionHistoryPreviewRewindParams params)	Event boundary to preview for conversation-and-files rewind.
CompletableFuture<McpOauthProbeResult>	SessionMcpOauthApi.probe(SessionMcpOauthProbeParams params)	Remote MCP server name for a passive OAuth status probe.
CompletableFuture<McpOauthProbeResult>	SessionMcpOauthApi.probe(SessionMcpOauthProbeRequest request)	Remote MCP server name for a passive OAuth status probe.
CompletableFuture<Void>	SessionQueueApi.process()	Identifies the target session.
CompletableFuture<SessionTasksPromoteCurrentToBackgroundResult>	SessionTasksApi.promoteCurrentToBackground()	Identifies the target session.
CompletableFuture<SessionTasksPromoteToBackgroundResult>	SessionTasksApi.promoteToBackground(SessionTasksPromoteToBackgroundParams params)	Identifier of the task to promote to background mode.
CompletableFuture<SessionsPruneOldResult>	ServerSessionsApi.pruneOld(SessionsPruneOldParams params)	Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).
CompletableFuture<Void>	SessionWorkflowJournalApi.put(SessionWorkflowJournalPutParams params)	Parameters for storing a workflow journal entry.
CompletableFuture<ManagedSettingsReadResult>	ServerManagedSettingsApi.read()	Validated device-managed settings discovered before a session exists.
CompletableFuture<SessionDiagnosticsReadResult>	SessionDiagnosticsApi.read(SessionDiagnosticsReadParams params)	Cursor-based request for session diagnostics.
CompletableFuture<SessionEventLogReadResult>	SessionEventLogApi.read(SessionEventLogReadParams params)	Cursor, batch size, and optional long-poll/filter parameters for reading session events.
CompletableFuture<SessionMcpResourcesReadResult>	SessionMcpResourcesApi.read(SessionMcpResourcesReadParams params)	MCP server and resource URI to fetch.
CompletableFuture<SessionPlanReadResult>	SessionPlanApi.read()	Identifies the target session.
CompletableFuture<SessionWorkspacesReadAutopilotObjectiveResult>	SessionWorkspacesApi.readAutopilotObjective()	Identifies the target session.
CompletableFuture<SessionWorkspacesReadCheckpointResult>	SessionWorkspacesApi.readCheckpoint(SessionWorkspacesReadCheckpointParams params)	Checkpoint number to read.
CompletableFuture<SessionWorkspacesReadFileResult>	SessionWorkspacesApi.readFile(SessionWorkspacesReadFileParams params)	Relative path of the workspace file to read.
CompletableFuture<SessionsReadPersistedEventsResult>	ServerSessionsApi.readPersistedEvents(SessionsReadPersistedEventsParams params)	Pagination options for reading an inactive or active local session's persisted event journal.
CompletableFuture<SessionMcpAppsReadResourceResult>	SessionMcpAppsApi.readResource(SessionMcpAppsReadResourceParams params)	MCP server and resource URI to fetch.
CompletableFuture<SessionPlanReadSqlTodosResult>	SessionPlanApi.readSqlTodos()	Identifies the target session.
CompletableFuture<SessionPlanReadSqlTodosWithDependenciesResult>	SessionPlanApi.readSqlTodosWithDependencies()	Identifies the target session.
CompletableFuture<SessionScheduleRearmSelfPacedResult>	SessionScheduleApi.rearmSelfPaced(SessionScheduleRearmSelfPacedParams params)	Re-arm a self-paced scheduled prompt.
CompletableFuture<SessionMetadataRecomputeContextTokensResult>	SessionMetadataApi.recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params)	Model identifier to use when re-tokenizing the session's existing messages.
CompletableFuture<SessionConnectorsReconcileResult>	SessionConnectorsApi.reconcile(SessionConnectorsReconcileParams params)	Requests authoritative Connector-to-MCP reconciliation for the pinned account.
CompletableFuture<SessionConnectorsReconcileForStartupResult>	SessionConnectorsApi.reconcileForStartup(SessionConnectorsReconcileForStartupParams params)	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
CompletableFuture<ConnectorConnectResult>	SessionConnectorsApi.reconnect(SessionConnectorsReconnectParams params)	Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
CompletableFuture<Void>	SessionMetadataApi.recordContextChange(SessionMetadataRecordContextChangeParams params)	Updated working-directory/git context to record on the session.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.recover(McpInstallationsRecoverParams params)	New-work inventory or recovery request under an explicitly selected existing session.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.recover(SkillsInstallationsRecoverParams params)	Inventory request under an explicitly selected existing session.
CompletableFuture<PluginsMarketplacesRefreshResult>	ServerPluginsMarketplacesApi.refresh()	Optional marketplace name; omit to refresh all.
CompletableFuture<PluginsMarketplacesRefreshResult>	ServerPluginsMarketplacesApi.refresh(PluginsMarketplacesRefreshParams params)	Optional marketplace name; omit to refresh all.
CompletableFuture<SessionConnectorsRefreshResult>	SessionConnectorsApi.refresh(SessionConnectorsRefreshParams params)	Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.
CompletableFuture<SessionPluginsMarketplacesRefreshResult>	SessionPluginsMarketplacesApi.refresh()	Optional marketplace name; omit to refresh all.
CompletableFuture<SessionPluginsMarketplacesRefreshResult>	SessionPluginsMarketplacesApi.refresh(SessionPluginsMarketplacesRefreshParams params)	Optional marketplace name; omit to refresh all.
CompletableFuture<Void>	SessionTasksApi.refresh()	Identifies the target session.
CompletableFuture<Void>	SessionGitHubAuthApi.refreshCopilotUser()	Identifies the target session.
CompletableFuture<Void>	SessionCanvasProviderApi.register(SessionCanvasProviderRegisterParams params)	Internal canvas provider registration parameters.
CompletableFuture<SessionTasksRegisterResult>	SessionTasksApi.register(SessionTasksRegisterParams params)	Registers or reclaims a client-owned task.
CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult>	SessionUiApi.registerDirectAutoModeSwitchHandler()	Identifies the target session.
CompletableFuture<Void>	ServerRpc.registerExtensionLaunchProvider()	Invokes registerExtensionLaunchProvider.
CompletableFuture<Void>	SessionMcpApi.registerExternalClient(SessionMcpRegisterExternalClientParams params)	Registration parameters for an external MCP client.
CompletableFuture<SessionEventLogRegisterInterestResult>	SessionEventLogApi.registerInterest(SessionEventLogRegisterInterestParams params)	Event type to register consumer interest for, used by runtime gating logic.
CompletableFuture<SessionEventLogReleaseInterestResult>	SessionEventLogApi.releaseInterest(SessionEventLogReleaseInterestParams params)	Opaque handle previously returned by `registerInterest` to release.
CompletableFuture<Void>	ServerSessionsApi.releaseLock(SessionsReleaseLockParams params)	Session ID whose in-use lock should be released.
CompletableFuture<Void>	ServerMcpConfigApi.reload()	Invokes mcp.config.reload.
CompletableFuture<Void>	ServerUserSettingsApi.reload()	Invokes user.settings.reload.
CompletableFuture<SessionAgentReloadResult>	SessionAgentApi.reload()	Identifies the target session.
CompletableFuture<SessionCustomizationsReloadResult>	SessionCustomizationsApi.reload()	Identifies the target session.
CompletableFuture<Void>	SessionExtensionsApi.reload()	Identifies the target session.
CompletableFuture<Void>	SessionInstructionsApi.reload()	Identifies the target session.
CompletableFuture<Void>	SessionMcpApi.reload()	Identifies the target session.
CompletableFuture<Void>	SessionPluginsApi.reload()	Optional flags controlling which side effects the reload performs.
CompletableFuture<Void>	SessionPluginsApi.reload(SessionPluginsReloadParams params)	Optional flags controlling which side effects the reload performs.
CompletableFuture<SessionSkillsReloadResult>	SessionSkillsApi.reload()	Identifies the target session.
CompletableFuture<Void>	ServerSessionsApi.reloadPluginHooks(SessionsReloadPluginHooksParams params)	Active session ID and an optional flag for deferring repo-level hooks until folder trust.
CompletableFuture<SessionMcpReloadWithConfigResult>	SessionMcpApi.reloadWithConfig(SessionMcpReloadWithConfigParams params)	Opaque MCP reload configuration.
CompletableFuture<Void>	ServerMcpConfigApi.remove(McpConfigRemoveParams params)	MCP server name to remove from user configuration.
CompletableFuture<PluginsMarketplacesRemoveResult>	ServerPluginsMarketplacesApi.remove(PluginsMarketplacesRemoveParams params)	Name of the marketplace to remove and an optional force flag.
CompletableFuture<SessionPluginsMarketplacesRemoveResult>	SessionPluginsMarketplacesApi.remove(SessionPluginsMarketplacesRemoveParams params)	Name of the marketplace to remove and an optional force flag.
CompletableFuture<SessionTasksRemoveResult>	SessionTasksApi.remove(SessionTasksRemoveParams params)	Identifier of the completed or cancelled task to remove from tracking.
CompletableFuture<SessionQueueRemoveAtResult>	SessionQueueApi.removeAt(SessionQueueRemoveAtParams params)	Parameters for removing a queued item by stable id.
CompletableFuture<SessionMcpRemoveGitHubResult>	SessionMcpApi.removeGitHub()	Identifies the target session.
CompletableFuture<SessionQueueRemoveMostRecentResult>	SessionQueueApi.removeMostRecent()	Identifies the target session.
CompletableFuture<Void>	SessionWorkspacesApi.removePath(SessionWorkspacesRemovePathParams params)	File or directory to remove from the session workspace files directory.
CompletableFuture<Void>	SessionWorkspacesApi.renamePath(SessionWorkspacesRenamePathParams params)	Source and destination paths for a rename within the session workspace files directory.
CompletableFuture<SessionCompletionsRequestResult>	SessionCompletionsApi.request(SessionCompletionsRequestParams params)	Request host-driven completions for the current composer input.
CompletableFuture<SessionPermissionsResetSessionApprovalsResult>	SessionPermissionsApi.resetSessionApprovals(SessionPermissionsResetSessionApprovalsParams params)	Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
CompletableFuture<SessionPermissionsLocationsResolveResult>	SessionPermissionsLocationsApi.resolve(SessionPermissionsLocationsResolveParams params)	Working directory to resolve into a location-permissions key.
CompletableFuture<SessionMcpOauthRespondResult>	SessionMcpOauthApi.respond(SessionMcpOauthRespondParams params)	Pending MCP OAuth request id to respond to.
CompletableFuture<SessionCommandsRespondToQueuedCommandResult>	SessionCommandsApi.respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params)	Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).
CompletableFuture<Void>	SessionMcpApi.restartServer(SessionMcpRestartServerParams params)	Server name and optional replacement configuration for an individual MCP server restart.
CompletableFuture<Void>	SessionMcpApi.restartServer(SessionMcpRestartServerRequest request)	Server name and optional replacement configuration for an individual MCP server restart.
CompletableFuture<SessionWorkflowResumeResult>	SessionWorkflowApi.resume(SessionWorkflowResumeParams params)	Parameters for resuming a workflow run from its persisted identity.
CompletableFuture<SessionWorkflowResumeFromToolResult>	SessionWorkflowApi.resumeFromTool(SessionWorkflowResumeFromToolParams params)	Internal parameters for resuming a workflow run from a tool.
CompletableFuture<SessionHistoryRewindResult>	SessionHistoryApi.rewind(SessionHistoryRewindParams params)	Boundary and mode for rewinding session history.
CompletableFuture<SessionWorkflowRunResult>	SessionWorkflowApi.run(SessionWorkflowRunParams params)	Parameters for invoking a registered workflow.
CompletableFuture<SessionWorkflowRunFromToolResult>	SessionWorkflowApi.runFromTool(SessionWorkflowRunFromToolParams params)	Internal parameters for invoking a registered workflow from a tool.
CompletableFuture<Void>	ServerSessionsApi.save(SessionsSaveParams params)	Session ID whose pending events should be flushed to disk.
CompletableFuture<SessionWorkspacesSaveLargePasteResult>	SessionWorkspacesApi.saveLargePaste(SessionWorkspacesSaveLargePasteParams params)	Pasted content to save as a UTF-8 file in the session workspace.
CompletableFuture<CatalogSearchResult>	ServerCatalogApi.search(CatalogSearchParams params)	A bounded catalog search.
CompletableFuture<CatalogSearchResult>	ServerCatalogApi.search(CatalogSearchRequest request)	A bounded catalog search.
CompletableFuture<CatalogSelectionResult>	ServerCatalogApi.select(CatalogSelectParams params)	Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
CompletableFuture<SessionAgentSelectResult>	SessionAgentApi.select(SessionAgentSelectParams params)	Name of the custom agent to select for subsequent turns.
CompletableFuture<SessionSendResult>	SessionRpc.send(SessionSendParams params)	Parameters for sending a user message to the session
CompletableFuture<Void>	SessionExtensionsApi.sendAttachmentsToMessage(SessionExtensionsSendAttachmentsToMessageParams params)	Parameters for session.extensions.sendAttachmentsToMessage.
CompletableFuture<SessionTasksSendMessageResult>	SessionTasksApi.sendMessage(SessionTasksSendMessageParams params)	Identifier of the target agent task, message content, and optional sender agent ID.
CompletableFuture<SessionSendMessagesResult>	SessionRpc.sendMessages(SessionSendMessagesParams params)	Parameters for sending zero or more user messages to the session in a single turn.
CompletableFuture<SessionQueueSendNowResult>	SessionQueueApi.sendNow(SessionQueueSendNowParams params)	Parameters for steering a queued message into a live turn.
CompletableFuture<Void>	SessionRpc.sendSystemNotification(SessionSendSystemNotificationParams params)	Internal request for sending a system notification.
CompletableFuture<Void>	ServerPluginsBuiltinApi.set(PluginsBuiltinSetParams params)	Trusted built-in plugin directories to use for this runtime process.
CompletableFuture<UserSettingsSetResult>	ServerUserSettingsApi.set(UserSettingsSetParams params)	Partial user settings to write to settings.json.
CompletableFuture<SessionAccountsSetResult>	SessionAccountsApi.set(SessionAccountsSetParams params)	Mutation request carrying the typed write command.
CompletableFuture<SessionModeSetResult>	SessionModeApi.set(SessionModeSetParams params)	Agent interaction mode to apply to the session.
CompletableFuture<Void>	SessionNameApi.set(SessionNameSetParams params)	New friendly name to apply to the session.
CompletableFuture<Void>	SessionToolsApi.set(SessionToolsSetParams params)	Complete externally implemented tool list for the calling connection.
CompletableFuture<SessionVisibilitySetResult>	SessionVisibilityApi.set(SessionVisibilitySetParams params)	Desired sharing status for the session.
CompletableFuture<Void>	ServerSessionsApi.setAdditionalPlugins(SessionsSetAdditionalPluginsParams params)	Manager-wide additional plugins to register; replaces any previously-configured set.
CompletableFuture<SessionModelSetAllowedModelsResult>	SessionModelApi.setAllowedModels(SessionModelSetAllowedModelsParams params)	Host-supplied exact model selection IDs to allow for this running session.
CompletableFuture<SessionPermissionsSetApproveAllResult>	SessionPermissionsApi.setApproveAll(SessionPermissionsSetApproveAllParams params)	Allow-all toggle for tool permission requests, with an optional telemetry source.
CompletableFuture<SessionNameSetAutoResult>	SessionNameApi.setAuto(SessionNameSetAutoParams params)	Auto-generated session summary to apply as the session's name when no user-set name exists.
CompletableFuture<SessionGitHubAuthSetCredentialsResult>	SessionGitHubAuthApi.setCredentials(SessionGitHubAuthSetCredentialsParams params)	New auth credentials to install on the session.
CompletableFuture<Void>	ServerSkillsConfigApi.setDisabledSkills(SkillsConfigSetDisabledSkillsParams params)	Skill names to mark as disabled in global configuration, replacing any previous list.
CompletableFuture<Void>	SessionQueueApi.setDrainPaused(SessionQueueSetDrainPausedParams params)	Parameters for acquiring or releasing the queued-lane drain pause.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.setEnabled(SkillsInstallationsSetEnabledParams params)	Persisted enablement update for one owned Skill installation.
CompletableFuture<SessionMcpSetEnvValueModeResult>	SessionMcpApi.setEnvValueMode(SessionMcpSetEnvValueModeParams params)	Mode controlling how MCP server env values are resolved (`direct` or `indirect`).
CompletableFuture<Void>	SessionTelemetryApi.setFeatureOverrides(SessionTelemetrySetFeatureOverridesParams params)	Feature override key/value pairs to attach to subsequent telemetry events from this session.
CompletableFuture<Void>	SessionMcpAppsApi.setHostContext(SessionMcpAppsSetHostContextParams params)	Host context to advertise to MCP App guests.
CompletableFuture<SessionPermissionsSetModeResult>	SessionPermissionsApi.setMode(SessionPermissionsSetModeParams params)	Permission mode to apply for the session.
CompletableFuture<Void>	SessionAgentApi.setPrompt(SessionAgentSetPromptParams params)	An in-memory authored prompt override for an available agent.
CompletableFuture<LlmInferenceSetProviderResult>	ServerLlmInferenceApi.setProvider()	Indicates whether the calling client was registered as the LLM inference provider.
CompletableFuture<SessionFsSetProviderResult>	ServerSessionFsApi.setProvider(SessionFsSetProviderParams params)	Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
CompletableFuture<SessionModelSetReasoningEffortResult>	SessionModelApi.setReasoningEffort(SessionModelSetReasoningEffortParams params)	Reasoning effort level to apply to the currently selected model.
CompletableFuture<SessionsSetRemoteControlSteeringResult>	ServerSessionsApi.setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params)	Patch for the singleton's steering state.
CompletableFuture<SessionPermissionsSetRequiredResult>	SessionPermissionsApi.setRequired(SessionPermissionsSetRequiredParams params)	Toggles whether permission prompts should be bridged into session events for this client.
CompletableFuture<Void>	ServerSkillsConfigApi.setSkillDisabled(SkillsConfigSetSkillDisabledParams params)	Adds or removes a single skill from the global disabled list, leaving every other entry untouched.
CompletableFuture<SessionPermissionsUrlsSetUnrestrictedModeResult>	SessionPermissionsUrlsApi.setUnrestrictedMode(SessionPermissionsUrlsSetUnrestrictedModeParams params)	Whether the URL-permission policy should run in unrestricted mode.
CompletableFuture<SessionMetadataSetWorkingDirectoryResult>	SessionMetadataApi.setWorkingDirectory(SessionMetadataSetWorkingDirectoryParams params)	Absolute path to set as the session's new working directory.
CompletableFuture<Void>	ServerRuntimeApi.shutdown()	Invokes runtime.shutdown.
CompletableFuture<Void>	SessionRpc.shutdown(SessionShutdownParams params)	Parameters for shutting down the session
CompletableFuture<SessionMetadataSnapshotResult>	SessionMetadataApi.snapshot()	Identifies the target session.
CompletableFuture<SessionQueueSnapshotResult>	SessionQueueApi.snapshot()	Identifies the target session.
CompletableFuture<SessionSettingsSnapshotResult>	SessionSettingsApi.snapshot()	Identifies the target session.
CompletableFuture<AgentRegistrySpawnResult>	ServerAgentRegistryApi.spawn(AgentRegistrySpawnParams params)	Inputs to spawn a managed-server child via the controller's spawn delegate.
CompletableFuture<SessionFleetStartResult>	SessionFleetApi.start(SessionFleetStartParams params)	Parameters for starting fleet orchestration: an optional user prompt combined with the fleet instructions, plus the send options forwarded to the resulting turn.
CompletableFuture<SessionTasksStartAgentResult>	SessionTasksApi.startAgent(SessionTasksStartAgentParams params)	Agent type, prompt, name, and optional description and model override for the new task.
CompletableFuture<SessionsStartRemoteControlResult>	ServerSessionsApi.startRemoteControl(SessionsStartRemoteControlParams params)	Parameters for attaching the remote-control singleton to a session.
CompletableFuture<Void>	SessionMcpApi.startServer(SessionMcpStartServerParams params)	Server name and optional configuration for an individual MCP server start.
CompletableFuture<Void>	SessionMcpApi.startServer(SessionMcpStartServerRequest request)	Server name and optional configuration for an individual MCP server start.
CompletableFuture<SessionWorkspacesStatFileResult>	SessionWorkspacesApi.statFile(SessionWorkspacesStatFileParams params)	Relative path of the workspace file or directory to inspect.
CompletableFuture<McpInstallationManagementResult>	ServerMcpInstallationsApi.status(McpInstallationsStatusParams params)	Existing-operation control.
CompletableFuture<SkillInstallationManagementResult>	ServerSkillsInstallationsApi.status(SkillsInstallationsStatusParams params)	Existing-operation control.
CompletableFuture<SessionScheduleStopResult>	SessionScheduleApi.stop(SessionScheduleStopParams params)	Identifier of the scheduled prompt to remove.
CompletableFuture<SessionsStopRemoteControlResult>	ServerSessionsApi.stopRemoteControl()	Parameters for stopping the remote-control singleton.
CompletableFuture<SessionsStopRemoteControlResult>	ServerSessionsApi.stopRemoteControl(SessionsStopRemoteControlParams params)	Parameters for stopping the remote-control singleton.
CompletableFuture<Void>	SessionMcpApi.stopServer(SessionMcpStopServerParams params)	Server name for an individual MCP server stop.
CompletableFuture<Void>	SessionMcpApi.stopServer(SessionMcpStopServerRequest request)	Server name for an individual MCP server stop.
CompletableFuture<SessionHistorySummarizeForHandoffResult>	SessionHistoryApi.summarizeForHandoff()	Identifies the target session.
CompletableFuture<Void>	SessionRpc.suspend()	Identifies the target session.
CompletableFuture<SessionModelSwitchAutoTierResult>	SessionModelApi.switchAutoTier(SessionModelSwitchAutoTierParams params)	An Auto preference request for the session.
CompletableFuture<SessionModelSwitchToResult>	SessionModelApi.switchTo(SessionModelSwitchToParams params)	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
CompletableFuture<Void>	SessionGitHubAuthApi.switchToAuth(SessionGitHubAuthSwitchToAuthParams params)	Parameters for switching the session's active authentication.
CompletableFuture<SessionProviderSyncResult>	SessionProviderApi.sync(SessionProviderSyncParams params)	Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
CompletableFuture<SessionEventLogTailResult>	SessionEventLogApi.tail()	Identifies the target session.
CompletableFuture<SessionToolsTaskCompleteEventDataResult>	SessionToolsApi.taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params)	Task-completion tool arguments and final result used to build a label-safe session event payload.
CompletableFuture<SessionsTransferRemoteControlResult>	ServerSessionsApi.transferRemoteControl(SessionsTransferRemoteControlParams params)	Parameters for atomically rebinding the remote-control singleton.
CompletableFuture<SessionHistoryTruncateResult>	SessionHistoryApi.truncate(SessionHistoryTruncateParams params)	Identifier of the event to truncate to; this event and all later events are removed.
CompletableFuture<SessionWorkspacesTruncateSummariesResult>	SessionWorkspacesApi.truncateSummaries(SessionWorkspacesTruncateSummariesParams params)	Rollback point for local workspace summaries.
CompletableFuture<Void>	ServerPluginsApi.uninstall(PluginsUninstallParams params)	Name (or spec) of the plugin to uninstall.
CompletableFuture<Void>	SessionPluginsApi.uninstall(SessionPluginsUninstallParams params)	Name (or spec) of the plugin to uninstall.
CompletableFuture<Void>	SessionCanvasProviderApi.unregister(SessionCanvasProviderUnregisterParams params)	Internal canvas provider unregistration parameters.
CompletableFuture<SessionUiUnregisterDirectAutoModeSwitchHandlerResult>	SessionUiApi.unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params)	Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.
CompletableFuture<Void>	SessionMcpApi.unregisterExternalClient(SessionMcpUnregisterExternalClientParams params)	Server name identifying the external client to remove.
CompletableFuture<Void>	ServerMcpConfigApi.update(McpConfigUpdateParams params)	MCP server name and replacement configuration to write to user configuration.
CompletableFuture<PluginsUpdateResult>	ServerPluginsApi.update(PluginsUpdateParams params)	Name (or spec) of the plugin to update.
CompletableFuture<SessionOptionsUpdateResult>	SessionOptionsApi.update(SessionOptionsUpdateParams params)	Patch of mutable session options to apply to the running session.
CompletableFuture<Void>	SessionPlanApi.update(SessionPlanUpdateParams params)	Replacement contents to write to the session plan file.
CompletableFuture<SessionPluginsUpdateResult>	SessionPluginsApi.update(SessionPluginsUpdateParams params)	Name (or spec) of the plugin to update.
CompletableFuture<SessionTasksUpdateResult>	SessionTasksApi.update(SessionTasksUpdateParams params)	Updates a client-owned task.
CompletableFuture<PluginsUpdateAllResult>	ServerPluginsApi.updateAll()	Result of updating all installed plugins.
CompletableFuture<ClientMetadata>	SessionMetadataApi.updateClientMetadata(SessionMetadataUpdateClientMetadataParams params)	Atomic patch for client-owned session metadata.
CompletableFuture<SessionWorkspacesUpdateMetadataResult>	SessionWorkspacesApi.updateMetadata(SessionWorkspacesUpdateMetadataParams params)	Workspace metadata fields to update.
CompletableFuture<SessionPermissionsPathsUpdatePrimaryResult>	SessionPermissionsPathsApi.updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params)	Directory path to set as the session's new primary working directory.
CompletableFuture<Void>	SessionToolsApi.updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params)	Subagent settings to apply to the current session
CompletableFuture<SessionQueueUpdateTextResult>	SessionQueueApi.updateText(SessionQueueUpdateTextParams params)	Parameters for editing a single queued message.
CompletableFuture<Void>	SessionTasksApi.waitForPending()	Identifies the target session.
CompletableFuture<SessionQueueWithdrawMessageResult>	SessionQueueApi.withdrawMessage(SessionQueueWithdrawMessageParams params)	Conditional withdrawal of a single user message, from its queue or from the running turn it started.
CompletableFuture<SessionConnectorsWithdrawProjectionResult>	SessionConnectorsApi.withdrawProjection()	Identifies the target session.
CompletableFuture<SessionWorkspacesWriteAutopilotObjectiveResult>	SessionWorkspacesApi.writeAutopilotObjective(SessionWorkspacesWriteAutopilotObjectiveParams params)	Autopilot objective file content to persist.

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