Uses of Annotation Interface
com.github.copilot.CopilotExperimental
Packages that use CopilotExperimental
-
Uses of CopilotExperimental in com.github.copilot.generated.rpc
Classes in com.github.copilot.generated.rpc with annotations of type CopilotExperimentalModifier and TypeClassDescriptionfinal recordInputs to spawn a managed-server child via the controller's spawn delegate.final recordOptional project paths to include in agent discovery.final recordAgents discovered across user, project, plugin, and remote sources.final recordCanvas action invocation parameters sent to the provider.final recordCanvas close parameters sent to the provider.final recordCanvas open parameters sent to the provider.final recordCanvas open result returned by the provider.final recordOptional project paths to include in instruction discovery.final recordInstruction sources discovered across user, repository, and plugin sources.final recordPlugin names (or specs) to disable.final recordPlugin names (or specs) to enable.final recordPlugin source and optional working directory for relative-path resolution.final recordResult of installing a plugin.final recordPlugins installed in user/global state.final recordMarketplace source to register.final recordResult of registering a new marketplace.final recordName of the marketplace whose plugin catalog to fetch.final recordPlugins advertised by the marketplace.final recordAll registered marketplaces, including built-in defaults.final recordResult of refreshing one or more marketplace catalogs.final recordName of the marketplace to remove and an optional force flag.final recordOutcome of the remove attempt, including dependent-plugin info when applicable.final recordName (or spec) of the plugin to uninstall.final recordResult of updating all installed plugins.final recordName (or spec) of the plugin to update.final recordResult of updating a single plugin.final recordParameters for aborting the current turnfinal recordResult of aborting the current turnfinal recordIdentifies the target session.final recordIdentifies the target session.final recordThe currently selected custom agent, or null when using the default agent.final recordIdentifies the target session.final recordCustom agents available to the session.final recordIdentifies the target session.final recordCustom agents available to the session after reloading definitions from disk.final recordName of the custom agent to select for subsequent turns.final recordThe newly selected custom agent.final recordIdentifies the target session.final recordAuthentication status and account metadata for the session.final recordNew auth credentials to install on the session.final recordIndicates whether the credential update succeeded.final recordCanvas action invocation parameters.final recordCanvas action invocation result.final recordCanvas close parameters.final recordIdentifies the target session.final recordLive open-canvas snapshot.final recordIdentifies the target session.final recordDeclared canvases available in this session.final recordCanvas open parameters.final recordOpen canvas instance snapshot.final recordSlash-prefixed command string to enqueue for FIFO processing.final recordIndicates whether the command was accepted into the local execution queue.final recordSlash command name and argument string to execute synchronously.final recordError message produced while executing the command, if any.final recordPending command request ID and an optional error if the client handler failed.final recordIndicates whether the pending client-handled command was completed successfully.final recordSlash command name and optional raw input string to invoke.final recordOptional filters controlling which command sources to include in the listing.final recordSlash commands available in the session, after applying any include/exclude filters.final recordQueued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).final recordIndicates whether the queued-command response was matched to a pending request.final recordCursor, batch size, and optional long-poll/filter parameters for reading session events.final recordBatch of session events returned by a read, with cursor and continuation metadata.final recordEvent type to register consumer interest for, used by runtime gating logic.final recordOpaque handle representing an event-type interest registration.final recordOpaque handle previously returned by `registerInterest` to release.final recordIndicates whether the operation succeeded.final recordIdentifies the target session.final recordSnapshot of the current tail cursor without returning any events.final recordSource-qualified extension identifier to disable for the session.final recordSource-qualified extension identifier to enable for the session.final recordIdentifies the target session.final recordExtensions discovered for the session, with their current status.final recordIdentifies the target session.final recordParameters for session.extensions.sendAttachmentsToMessage.final recordOptional user prompt to combine with the fleet orchestration instructions.final recordIndicates whether fleet mode was successfully activated.final recordFile path, content to append, and optional mode for the client-provided session filesystem.final recordPath to test for existence in the client-provided session filesystem.final recordIndicates whether the requested path exists in the client-provided session filesystem.final recordDirectory path to create in the client-provided session filesystem, with options for recursive creation and POSIX mode.final recordDirectory path whose entries should be listed from the client-provided session filesystem.final recordNames of entries in the requested directory, or a filesystem error if the read failed.final recordDirectory path whose entries (with type information) should be listed from the client-provided session filesystem.final recordEntries in the requested directory paired with file/directory type information, or a filesystem error if the read failed.final recordPath of the file to read from the client-provided session filesystem.final recordFile content as a UTF-8 string, or a filesystem error if the read failed.final recordSource and destination paths for renaming or moving an entry in the client-provided session filesystem.final recordPath to remove from the client-provided session filesystem, with options for recursive removal and force.final recordIdentifies the target session.final recordIndicates whether the per-session SQLite database already exists.final recordSQL query, query type, and optional bind parameters for executing a SQLite query against the per-session database.final recordQuery results including rows, columns, and rows affected, or a filesystem error if execution failed.final recordPath whose metadata should be returned from the client-provided session filesystem.final recordFilesystem metadata for the requested path, or a filesystem error if the stat failed.final recordFile path, content to write, and optional mode for the client-provided session filesystem.final recordIdentifies the target session.final recordIndicates whether an in-progress manual compaction was aborted.final recordIdentifies the target session.final recordIndicates whether an in-progress background compaction was cancelled.final recordOptional compaction parameters.final recordCompaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.final recordIdentifies the target session.final recordMarkdown summary of the conversation context (empty when not available).final recordIdentifier of the event to truncate to; this event and all later events are removed.final recordNumber of events that were removed by the truncation.final recordIdentifies the target session.final recordInstruction sources loaded for the session, in merge order.final recordMessage text, optional severity level, persistence flag, optional follow-up URL, and optional tip.final recordIdentifier of the session event that was emitted for the log message.final recordParameters for (re)loading the merged LSP configuration set.final recordMCP server, tool name, and arguments to invoke from an MCP App view.final recordMCP server to diagnose MCP Apps wiring for.final recordDiagnostic snapshot of MCP Apps wiring for the named server.final recordIdentifies the target session.final recordCurrent host context advertised to MCP App guests.final recordMCP server to list app-callable tools for.final recordApp-callable tools from the named MCP server.final recordMCP server and resource URI to fetch.final recordResource contents returned by the MCP server.final recordHost context to advertise to MCP App guests.final recordThe requestId previously passed to executeSampling that should be cancelled.final recordIndicates whether an in-flight sampling execution with the given requestId was found and cancelled.final recordOpaque auth info used to configure GitHub MCP.final recordResult of configuring GitHub MCP.final recordName of the MCP server to disable for the session.final recordName of the MCP server to enable for the session.final recordIdentifiers and raw MCP CreateMessageRequest params used to run a sampling inference.final recordOutcome of an MCP sampling execution: success result, failure error, or cancellation.final recordServer name to check running status for.final recordWhether the named MCP server is running.final recordIdentifies the target session.final recordMCP servers configured for the session, with their connection status and host-level state.final recordServer name whose tool list should be returned.final recordTools exposed by the connected MCP server.final recordRemote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy.final recordOAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.final recordMCP OAuth request id and optional provider response.final recordRegistration parameters for an external MCP client.final recordIdentifies the target session.final recordOpaque MCP reload configuration.final recordMCP server startup filtering result.final recordIdentifies the target session.final recordIndicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).final recordServer name and opaque configuration for an individual MCP server restart.final recordMode controlling how MCP server env values are resolved (`direct` or `indirect`).final recordEnv-value mode recorded on the session after the update.final recordServer name and opaque configuration for an individual MCP server start.final recordServer name for an individual MCP server stop.final recordServer name identifying the external client to remove.final recordIdentifies the target session.final recordCurrent activity flags for the session.final recordModel identifier and token limits used to compute the context-info breakdown.final recordToken breakdown for the session's current context window, or null if uninitialized.final recordIdentifies the target session.final recordIndicates whether the local session is currently processing a turn or background continuation.final recordModel identifier to use when re-tokenizing the session's existing messages.final recordRe-tokenize the session's existing messages against `modelId` and return the token totals.final recordUpdated working-directory/git context to record on the session.final recordAbsolute path to set as the session's new working directory.final recordUpdate the session's working directory.final recordIdentifies the target session.final recordPoint-in-time snapshot of slow-changing session identifier and state fieldsfinal recordIdentifies the target session.final recordIdentifies the target session.final recordThe currently selected model, reasoning effort, and context tier for the session.final recordOptional listing options.final recordThe list of models available to this session.final recordReasoning effort level to apply to the currently selected model.final recordUpdate the session's reasoning effort without changing the selected model.final recordTarget model identifier and optional reasoning effort, summary, capability overrides, and context tier.final recordThe model identifier active on the session after the switch.final recordAgent interaction mode to apply to the session.final recordIdentifies the target session.final recordThe session's friendly name, or null when not yet set.final recordAuto-generated session summary to apply as the session's name when no user-set name exists.final recordIndicates whether the auto-generated summary was applied as the session's name.final recordNew friendly name to apply to the session.final recordPatch of mutable session options to apply to the running session.final recordIndicates whether the session options patch was applied successfully.final recordPatch of permission policy fields to apply (omit a field to leave it unchanged).final recordIndicates whether the operation succeeded.final recordFolder path to add to trusted folders.final recordIndicates whether the operation succeeded.final recordFolder path to check for trust.final recordFolder trust check result.final recordNo parameters.final recordCurrent full allow-all permission state.final recordPending permission request ID and the decision to apply (approve/reject and scope).final recordIndicates whether the permission decision was applied; false when the request was already resolved.final recordLocation-scoped tool approval to persist.final recordIndicates whether the operation succeeded.final recordWorking directory to load persisted location permissions for.final recordSummary of persisted location permissions applied to the session.final recordWorking directory to resolve into a location-permissions key.final recordResolved location-permissions key and type.final recordScope and add/remove instructions for modifying session- or location-scoped permission rules.final recordIndicates whether the operation succeeded.final recordNotification payload describing the permission prompt that the client just rendered.final recordIndicates whether the operation succeeded.final recordDirectory path to add to the session's allowed directories.final recordIndicates whether the operation succeeded.final recordPath to evaluate against the session's allowed directories.final recordIndicates whether the supplied path is within the session's allowed directories.final recordPath to evaluate against the session's workspace (primary) directory.final recordIndicates whether the supplied path is within the session's workspace directory.final recordNo parameters; returns the session's allow-listed directories.final recordSnapshot of the session's allow-listed directories and primary working directory.final recordDirectory path to set as the session's new primary working directory.final recordIndicates whether the operation succeeded.final recordNo parameters; returns currently-pending permission requests for the session.final recordList of pending permission requests reconstructed from event history.final recordNo parameters; clears all session-scoped tool permission approvals.final recordIndicates whether the operation succeeded.final recordWhether to enable full allow-all permissions for the session.final recordIndicates whether the operation succeeded and reports the post-mutation state.final recordAllow-all toggle for tool permission requests, with an optional telemetry source.final recordIndicates whether the operation succeeded.final recordToggles whether permission prompts should be bridged into session events for this client.final recordIndicates whether the operation succeeded.final recordWhether the URL-permission policy should run in unrestricted mode.final recordIndicates whether the operation succeeded.final recordIdentifies the target session.final recordIdentifies the target session.final recordExistence, contents, and resolved path of the session plan file.final recordIdentifies the target session.final recordTodo rows read from the session SQL database.final recordReplacement contents to write to the session plan file.final recordIdentifies the target session.final recordPlugins installed for the session, with their enabled state and version metadata.final recordOptional flags controlling which side effects the reload performs.final recordIdentifies the target session.final recordIdentifies the target session.final recordSnapshot of the session's pending queued items and immediate-steering messages.final recordIdentifies the target session.final recordIndicates whether a user-facing pending item was removed.final recordIdentifies the target session.final recordOptional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.final recordGitHub URL for the session and a flag indicating whether remote steering is enabled.final recordNew remote-steerability state to persist as a `session.remote_steerable_changed` event.final recordSession IDs to close, deactivate, and delete from disk.final recordMap of sessionId -> bytes freed by removing the session's workspace directory.final recordSession IDs to test for live in-use locks.final recordSession IDs from the input set that are currently in use by another process.final recordIdentifies the target session.final recordSnapshot of the currently active recurring prompts for this session.final recordIdentifier of the scheduled prompt to remove.final recordRemove a scheduled prompt by id.final recordSession ID to close.final recordParams to attach or detach an in-process ExtensionController delegate.final recordRemote session connection parameters.final recordRemote session connection result.final recordParameters for sending a user message to the sessionfinal recordResult of sending a user messagefinal recordSession metadata records to enrich with summary and context information.final recordThe enriched metadata records, with summary and context fields backfilled where available.final recordUUID prefix to resolve to a unique session ID.final recordSession ID matching the prefix, omitted when no unique match exists.final recordGitHub task ID to look up.final recordID of the local session bound to the given GitHub task, or omitted when none.final recordSource session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.final recordIdentifier and optional friendly name assigned to the newly forked session.final recordSession ID whose board entry count should be returned.final recordDynamic-context board entry count, when available.final recordSession ID whose event-log file path to compute.final recordAbsolute path to the session's events.jsonl file on disk.final recordOptional working-directory context used to score session relevance.final recordMost-relevant session ID for the supplied context, or omitted when no sessions exist.final recordSession ID to look up the persisted remote-steerable flag for.final recordThe session's persisted remote-steerable flag, or omitted when no value has been persisted.final recordWrapper for the singleton's current status.final recordMap of sessionId -> on-disk size in bytes for each session's workspace directory.final recordUser-requested shell execution cancellation handle.final recordCancellation result for a user-requested shell command.final recordShell command to run, with optional working directory and timeout in milliseconds.final recordIdentifier of the spawned process, used to correlate streamed output and exit notifications.final recordUser-requested shell command and cancellation handle.final recordResult of a user-requested shell command.final recordIdentifier of a process previously returned by "shell.exec" and the signal to send.final recordIndicates whether the signal was delivered; false if the process was unknown or already exited.final recordParameters for shutting down the sessionfinal recordName of the skill to disable for the session.final recordName of the skill to enable for the session.final recordIdentifies the target session.final recordIdentifies the target session.final recordSkills invoked during this session, ordered by invocation time (most recent last).final recordIdentifies the target session.final recordSkills available to the session, with their enabled state.final recordIdentifies the target session.final recordDiagnostics from reloading skill definitions, with warnings and errors as separate lists.final recordSessions matching the filter, ordered most-recently-modified first.final recordActive session ID whose deferred repo-level hooks should be loaded.final recordQueued repo-level startup prompts and the total hook command count after loading.final recordResult of opening a session.final recordBatch of spawn events plus a cursor for follow-up polls.final recordAge threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).final recordOutcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.final recordParams to attach an extension loader's tools to a session.final recordHandle for releasing the extension tool registration.final recordSession ID whose in-use lock should be released.final recordActive session ID and an optional flag for deferring repo-level hooks until folder trust.final recordSession ID whose pending events should be flushed to disk.final recordManager-wide additional plugins to register; replaces any previously-configured set.final recordPatch for the singleton's steering state.final recordWrapper for the singleton's current status.final recordParameters for attaching the remote-control singleton to a session.final recordWrapper for the singleton's current status.final recordOutcome of a stopRemoteControl call.final recordParameters for atomically rebinding the remote-control singleton.final recordOutcome of a transferRemoteControl call.final recordIdentifies the target session.final recordIdentifier of the background task to cancel.final recordIndicates whether the background task was successfully cancelled.final recordIdentifies the target session.final recordThe first sync-waiting task that can currently be promoted to background mode.final recordIdentifier of the background task to fetch progress for.final recordProgress information for the task, or null when no task with that ID is tracked.final recordIdentifies the target session.final recordBackground tasks currently tracked by the session.final recordIdentifies the target session.final recordThe promoted task as it now exists in background mode, omitted if no promotable task was waiting.final recordIdentifier of the task to promote to background mode.final recordIndicates whether the task was successfully promoted to background mode.final recordIdentifies the target session.final recordIdentifier of the completed or cancelled task to remove from tracking.final recordIndicates whether the task was removed.final recordIdentifier of the target agent task, message content, and optional sender agent ID.final recordIndicates whether the message was delivered, with an error message when delivery failed.final recordAgent type, prompt, name, and optional description and model override for the new task.final recordIdentifier assigned to the newly started background agent task.final recordIdentifies the target session.final recordIdentifies the target session.final recordTelemetry engagement ID for the session, when available.final recordFeature override key/value pairs to attach to subsequent telemetry events from this session.final recordIdentifies the target session.final recordCurrent lightweight tool metadata snapshot for the session.final recordPending external tool call request ID, with the tool result or an error describing why it failed.final recordIndicates whether the external tool call result was handled successfully.final recordIdentifies the target session.final recordPrompt message and JSON schema describing the form fields to elicit from the user.final recordThe elicitation response (accept with form values, decline, or cancel)final recordTransient question to answer without adding it to conversation history.final recordTransient answer generated from current conversation context.final recordRequest ID of a pending `auto_mode_switch.requested` event and the user's response.final recordIndicates whether the pending UI request was resolved by this call.final recordPending elicitation request ID and the user's response (accept/decline/cancel + form values).final recordIndicates whether the elicitation response was accepted; false if it was already resolved by another client.final recordRequest ID of a pending `exit_plan_mode.requested` event and the user's response.final recordIndicates whether the pending UI request was resolved by this call.final recordRequest ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).final recordIndicates whether the pending UI request was resolved by this call.final recordRequest ID of a pending `user_input.requested` event and the user's response.final recordIndicates whether the pending UI request was resolved by this call.final recordIdentifies the target session.final recordRegister an in-process handler for `auto_mode_switch.requested` events.final recordOpaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.final recordIndicates whether the handle was active and the registration count was decremented.final recordIdentifies the target session.final recordAccumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals.final recordRelative path and UTF-8 content for the workspace file to create or overwrite.final recordParameters for computing a workspace diff.final recordWorkspace diff result for the requested mode.final recordIdentifies the target session.final recordCurrent workspace metadata for the session, including its absolute filesystem path when available.final recordIdentifies the target session.final recordWorkspace checkpoints in chronological order; empty when the workspace is not enabled.final recordIdentifies the target session.final recordRelative paths of files stored in the session workspace files directory.final recordCheckpoint number to read.final recordCheckpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.final recordRelative path of the workspace file to read.final recordContents of the requested workspace file as a UTF-8 string.final recordPasted content to save as a UTF-8 file in the session workspace.final recordDescriptor for the saved paste file, or null when the workspace is unavailable.Methods in com.github.copilot.generated.rpc with annotations of type CopilotExperimentalModifier and TypeMethodDescriptionSessionRpc.abort(SessionAbortParams params) Parameters for aborting the current turnSessionHistoryApi.abortManualCompaction()Identifies the target session.SessionMetadataApi.activity()Identifies the target session.ServerPluginsMarketplacesApi.add(PluginsMarketplacesAddParams params) Marketplace source to register.SessionPermissionsPathsApi.add(SessionPermissionsPathsAddParams params) Directory path to add to the session's allowed directories.SessionPermissionsLocationsApi.addToolApproval(SessionPermissionsLocationsAddToolApprovalParams params) Location-scoped tool approval to persist.SessionPermissionsFolderTrustApi.addTrusted(SessionPermissionsFolderTrustAddTrustedParams params) Folder path to add to trusted folders.SessionPermissionsLocationsApi.apply(SessionPermissionsLocationsApplyParams params) Working directory to load persisted location permissions for.ServerPluginsMarketplacesApi.browse(PluginsMarketplacesBrowseParams params) Name of the marketplace whose plugin catalog to fetch.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.SessionTasksApi.cancel(SessionTasksCancelParams params) Identifier of the background task to cancel.SessionHistoryApi.cancelBackgroundCompaction()Identifies the target session.SessionMcpApi.cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params) The requestId previously passed to executeSampling that should be cancelled.SessionShellApi.cancelUserRequested(SessionShellCancelUserRequestedParams params) User-requested shell execution cancellation handle.ServerSessionsApi.checkInUse(SessionsCheckInUseParams params) Session IDs to test for live in-use locks.SessionQueueApi.clear()Identifies the target session.ServerSessionsApi.close()Session ID to close.SessionCanvasApi.close(SessionCanvasCloseParams params) Canvas close parameters.SessionHistoryApi.compact()Optional compaction parameters.SessionPermissionsApi.configure(SessionPermissionsConfigureParams params) Patch of permission policy fields to apply (omit a field to leave it unchanged).SessionMcpApi.configureGitHub(SessionMcpConfigureGitHubParams params) Opaque auth info used to configure GitHub MCP.ServerSessionsApi.configureSessionExtensions(SessionsConfigureSessionExtensionsParams params) Params to attach or detach an in-process ExtensionController delegate.ServerSessionsApi.connect()Remote session connection parameters.SessionMetadataApi.contextInfo(SessionMetadataContextInfoParams params) Model identifier and token limits used to compute the context-info breakdown.SessionWorkspacesApi.createFile(SessionWorkspacesCreateFileParams params) Relative path and UTF-8 content for the workspace file to create or overwrite.SessionPlanApi.delete()Identifies the target session.SessionAgentApi.deselect()Identifies the target session.SessionMcpAppsApi.diagnose(SessionMcpAppsDiagnoseParams params) MCP server to diagnose MCP Apps wiring for.SessionWorkspacesApi.diff(SessionWorkspacesDiffParams params) Parameters for computing a workspace diff.ServerPluginsApi.disable(PluginsDisableParams params) Plugin names (or specs) to disable.SessionExtensionsApi.disable(SessionExtensionsDisableParams params) Source-qualified extension identifier to disable for the session.SessionMcpApi.disable(SessionMcpDisableParams params) Name of the MCP server to disable for the session.SessionRemoteApi.disable()Identifies the target session.SessionSkillsApi.disable(SessionSkillsDisableParams params) Name of the skill to disable for the session.ServerAgentsApi.discover(AgentsDiscoverParams params) Optional project paths to include in agent discovery.ServerInstructionsApi.discover(InstructionsDiscoverParams params) Optional project paths to include in instruction discovery.SessionUiApi.elicitation(SessionUiElicitationParams params) Prompt message and JSON schema describing the form fields to elicit from the user.ServerPluginsApi.enable(PluginsEnableParams params) Plugin names (or specs) to enable.SessionExtensionsApi.enable(SessionExtensionsEnableParams params) Source-qualified extension identifier to enable for the session.SessionMcpApi.enable(SessionMcpEnableParams params) Name of the MCP server to enable for the session.SessionRemoteApi.enable(SessionRemoteEnableParams params) Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.SessionSkillsApi.enable(SessionSkillsEnableParams params) Name of the skill to enable for the session.SessionCommandsApi.enqueue(SessionCommandsEnqueueParams params) Slash-prefixed command string to enqueue for FIFO processing.ServerSessionsApi.enrichMetadata(SessionsEnrichMetadataParams params) Session metadata records to enrich with summary and context information.SessionSkillsApi.ensureLoaded()Identifies the target session.SessionUiApi.ephemeralQuery(SessionUiEphemeralQueryParams params) Transient question to answer without adding it to conversation history.SessionShellApi.exec(SessionShellExecParams params) Shell command to run, with optional working directory and timeout in milliseconds.SessionCommandsApi.execute(SessionCommandsExecuteParams params) Slash command name and argument string to execute synchronously.SessionMcpApi.executeSampling(SessionMcpExecuteSamplingParams params) Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.SessionShellApi.executeUserRequested(SessionShellExecuteUserRequestedParams params) User-requested shell command and cancellation handle.ServerSessionsApi.findByPrefix(SessionsFindByPrefixParams params) UUID prefix to resolve to a unique session ID.ServerSessionsApi.findByTaskId(SessionsFindByTaskIdParams params) GitHub task ID to look up.ServerSessionsApi.fork(SessionsForkParams params) Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.SessionModeApi.get()Identifies the target session.SessionNameApi.get()Identifies the target session.SessionPermissionsApi.getAllowAll()No parameters.ServerSessionsApi.getBoardEntryCount()Session ID whose board entry count should be returned.SessionAgentApi.getCurrent()Identifies the target session.SessionModelApi.getCurrent()Identifies the target session.SessionToolsApi.getCurrentMetadata()Identifies the target session.SessionTasksApi.getCurrentPromotable()Identifies the target session.SessionTelemetryApi.getEngagementId()Identifies the target session.ServerSessionsApi.getEventFilePath()Session ID whose event-log file path to compute.SessionMcpAppsApi.getHostContext()Identifies the target session.SessionSkillsApi.getInvoked()Identifies the target session.ServerSessionsApi.getLastForContext(SessionsGetLastForContextParams params) Optional working-directory context used to score session relevance.SessionUsageApi.getMetrics()Identifies the target session.ServerSessionsApi.getPersistedRemoteSteerable()Session ID to look up the persisted remote-steerable flag for.SessionTasksApi.getProgress(SessionTasksGetProgressParams params) Identifier of the background task to fetch progress for.ServerSessionsApi.getRemoteControlStatus()Wrapper for the singleton's current status.ServerSessionsApi.getSizes()Map of sessionId -> on-disk size in bytes for each session's workspace directory.SessionInstructionsApi.getSources()Identifies the target session.SessionAuthApi.getStatus()Identifies the target session.SessionWorkspacesApi.getWorkspace()Identifies the target session.SessionUiApi.handlePendingAutoModeSwitch(SessionUiHandlePendingAutoModeSwitchParams params) Request ID of a pending `auto_mode_switch.requested` event and the user's response.SessionCommandsApi.handlePendingCommand(SessionCommandsHandlePendingCommandParams params) Pending command request ID and an optional error if the client handler failed.SessionUiApi.handlePendingElicitation(SessionUiHandlePendingElicitationParams params) Pending elicitation request ID and the user's response (accept/decline/cancel + form values).SessionUiApi.handlePendingExitPlanMode(SessionUiHandlePendingExitPlanModeParams params) Request ID of a pending `exit_plan_mode.requested` event and the user's response.SessionPermissionsApi.handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams params) Pending permission request ID and the decision to apply (approve/reject and scope).SessionUiApi.handlePendingSampling(SessionUiHandlePendingSamplingParams params) Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).SessionToolsApi.handlePendingToolCall(SessionToolsHandlePendingToolCallParams params) Pending external tool call request ID, with the tool result or an error describing why it failed.SessionUiApi.handlePendingUserInput(SessionUiHandlePendingUserInputParams params) Request ID of a pending `user_input.requested` event and the user's response.SessionLspApi.initialize(SessionLspInitializeParams params) Parameters for (re)loading the merged LSP configuration set.SessionToolsApi.initializeAndValidate()Identifies the target session.ServerPluginsApi.install(PluginsInstallParams params) Plugin source and optional working directory for relative-path resolution.SessionCanvasActionApi.invoke(SessionCanvasActionInvokeParams params) Canvas action invocation parameters.SessionCommandsApi.invoke(SessionCommandsInvokeParams params) Slash command name and optional raw input string to invoke.SessionPermissionsPathsApi.isPathWithinAllowedDirectories(SessionPermissionsPathsIsPathWithinAllowedDirectoriesParams params) Path to evaluate against the session's allowed directories.SessionPermissionsPathsApi.isPathWithinWorkspace(SessionPermissionsPathsIsPathWithinWorkspaceParams params) Path to evaluate against the session's workspace (primary) directory.SessionMetadataApi.isProcessing()Identifies the target session.SessionMcpApi.isServerRunning(SessionMcpIsServerRunningParams params) Server name to check running status for.SessionPermissionsFolderTrustApi.isTrusted(SessionPermissionsFolderTrustIsTrustedParams params) Folder path to check for trust.SessionShellApi.kill(SessionShellKillParams params) Identifier of a process previously returned by "shell.exec" and the signal to send.ServerPluginsApi.list()Plugins installed in user/global state.ServerPluginsMarketplacesApi.list()All registered marketplaces, including built-in defaults.ServerSessionsApi.list()Optional source filter, metadata-load limit, and context filter applied to the returned sessions.SessionAgentApi.list()Identifies the target session.SessionCanvasApi.list()Identifies the target session.SessionCommandsApi.list()Optional filters controlling which command sources to include in the listing.SessionExtensionsApi.list()Identifies the target session.SessionMcpApi.list()Identifies the target session.SessionModelApi.list()Optional listing options.SessionPermissionsPathsApi.list()No parameters; returns the session's allow-listed directories.SessionPluginsApi.list()Identifies the target session.SessionScheduleApi.list()Identifies the target session.SessionSkillsApi.list()Identifies the target session.SessionTasksApi.list()Identifies the target session.SessionWorkspacesApi.listCheckpoints()Identifies the target session.SessionWorkspacesApi.listFiles()Identifies the target session.SessionCanvasApi.listOpen()Identifies the target session.SessionMcpApi.listTools(SessionMcpListToolsParams params) Server name whose tool list should be returned.SessionMcpAppsApi.listTools(SessionMcpAppsListToolsParams params) MCP server to list app-callable tools for.ServerSessionsApi.loadDeferredRepoHooks()Active session ID whose deferred repo-level hooks should be loaded.SessionRpc.log(SessionLogParams params) Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.SessionMcpOauthApi.login(SessionMcpOauthLoginParams params) Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, and the callback success-page copy.SessionPermissionsApi.modifyRules(SessionPermissionsModifyRulesParams params) Scope and add/remove instructions for modifying session- or location-scoped permission rules.SessionPermissionsApi.notifyPromptShown(SessionPermissionsNotifyPromptShownParams params) Notification payload describing the permission prompt that the client just rendered.SessionRemoteApi.notifySteerableChanged(SessionRemoteNotifySteerableChangedParams params) New remote-steerability state to persist as a `session.remote_steerable_changed` event.ServerSessionsApi.open()Open a session by creating, resuming, attaching, connecting to a remote, or handing off.SessionCanvasApi.open(SessionCanvasOpenParams params) Canvas open parameters.SessionQueueApi.pendingItems()Identifies the target session.SessionPermissionsApi.pendingRequests()No parameters; returns currently-pending permission requests for the session.ServerSessionsApi.pollSpawnedSessions()Cursor and optional long-poll wait for polling runtime-spawned sessions.SessionTasksApi.promoteCurrentToBackground()Identifies the target session.SessionTasksApi.promoteToBackground(SessionTasksPromoteToBackgroundParams params) Identifier of the task to promote to background mode.ServerSessionsApi.pruneOld(SessionsPruneOldParams params) Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).SessionEventLogApi.read(SessionEventLogReadParams params) Cursor, batch size, and optional long-poll/filter parameters for reading session events.SessionPlanApi.read()Identifies the target session.SessionWorkspacesApi.readCheckpoint(SessionWorkspacesReadCheckpointParams params) Checkpoint number to read.SessionWorkspacesApi.readFile(SessionWorkspacesReadFileParams params) Relative path of the workspace file to read.SessionMcpAppsApi.readResource(SessionMcpAppsReadResourceParams params) MCP server and resource URI to fetch.SessionPlanApi.readSqlTodos()Identifies the target session.SessionMetadataApi.recomputeContextTokens(SessionMetadataRecomputeContextTokensParams params) Model identifier to use when re-tokenizing the session's existing messages.SessionMetadataApi.recordContextChange(SessionMetadataRecordContextChangeParams params) Updated working-directory/git context to record on the session.ServerPluginsMarketplacesApi.refresh()Optional marketplace name; omit to refresh all.SessionTasksApi.refresh()Identifies the target session.SessionUiApi.registerDirectAutoModeSwitchHandler()Identifies the target session.ServerSessionsApi.registerExtensionToolsOnSession(SessionsRegisterExtensionToolsOnSessionParams params) Params to attach an extension loader's tools to a session.SessionMcpApi.registerExternalClient(SessionMcpRegisterExternalClientParams params) Registration parameters for an external MCP client.SessionEventLogApi.registerInterest(SessionEventLogRegisterInterestParams params) Event type to register consumer interest for, used by runtime gating logic.SessionEventLogApi.releaseInterest(SessionEventLogReleaseInterestParams params) Opaque handle previously returned by `registerInterest` to release.ServerSessionsApi.releaseLock()Session ID whose in-use lock should be released.SessionAgentApi.reload()Identifies the target session.SessionExtensionsApi.reload()Identifies the target session.SessionMcpApi.reload()Identifies the target session.SessionPluginsApi.reload()Optional flags controlling which side effects the reload performs.SessionSkillsApi.reload()Identifies the target session.ServerSessionsApi.reloadPluginHooks(SessionsReloadPluginHooksParams params) Active session ID and an optional flag for deferring repo-level hooks until folder trust.SessionMcpApi.reloadWithConfig(SessionMcpReloadWithConfigParams params) Opaque MCP reload configuration.ServerPluginsMarketplacesApi.remove(PluginsMarketplacesRemoveParams params) Name of the marketplace to remove and an optional force flag.SessionTasksApi.remove(SessionTasksRemoveParams params) Identifier of the completed or cancelled task to remove from tracking.SessionMcpApi.removeGitHub()Identifies the target session.SessionQueueApi.removeMostRecent()Identifies the target session.SessionPermissionsApi.resetSessionApprovals()No parameters; clears all session-scoped tool permission approvals.SessionPermissionsLocationsApi.resolve(SessionPermissionsLocationsResolveParams params) Working directory to resolve into a location-permissions key.SessionMcpOauthApi.respond(SessionMcpOauthRespondParams params) MCP OAuth request id and optional provider response.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).SessionMcpApi.restartServer(SessionMcpRestartServerParams params) Server name and opaque configuration for an individual MCP server restart.ServerSessionsApi.save()Session ID whose pending events should be flushed to disk.SessionWorkspacesApi.saveLargePaste(SessionWorkspacesSaveLargePasteParams params) Pasted content to save as a UTF-8 file in the session workspace.SessionAgentApi.select(SessionAgentSelectParams params) Name of the custom agent to select for subsequent turns.SessionRpc.send(SessionSendParams params) Parameters for sending a user message to the sessionSessionExtensionsApi.sendAttachmentsToMessage(SessionExtensionsSendAttachmentsToMessageParams params) Parameters for session.extensions.sendAttachmentsToMessage.SessionTasksApi.sendMessage(SessionTasksSendMessageParams params) Identifier of the target agent task, message content, and optional sender agent ID.SessionModeApi.set(SessionModeSetParams params) Agent interaction mode to apply to the session.SessionNameApi.set(SessionNameSetParams params) New friendly name to apply to the session.ServerSessionsApi.setAdditionalPlugins(SessionsSetAdditionalPluginsParams params) Manager-wide additional plugins to register; replaces any previously-configured set.SessionPermissionsApi.setAllowAll(SessionPermissionsSetAllowAllParams params) Whether to enable full allow-all permissions for the session.SessionPermissionsApi.setApproveAll(SessionPermissionsSetApproveAllParams params) Allow-all toggle for tool permission requests, with an optional telemetry source.SessionNameApi.setAuto(SessionNameSetAutoParams params) Auto-generated session summary to apply as the session's name when no user-set name exists.SessionAuthApi.setCredentials(SessionAuthSetCredentialsParams params) New auth credentials to install on the session.SessionMcpApi.setEnvValueMode(SessionMcpSetEnvValueModeParams params) Mode controlling how MCP server env values are resolved (`direct` or `indirect`).SessionTelemetryApi.setFeatureOverrides(SessionTelemetrySetFeatureOverridesParams params) Feature override key/value pairs to attach to subsequent telemetry events from this session.SessionMcpAppsApi.setHostContext(SessionMcpAppsSetHostContextParams params) Host context to advertise to MCP App guests.SessionModelApi.setReasoningEffort(SessionModelSetReasoningEffortParams params) Reasoning effort level to apply to the currently selected model.ServerSessionsApi.setRemoteControlSteering(SessionsSetRemoteControlSteeringParams params) Patch for the singleton's steering state.SessionPermissionsApi.setRequired(SessionPermissionsSetRequiredParams params) Toggles whether permission prompts should be bridged into session events for this client.SessionPermissionsUrlsApi.setUnrestrictedMode(SessionPermissionsUrlsSetUnrestrictedModeParams params) Whether the URL-permission policy should run in unrestricted mode.SessionMetadataApi.setWorkingDirectory(SessionMetadataSetWorkingDirectoryParams params) Absolute path to set as the session's new working directory.SessionRpc.shutdown(SessionShutdownParams params) Parameters for shutting down the sessionSessionMetadataApi.snapshot()Identifies the target session.ServerAgentRegistryApi.spawn(AgentRegistrySpawnParams params) Inputs to spawn a managed-server child via the controller's spawn delegate.SessionFleetApi.start(SessionFleetStartParams params) Optional user prompt to combine with the fleet orchestration instructions.SessionTasksApi.startAgent(SessionTasksStartAgentParams params) Agent type, prompt, name, and optional description and model override for the new task.ServerSessionsApi.startRemoteControl(SessionsStartRemoteControlParams params) Parameters for attaching the remote-control singleton to a session.SessionMcpApi.startServer(SessionMcpStartServerParams params) Server name and opaque configuration for an individual MCP server start.SessionScheduleApi.stop(SessionScheduleStopParams params) Identifier of the scheduled prompt to remove.ServerSessionsApi.stopRemoteControl()Parameters for stopping the remote-control singleton.SessionMcpApi.stopServer(SessionMcpStopServerParams params) Server name for an individual MCP server stop.SessionHistoryApi.summarizeForHandoff()Identifies the target session.SessionRpc.suspend()Identifies the target session.SessionModelApi.switchTo(SessionModelSwitchToParams params) Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.SessionEventLogApi.tail()Identifies the target session.ServerSessionsApi.transferRemoteControl(SessionsTransferRemoteControlParams params) Parameters for atomically rebinding the remote-control singleton.SessionHistoryApi.truncate(SessionHistoryTruncateParams params) Identifier of the event to truncate to; this event and all later events are removed.ServerPluginsApi.uninstall(PluginsUninstallParams params) Name (or spec) of the plugin to uninstall.SessionUiApi.unregisterDirectAutoModeSwitchHandler(SessionUiUnregisterDirectAutoModeSwitchHandlerParams params) Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.SessionMcpApi.unregisterExternalClient(SessionMcpUnregisterExternalClientParams params) Server name identifying the external client to remove.ServerPluginsApi.update(PluginsUpdateParams params) Name (or spec) of the plugin to update.SessionOptionsApi.update(SessionOptionsUpdateParams params) Patch of mutable session options to apply to the running session.SessionPlanApi.update(SessionPlanUpdateParams params) Replacement contents to write to the session plan file.ServerPluginsApi.updateAll()Result of updating all installed plugins.SessionPermissionsPathsApi.updatePrimary(SessionPermissionsPathsUpdatePrimaryParams params) Directory path to set as the session's new primary working directory.SessionTasksApi.waitForPending()Identifies the target session.