Uses of Annotation Interface
com.github.copilot.CopilotExperimental

Packages that use CopilotExperimental

Package	Description
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.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	AccountGetQuotaResult	Quota usage snapshots for the resolved user, keyed by quota type.
final record	AccountLoginParams	Credentials to store after successful authentication
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	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.
final record	CanvasActionInvokeParams	Canvas action invocation parameters sent to the provider.
final record	CanvasCloseParams	Canvas close parameters sent to the provider.
final record	CanvasOpenParams	Canvas open parameters sent to the provider.
final record	CanvasOpenResult	Canvas open result returned by the provider.
final record	ConnectParams	Optional connection token presented by the SDK client during the handshake.
final record	ConnectResult	Handshake result reporting the server's protocol version and package version on success.
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.
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	ModelsListResult	List of Copilot models available to the resolved user, including capabilities and billing metadata.
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	PluginsDisableParams	Plugin names (or specs) to disable.
final record	PluginsEnableParams	Plugin names (or specs) to enable.
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 to register.
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	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.
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	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	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	Identifies the target session.
final record	SessionAgentListResult	Custom 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	SessionCanvasActionInvokeParams	Canvas action invocation parameters.
final record	SessionCanvasActionInvokeResult	Canvas action invocation result.
final record	SessionCanvasCloseParams	Canvas close parameters.
final record	SessionCanvasListOpenParams	Identifies the target session.
final record	SessionCanvasListOpenResult	Live open-canvas snapshot.
final record	SessionCanvasListParams	Identifies the target session.
final record	SessionCanvasListResult	Declared canvases available in this session.
final record	SessionCanvasOpenParams	Canvas open parameters.
final record	SessionCanvasOpenResult	Open canvas instance snapshot.
final record	SessionCommandsEnqueueParams	Slash-prefixed command string to enqueue for FIFO processing.
final record	SessionCommandsEnqueueResult	Indicates whether the command was accepted into the local execution queue.
final record	SessionCommandsExecuteParams	Slash command name and argument string to execute synchronously.
final record	SessionCommandsExecuteResult	Error message produced while executing the command, if any.
final record	SessionCommandsHandlePendingCommandParams	Pending command request ID and an optional error if the client handler failed.
final record	SessionCommandsHandlePendingCommandResult	Indicates whether the pending client-handled command was completed successfully.
final record	SessionCommandsInvokeParams	Slash command name and optional raw input string to invoke.
final record	SessionCommandsListParams	Optional filters controlling which command sources to include in the listing.
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	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	Optional user prompt to combine with the fleet orchestration instructions.
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	SessionFsSqliteQueryResult	Query results including rows, columns, and rows affected, or a filesystem error if execution failed.
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	SessionGitHubAuthGetStatusParams	Identifies the target session.
final record	SessionGitHubAuthGetStatusResult	Authentication status and account metadata for the session.
final record	SessionGitHubAuthSetCredentialsParams	New auth credentials to install on the session.
final record	SessionGitHubAuthSetCredentialsResult	Indicates whether the credential update succeeded.
final record	SessionHistoryAbortManualCompactionParams	Identifies the target session.
final record	SessionHistoryAbortManualCompactionResult	Indicates whether an in-progress manual compaction was aborted.
final record	SessionHistoryCancelBackgroundCompactionParams	Identifies the target session.
final record	SessionHistoryCancelBackgroundCompactionResult	Indicates whether an in-progress background compaction was cancelled.
final record	SessionHistoryCompactParams	Optional compaction parameters.
final record	SessionHistoryCompactResult	Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.
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	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	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	Opaque auth info 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 record	SessionMcpEnableParams	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	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 record	SessionMcpOauthLoginResult	OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.
final record	SessionMcpOauthRespondParams	MCP OAuth request id and optional provider response.
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	SessionMcpRestartServerParams	Server name and opaque 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 opaque configuration for an individual MCP server start.
final record	SessionMcpStopServerParams	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	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	SessionModeGetParams	Identifies the target session.
final record	SessionModelGetCurrentParams	Identifies the target session.
final record	SessionModelGetCurrentResult	The currently selected model, reasoning effort, and context tier for the session.
final record	SessionModelListParams	Optional listing options.
final record	SessionModelListResult	The list of models available to this session.
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	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	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	SessionPermissionsGetAllowAllParams	No parameters.
final record	SessionPermissionsGetAllowAllResult	Current full allow-all permission state.
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 allow-listed directories.
final record	SessionPermissionsPathsListResult	Snapshot of the session's allow-listed directories 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	No parameters; clears all session-scoped tool permission approvals.
final record	SessionPermissionsResetSessionApprovalsResult	Indicates whether the operation succeeded.
final record	SessionPermissionsSetAllowAllParams	Whether to enable full allow-all permissions for the session.
final record	SessionPermissionsSetAllowAllResult	Indicates whether the operation succeeded and reports the post-mutation state.
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	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	SessionPluginsListParams	Identifies the target session.
final record	SessionPluginsListResult	Plugins installed for the session, with their enabled state and version metadata.
final record	SessionPluginsReloadParams	Optional flags controlling which side effects the reload performs.
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	Optional model identifier to scope the endpoint snapshot to.
final record	SessionProviderGetEndpointResult	A snapshot of the provider endpoint the session is currently configured to talk to.
final record	SessionQueueClearParams	Identifies the target session.
final record	SessionQueuePendingItemsParams	Identifies the target session.
final record	SessionQueuePendingItemsResult	Snapshot of the session's pending queued items and immediate-steering messages.
final record	SessionQueueRemoveMostRecentParams	Identifies the target session.
final record	SessionQueueRemoveMostRecentResult	Indicates whether a user-facing pending item was removed.
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	SessionsBulkDeleteParams	Session IDs to close, deactivate, and delete from disk.
final record	SessionsBulkDeleteResult	Map of sessionId -> bytes freed by removing the session's workspace directory.
final record	SessionsCheckInUseParams	Session IDs to test for live in-use locks.
final record	SessionsCheckInUseResult	Session IDs from the input set that are currently in use by another process.
final record	SessionScheduleListParams	Identifies the target session.
final record	SessionScheduleListResult	Snapshot of the currently active recurring prompts for this session.
final record	SessionScheduleStopParams	Identifier of the scheduled prompt to remove.
final record	SessionScheduleStopResult	Remove a scheduled prompt by id.
final record	SessionsCloseParams	Session ID to close.
final record	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	SessionSendParams	Parameters for sending a user message to the session
final record	SessionSendResult	Result of sending a user message
final record	SessionsEnrichMetadataParams	Session metadata records to enrich with summary and context information.
final record	SessionsEnrichMetadataResult	The enriched metadata records, with summary and context fields backfilled where available.
final record	SessionsFindByPrefixParams	UUID prefix to resolve to a unique session ID.
final record	SessionsFindByPrefixResult	Session ID matching the prefix, omitted when no unique match exists.
final record	SessionsFindByTaskIdParams	GitHub task ID to look up.
final record	SessionsFindByTaskIdResult	ID of the local session bound to the given GitHub task, or omitted when none.
final record	SessionsForkParams	Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.
final record	SessionsForkResult	Identifier and optional friendly name assigned to the newly forked session.
final record	SessionsGetBoardEntryCountParams	Session ID whose board entry count should be returned.
final record	SessionsGetBoardEntryCountResult	Dynamic-context board entry count, when available.
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	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	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	SessionsPollSpawnedSessionsResult	Batch of spawn events plus a cursor for follow-up polls.
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	SessionsRegisterExtensionToolsOnSessionParams	Params to attach an extension loader's tools to a session.
final record	SessionsRegisterExtensionToolsOnSessionResult	Handle for releasing the extension tool registration.
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	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	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	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	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	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	Transient answer generated from current conversation context.
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	SessionWorkspacesCreateFileParams	Relative path and UTF-8 content for the workspace file to create or overwrite.
final record	SessionWorkspacesDiffParams	Parameters for computing a workspace diff.
final record	SessionWorkspacesDiffResult	Workspace diff result for the requested mode.
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	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	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	SkillsConfigSetDisabledSkillsParams	Skill names to mark as disabled in global configuration, replacing any previous list.
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	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.

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<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 to register.
CompletableFuture<SessionPermissionsPathsAddResult>	SessionPermissionsPathsApi.add(SessionPermissionsPathsAddParams params)	Directory path to add to the session's allowed directories.
CompletableFuture<SessionProviderAddResult>	SessionProviderApi.add(SessionProviderAddParams params)	BYOK providers and/or models to add to the session's registry at runtime.
CompletableFuture<SecretsAddFilterValuesResult>	ServerSecretsApi.addFilterValues(SecretsAddFilterValuesParams params)	Secret values to add to the redaction filter.
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<SessionPermissionsLocationsApplyResult>	SessionPermissionsLocationsApi.apply(SessionPermissionsLocationsApplyParams params)	Working directory to load persisted location permissions for.
CompletableFuture<PluginsMarketplacesBrowseResult>	ServerPluginsMarketplacesApi.browse(PluginsMarketplacesBrowseParams 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<SessionTasksCancelResult>	SessionTasksApi.cancel(SessionTasksCancelParams params)	Identifier of the background task to cancel.
CompletableFuture<SessionHistoryCancelBackgroundCompactionResult>	SessionHistoryApi.cancelBackgroundCompaction()	Identifies the target session.
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<Void>	SessionQueueApi.clear()	Identifies the target session.
CompletableFuture<Void>	ServerSessionsApi.close()	Session ID to close.
CompletableFuture<Void>	SessionCanvasApi.close(SessionCanvasCloseParams params)	Canvas close parameters.
CompletableFuture<SessionHistoryCompactResult>	SessionHistoryApi.compact()	Optional compaction parameters.
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)	Opaque auth info 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)	Optional connection token presented by the SDK client during the handshake.
CompletableFuture<SessionsConnectResult>	ServerSessionsApi.connect()	Remote session connection parameters.
CompletableFuture<SessionMetadataContextInfoResult>	SessionMetadataApi.contextInfo(SessionMetadataContextInfoParams params)	Model identifier and token limits used to compute the context-info breakdown.
CompletableFuture<Void>	SessionWorkspacesApi.createFile(SessionWorkspacesCreateFileParams params)	Relative path and UTF-8 content for the workspace file to create or overwrite.
CompletableFuture<Void>	SessionPlanApi.delete()	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>	ServerMcpConfigApi.disable(McpConfigDisableParams params)	MCP server names to disable for new sessions.
CompletableFuture<Void>	ServerPluginsApi.disable(PluginsDisableParams params)	Plugin names (or specs) to disable.
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>	SessionRemoteApi.disable()	Identifies the target session.
CompletableFuture<Void>	SessionSkillsApi.disable(SessionSkillsDisableParams params)	Name of the skill to disable for the session.
CompletableFuture<AgentsDiscoverResult>	ServerAgentsApi.discover(AgentsDiscoverParams params)	Optional project paths to include in agent 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<SessionUiElicitationResult>	SessionUiApi.elicitation(SessionUiElicitationParams params)	Prompt message and JSON schema describing the form fields to elicit from the user.
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.
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<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<SessionCommandsEnqueueResult>	SessionCommandsApi.enqueue(SessionCommandsEnqueueParams params)	Slash-prefixed command string to enqueue for FIFO processing.
CompletableFuture<SessionsEnrichMetadataResult>	ServerSessionsApi.enrichMetadata(SessionsEnrichMetadataParams params)	Session metadata records to enrich with summary and context information.
CompletableFuture<Void>	SessionSkillsApi.ensureLoaded()	Identifies the target session.
CompletableFuture<SessionUiEphemeralQueryResult>	SessionUiApi.ephemeralQuery(SessionUiEphemeralQueryParams params)	Transient question to answer without adding it to conversation history.
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<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<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<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<SessionMode>	SessionModeApi.get()	Identifies the target session.
CompletableFuture<SessionNameGetResult>	SessionNameApi.get()	Identifies the target session.
CompletableFuture<SessionVisibilityGetResult>	SessionVisibilityApi.get()	Identifies the target session.
CompletableFuture<SessionPermissionsGetAllowAllResult>	SessionPermissionsApi.getAllowAll()	No parameters.
CompletableFuture<List<AccountAllUsers>>	ServerAccountApi.getAllUsers()	List of all authenticated users
CompletableFuture<SessionsGetBoardEntryCountResult>	ServerSessionsApi.getBoardEntryCount()	Session ID whose board entry count should be returned.
CompletableFuture<SessionAgentGetCurrentResult>	SessionAgentApi.getCurrent()	Identifies the target session.
CompletableFuture<SessionModelGetCurrentResult>	SessionModelApi.getCurrent()	Identifies the target session.
CompletableFuture<AccountGetCurrentAuthResult>	ServerAccountApi.getCurrentAuth()	Current authentication state
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<SessionTelemetryGetEngagementIdResult>	SessionTelemetryApi.getEngagementId()	Identifies the target session.
CompletableFuture<SessionsGetEventFilePathResult>	ServerSessionsApi.getEventFilePath()	Session ID whose event-log file path to compute.
CompletableFuture<SessionMcpAppsGetHostContextResult>	SessionMcpAppsApi.getHostContext()	Identifies the target session.
CompletableFuture<SessionSkillsGetInvokedResult>	SessionSkillsApi.getInvoked()	Identifies the target session.
CompletableFuture<SessionsGetLastForContextResult>	ServerSessionsApi.getLastForContext(SessionsGetLastForContextParams params)	Optional working-directory context used to score session relevance.
CompletableFuture<SessionUsageGetMetricsResult>	SessionUsageApi.getMetrics()	Identifies the target session.
CompletableFuture<SessionsGetPersistedRemoteSteerableResult>	ServerSessionsApi.getPersistedRemoteSteerable()	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 GitHub token used to look up quota for a specific user instead of the global auth context.
CompletableFuture<SessionsGetRemoteControlStatusResult>	ServerSessionsApi.getRemoteControlStatus()	Wrapper for the singleton's current status.
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<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<LlmInferenceHttpResponseChunkResult>	ServerLlmInferenceApi.httpResponseChunk(LlmInferenceHttpResponseChunkParams params)	A response body chunk or terminal error.
CompletableFuture<LlmInferenceHttpResponseStartResult>	ServerLlmInferenceApi.httpResponseStart(LlmInferenceHttpResponseStartParams params)	Response head.
CompletableFuture<Void>	SessionLspApi.initialize(SessionLspInitializeParams params)	Parameters for (re)loading the merged LSP configuration set.
CompletableFuture<Void>	SessionToolsApi.initializeAndValidate()	Identifies the target session.
CompletableFuture<PluginsInstallResult>	ServerPluginsApi.install(PluginsInstallParams params)	Plugin source and optional working directory for relative-path resolution.
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<McpConfigListResult>	ServerMcpConfigApi.list()	User-configured MCP servers, keyed by server name.
CompletableFuture<ModelsListResult>	ServerModelsApi.list()	Optional GitHub token used to list models for a specific user instead of the global auth context.
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<ToolsListResult>	ServerToolsApi.list(ToolsListParams params)	Optional model identifier whose tool overrides should be applied to the listing.
CompletableFuture<SessionAgentListResult>	SessionAgentApi.list()	Identifies the target session.
CompletableFuture<SessionCanvasListResult>	SessionCanvasApi.list()	Identifies the target session.
CompletableFuture<SessionCommandsListResult>	SessionCommandsApi.list()	Optional filters controlling which command sources to include in the listing.
CompletableFuture<SessionExtensionsListResult>	SessionExtensionsApi.list()	Identifies the target session.
CompletableFuture<SessionMcpListResult>	SessionMcpApi.list()	Identifies the target session.
CompletableFuture<SessionModelListResult>	SessionModelApi.list()	Optional listing options.
CompletableFuture<SessionPermissionsPathsListResult>	SessionPermissionsPathsApi.list()	No parameters; returns the session's allow-listed directories.
CompletableFuture<SessionPluginsListResult>	SessionPluginsApi.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<SessionCanvasListOpenResult>	SessionCanvasApi.listOpen()	Identifies the target session.
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()	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<AccountLoginResult>	ServerAccountApi.login(AccountLoginParams params)	Credentials to store after successful authentication
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<AccountLogoutResult>	ServerAccountApi.logout(AccountLogoutParams params)	User to log out
CompletableFuture<SessionPermissionsModifyRulesResult>	SessionPermissionsApi.modifyRules(SessionPermissionsModifyRulesParams params)	Scope and add/remove instructions for modifying session- or location-scoped permission rules.
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()	Open a session by creating, resuming, attaching, connecting to a remote, or handing off.
CompletableFuture<SessionCanvasOpenResult>	SessionCanvasApi.open(SessionCanvasOpenParams params)	Canvas open parameters.
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<SessionsPollSpawnedSessionsResult>	ServerSessionsApi.pollSpawnedSessions()	Cursor and optional long-poll wait for polling runtime-spawned sessions.
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<SessionEventLogReadResult>	SessionEventLogApi.read(SessionEventLogReadParams params)	Cursor, batch size, and optional long-poll/filter parameters for reading session events.
CompletableFuture<SessionPlanReadResult>	SessionPlanApi.read()	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<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<SessionMetadataRecomputeContextTokensResult>	SessionMetadataApi.recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params)	Model identifier to use when re-tokenizing the session's existing messages.
CompletableFuture<Void>	SessionMetadataApi.recordContextChange(SessionMetadataRecordContextChangeParams params)	Updated working-directory/git context to record on the session.
CompletableFuture<PluginsMarketplacesRefreshResult>	ServerPluginsMarketplacesApi.refresh()	Optional marketplace name; omit to refresh all.
CompletableFuture<Void>	SessionTasksApi.refresh()	Identifies the target session.
CompletableFuture<SessionUiRegisterDirectAutoModeSwitchHandlerResult>	SessionUiApi.registerDirectAutoModeSwitchHandler()	Identifies the target session.
CompletableFuture<SessionsRegisterExtensionToolsOnSessionResult>	ServerSessionsApi.registerExtensionToolsOnSession(SessionsRegisterExtensionToolsOnSessionParams params)	Params to attach an extension loader's tools to a session.
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()	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<Void>	SessionExtensionsApi.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<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<SessionTasksRemoveResult>	SessionTasksApi.remove(SessionTasksRemoveParams params)	Identifier of the completed or cancelled task to remove from tracking.
CompletableFuture<SessionMcpRemoveGitHubResult>	SessionMcpApi.removeGitHub()	Identifies the target session.
CompletableFuture<SessionQueueRemoveMostRecentResult>	SessionQueueApi.removeMostRecent()	Identifies the target session.
CompletableFuture<SessionCompletionsRequestResult>	SessionCompletionsApi.request(SessionCompletionsRequestParams params)	Request host-driven completions for the current composer input.
CompletableFuture<SessionPermissionsResetSessionApprovalsResult>	SessionPermissionsApi.resetSessionApprovals()	No parameters; clears all session-scoped tool permission approvals.
CompletableFuture<SessionPermissionsLocationsResolveResult>	SessionPermissionsLocationsApi.resolve(SessionPermissionsLocationsResolveParams params)	Working directory to resolve into a location-permissions key.
CompletableFuture<Void>	SessionMcpOauthApi.respond(SessionMcpOauthRespondParams params)	MCP OAuth request id and optional provider response.
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 opaque configuration for an individual MCP server restart.
CompletableFuture<Void>	ServerSessionsApi.save()	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<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<UserSettingsSetResult>	ServerUserSettingsApi.set(UserSettingsSetParams params)	Partial user settings to write to settings.json.
CompletableFuture<Void>	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<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<SessionPermissionsSetAllowAllResult>	SessionPermissionsApi.setAllowAll(SessionPermissionsSetAllowAllParams params)	Whether to enable full allow-all permissions for the 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<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<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<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<AgentRegistrySpawnResult>	ServerAgentRegistryApi.spawn(AgentRegistrySpawnParams params)	Inputs to spawn a managed-server child via the controller's spawn delegate.
CompletableFuture<SessionFleetStartResult>	SessionFleetApi.start(SessionFleetStartParams params)	Optional user prompt to combine with the fleet orchestration instructions.
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 opaque configuration for an individual MCP server start.
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<Void>	SessionMcpApi.stopServer(SessionMcpStopServerParams params)	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<SessionModelSwitchToResult>	SessionModelApi.switchTo(SessionModelSwitchToParams params)	Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.
CompletableFuture<SessionEventLogTailResult>	SessionEventLogApi.tail()	Identifies the target session.
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<Void>	ServerPluginsApi.uninstall(PluginsUninstallParams params)	Name (or spec) of the plugin to uninstall.
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<PluginsUpdateAllResult>	ServerPluginsApi.updateAll()	Result of updating all installed plugins.
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<Void>	SessionTasksApi.waitForPending()	Identifies the target session.

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

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.
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.
Optional<Boolean>	ResumeSessionConfig.getEnableCitations()	Gets whether native model citations are enabled.
Optional<Boolean>	SessionConfig.getEnableCitations()	Gets whether native model citations are enabled.
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.
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.
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.
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.
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).
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).
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.

Uses of CopilotExperimental in com.github.copilot.tool

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

Modifier and Type	Class	Description
@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.
class	SchemaGenerator	Compile-time utility that maps javax.lang.model types to JSON Schema represented as Java source code literals (Map.of(...) expressions).