Uses of Package
com.github.copilot.generated.rpc
Packages that use com.github.copilot.generated.rpc
Package
Description
Core classes for the GitHub Copilot SDK for Java.
Auto-generated RPC parameter and result types for the GitHub Copilot SDK.
Configuration classes and data transfer objects for the Copilot SDK.
-
Classes in com.github.copilot.generated.rpc used by com.github.copilotClassDescriptionGitHub Mission Control registration options.Local WebSocket transport options.The existing runtime identity and its resource on the listener.Open canvas instance snapshot.Typed client for server-level RPC methods.Immediate acknowledgement and Auto preference snapshot after a switch request.Typed client for session-scoped RPC methods.
-
Classes in com.github.copilot.generated.rpc used by com.github.copilot.generated.rpcClassDescriptionFinite reason code describing why the current turn was abortedAuthenticated account entry returned by `account.getAllUsers`.Current authentication stateRequest parameters for the
account.getQuotaRPC method.Quota usage snapshots for the resolved user, keyed by quota type.The provider kind stamped on a signed-in account.Credentials to validate and store.Result of a successful login; throws on failureUser to log outLogout result indicating if more users remainQuota usage snapshot for a Copilot quota type, including entitlement, used requests, overage, reset date, and remaining percentage.OneAuth token request supplied by a trusted host application.One signed-in account in the roster forest.Resolved Anthropic adaptive-thinking capability for a model.Canonical directory where custom agents can be discovered or created, with scope, preference, and optional project path.Which tier this directory belongs toAgent metadata, including identifiers, display details, source, tools, model, models, reasoning effort, MCP servers, skills, and file path.Where the agent definition was loaded fromWhether configured models are advisory preferences or required constraintsFull registry entry for the spawned child.Kind of attention required when status === "attention".Process kind tag for the registry entryHow the most recent turn ended (clean vs aborted).Coarse lifecycle status of the foreground sessionCanonical process-log discovery outcome; populated from spawnLiveTarget.Categorized reason no canonical process log could be openedInputs to spawn a managed-server child via the controller's spawn delegate.Permission posture for the new session.Outcome of an agentRegistry.spawn call.Which parameter field was invalid.Categorized reason for the rejection.Optional project paths to include in agent discovery.Agents discovered across user, project, plugin, and remote sources.Optional project paths to include when enumerating agent discovery directories.Canonical locations where custom agents can be created so the runtime will recognize them.The enumerated collection, keyed by the same selector as the query.Authentication credentials accepted only at native protocol ingress.Authentication typeTerminal result of an interactive login flow.Terminal disposition of a login persistence attempt.One step in an interactive login flow.The read result, keyed by the same selector as the query.Neutral authentication status summary.Validation error from an authentication attempt.Current per-window credit limit and consumption for an autopilot objective.Public, persistence-independent projection of an autopilot objective.Current normalized autopilot objective lifecycle status.Routing preference used when the session model is `auto`.A well-known model in the runtime's built-in catalog.Rust-owned metadata and input schema for a built-in tool.Custom grammar input format accepted by a built-in tool.Custom input-format kind.JSON Schema object accepted by a built-in tool.Root JSON Schema type for a built-in tool input.Canvas action that the agent or host can invoke.Host context supplied by the runtime.Host capabilitiesSession context supplied by the runtime.Options scoped to the built-in CAPI (Copilot API) provider.Semantic digest of a strictly parsed and schema-validated JSON MCP card.Canonical digest algorithm for a validated MCP cardWhere and when an Agent Plugin catalog reference was observed.Explicit Agent Plugin compatibility declared by exact catalog tags.Canonical Agent Plugin media typeWhere and when an AI skill catalog reference was observed.Typed installability state for an AI skill candidateCanonical AI skill media typeWhy the catalog authority did not accept the caller's identityOne inert catalog result, represented as an MCP server, discovery-only AI skill, or opt-in Agent Plugin variant so kind, media type, provenance, and available operations cannot contradict each other.What kind of resource a catalog candidate describesWhere a candidate's card came from.A wire feature a caller can require of the catalog surface, negotiated per request.The protocol version and capability set a caller requires, supplied on every catalog request so negotiation cannot be skipped by omission.Which wire-contract rule an upstream response brokeWhy a presented handle was rejectedWhich kind of opaque handle was presentedWhich request field was rejected locally or by the catalog authorityHow a card failed validationWhere and when an MCP server catalog reference was observed.Whether an MCP server candidate can be planned for installationMedia type a catalog card is interpreted asThe protocol version and capability set the runtime actually honoured for a successful catalog operation.Why capability and protocol-version negotiation refused a callerCategorised network failure, low cardinality so it can be aggregated without carrying a URLWhy a discoverable candidate cannot be installedSyntactically validated GitHub repository provenance declared by catalog metadata.An explicit numbered-page request.Authority-reported navigation metadata, returned only to callers requiring catalog-search-pagination and only when a supported token is present.A bounded catalog search.A bounded catalog search.Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal.Relationship of the backend-reported count to the complete query result set.Terminal outcome declared for a retained catalog selection groupTyped outcome of catalog.select.Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.Authority-computed exposure eligibility, kept separate from tier.Where and when the runtime observed the trust metadata.A versioned, bounded trust observation carried unchanged with a catalog candidate and its private handle context.Schema version of the catalogue trust snapshot envelopeBounded authority that supplied a catalogue trust observationService-computed trust tier currently emitted by Agent Finder.Why a catalog operation is not available on this runtimeWhy no usable transport could be offeredWhich hardened-fetch control refused a retrievalClient-owned, case-sensitive string metadata persisted with a local session.Why the runtime requests client-task cancellation.Whether a pending slash-command invocation effect was applied or cancelled by the host.Slash commands available in the session, after applying any include/exclude filters.Identity of the integrating host, declared once on the `server.connect` handshake so telemetry from this connection is attributed to a single, consistent surface.Metadata for a connected remote session.Neutral SDK discriminator for the connected remote session kind.Repository associated with the connected remote session.Account-targeted authorization update required by the Connector service.Stable OAuth scope whose absence prevents Connector management.Availability of the EXPERIMENTAL session connector API.Credential-free Connector catalog entry.Validated Connector catalog snapshot cached by the session.Authoritative service connection state for one Connector.Typed result of initiating or continuing a Connector connection.Live MCP status of one Connector-owned runtime server.Live status of one session-owned MCP projection.Authoritative session connector state.Connection-level opt-ins for the `server.connect` handshake.Handshake result reporting the server's protocol version and package version on success.Content-exclusion decision for one requested path.A single large message currently in context.Context tier for models that support multiple context-window sizes.Snapshot of the authenticated user's Copilot subscription info, if known.Endpoint URLs from the raw Copilot `/copilot_internal/v2/token` user-response passthrough.Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries.Chat quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.Completions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.Premium-interactions quota snapshot from the raw Copilot user-response passthrough, with entitlement, overage, remaining quota, reset, and billing fields.The session's authoritative model snapshot.Lightweight metadata for a currently initialized session toolA file included in the session debug bundle.A caller-provided server-local file or directory to include in the debug bundle.Kind of caller-provided debug log entry.Built-in session diagnostics to include in the bundle.How a collected debug entry should be redacted before being staged.Destination kind that was written.An optional debug bundle entry that could not be included.Source category for a collected debug bundle entry.Whether the supplied diagnostic cursor remained within the retained buffer window.Session-scoped diagnostic threshold.Severity of an emitted diagnostic record.A supported diagnostic source.Typed diagnostic source configuration.Canvas available in the current session.Discovered extension metadata and persistent enablement state.Effective extension loading and agent-management modeInstalled plugin that contributes a discovered extension.Persisted extension discovery sourceOne server-discovered hook action from user, repository, plugin, or managed-policy configuration.MCP server discovered by `mcp.discover`, with config source, optional plugin source, transport type, and enabled state.Server transport type: stdio, http, sse (deprecated), or memoryIndicates whether the command was accepted into the local execution queue.Result of a OneAuth token acquisition.How far OneAuth may go to acquire the requested token.Hosting capabilities and session capacity advertised by an environment.GitHub Mission Control compute kind.Identify a user-managed Mission Control environment to delete.Identify a Mission Control environment to retrieve.Safe discovery information for the requested environment.Optional discovery filters supported by GitHub Mission Control.Environments visible to the authenticated caller and matching the supplied filters.Agent-scope filter: 'primary' returns only main-agent events plus events whose type starts with 'subagent.'Cursor status: 'ok' means the read succeeded against the requested history; 'expired' means the requested continuation is unavailable.Direction to page through the session's persisted event history.Discovered extension metadata, including source-qualified ID, name, discovery source, status, and optional process ID.Opaque integrator-owned process launch profile for one extension entrypoint.Source-qualified extension identifiers to persistently disable for future sessions.Extensions discovered from persisted Copilot home state and their effective loading mode.Source-qualified extension identifiers to persistently enable for future sessions.Discovery source: project (.github/extensions/), user (~/.copilot/extensions/), plugin (installed plugin), or session (session-state//extensions/) Current status: running, disabled, failed, or startingBinary result returned by a tool for the modelBinary result type discriminator.Safe discovery information.Client environment metadata describing the process that produced a telemetry event.A single telemetry event in the runtime's native GitHub-shaped telemetry format, forwarded verbatim to opted-in hosts.Why the runtime is requesting a GitHub credential.SDK host response to a GitHub credential request.Post-compaction context window usage breakdownReason a captured file was not restored.Aggregate file change represented by a rewind preview.A file that a conversation-and-files rewind would restore.Scope of a rewind operation.Outcome of a rewind request.A root user turn that the session can rewind to.Reason a rewind read (rewind points, file-restore preview, or session diff) could not be answered from the session's file-change captures.A captured file that rewind intentionally left unchanged.Configuration tier that contributed a discovered hook action.Optional project paths and host-exclusion behavior for server-scoped hook discovery.Server-discovered hook actions and partial-load diagnostics from user, repository, plugin, and managed-policy sources.Hook event name.Stops a connection-owned listener and joins its teardown.GitHub Mission Control registration options.Normalized local WebSocket listener settings.Local WebSocket transport options.Publishes a resident session attached to the listener's owning connection.The existing runtime identity and its resource on the listener.Starts a supervised AHP host with at least one explicitly selected transport.Listener readiness, returned only after binding and the supervised participant's SDK handshake.Live indexed-search state for this session activation, never inferred from persisted history.Catalogue identity retained from a bound candidate or plan at installation time.Explicit user decisions, never inferred from a permission grant or model response.Only resource kinds with an implemented installation engine have a review variant.Installed plugin record from global state, with marketplace, version, install time, enabled state, cache path, and source.Information about an installed plugin tracked in global state.Canonical file or directory where custom instructions can be discovered or created, with location, kind, preference, and project path.Whether the target is a single file or a directory of instruction filesWhich tier this target belongs toOptional project paths to include in instruction discovery.Instruction sources discovered across user, repository, and plugin sources.Optional project paths to include when enumerating instruction discovery targets.Canonical files and directories where custom instructions can be created so the runtime will recognize them.Loaded instruction source for a session, including path, content, category, location, applicability, and optional description.Where this source lives — used for UI groupingCategory of instruction source — used for merge logicA JSON Schema output contract.Transport the runtime would otherwise use for this request.Set to terminate the response with a transport-level failure.A response body chunk or terminal error.Whether the chunk was accepted.Response head.Whether the start frame was accepted.Indicates whether the calling client was registered as the LLM inference provider.Persisted local session metadata, including identifiers, timestamps, summary/name, client, context, detached state, and task ID.A provider a consumer may interactively sign in with.Non-secret host-managed HTTP MCP server configuration.Validated device-managed settings discovered before a session exists.Summary of which managed-settings channels contributed to the effective session policy.Registered marketplace summary.Plugin entry advertised by a marketplace.Per-marketplace refresh result, including marketplace name, success flag, and optional failure error.MCP server allowed by policy, with server name and optional PII-free explanatory note.Applies exactly one previously prepared operation on its original connection.One-use application of the exact retained removal plan.Capability negotiation snapshotWhat the server returned for this sessionCurrent host contextAllowed values for the `McpAppsHostContextDetailsAvailableDisplayMode` enumeration.Current display mode (SEP-1865)Platform type for responsive designUI theme preference per SEP-1865MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata.Host context advertised to MCP App guestsAllowed values for the `McpAppsSetHostContextDetailsAvailableDisplayMode` enumeration.Current display mode (SEP-1865)Platform type for responsive designUI theme preference per SEP-1865MCP server name and configuration to add to user configuration.MCP server names to disable for new sessions.MCP server names to enable for new sessions.User-configured MCP servers, keyed by server name.MCP server name to remove from user configuration.MCP server name and replacement configuration to write to user configuration.MCP-specific detail for a source-discriminated diagnostic entry.Direction of an observed MCP protocol frame.Category for an MCP diagnostic record.MCP diagnostic source configuration.Optional working directory used as context for MCP server discovery.MCP servers discovered from user, workspace, plugin, and built-in sources.Structured MCP elicitation mode.Raw MCP CreateMessageRequest params, as received in the `sampling.requested` event.MCP CreateMessageResult payload (with optional 'tools' extension), present when action='success'.MCP server whose connection attempt failed.MCP server filtered by policy, with name, reason, and optional redacted reason.Host-level state, omitted when no MCP host is initialized.Bounded refusal categories, without echoing handles, credentials or configuration.One Registry string-valued configuration entry for the selected transport.Read-only or recovery management result, never permission to activate or replay.Management result with contract receipt, or a typed request/negotiation refusal.Status snapshot from the original connection, independent of new-work account availability.Final remote configuration, not a template.An installation result together with the exact honoured contract, or a negotiation refusal.Safe MCP review fields.Existing-operation control.A request-local value for one exact reviewed placeholder.Explicit backend selection is part of the final review; failures never switch backends.New-work inventory or recovery request under an explicitly selected existing session.New-work inventory or recovery request under an explicitly selected existing session.Existing-operation control.Configuration ownership and setup observations, distinct from tool permissions.Durable configuration ownership is distinct from session-specific usability.A normalised, inert description of what installing an MCP server would involve.OAuth grant type override for this login.Why a passive MCP OAuth probe determined authentication is needed.Passive MCP OAuth probe result.Outcome of starting the original prepared owned login.The configuration-change alternative for the transportChoices entry at the same index.Whether a planned configuration change would create or modify an entryA side-effect-free request for an MCP install plan.A side-effect-free request for an MCP install plan.Outcome of an mcp.planInstall call: either a normalised plan, or one typed refusal.Transport exposed by a locally launched packageWhat policy decided for a planned serverOutcome of evaluating the planned server against registry and enterprise policy.Which authority produced a policy decisionProvenance of the exact validated JSON MCP card content bound privately to a completed plan and its opaque handle.Transport exposed by a remote endpointNormalised identity of the MCP server a plan targets, independent of how the card spelled it.Configuration scope an MCP install plan targetsA secret a transport choice needs, referenced by placeholder.Where a plan would be written.One eligible way to run the server, represented as a tagged package or remote variant so package identity and endpoint states cannot contradict the install method.Read-only preparation of one owned removal under fresh selected-session authority.Where a required value is applied when the planned server is launchedInert, runtime-owned admission.Side-effect-free preparation of one original bound remote MCP choice.An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata.Standard MCP resource annotations plus preserved non-standard annotation fields.MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata.A resource icon descriptor plus preserved non-standard icon fields.An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata.Outcome of the sampling inference.MCP server status entry, including config source/plugin source and any connection error.JSON MCP card media type accepted for install planningRecorded MCP server connection failure.Server-advertised metadata learned through modern discovery or legacy initialization.Recorded MCP server pending-auth state.Owned installation that a listed MCP server's live configuration came from.Configuration source: user, workspace, plugin, builtin, or managedConnection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configuredHow environment-variable values supplied to MCP servers are resolved.Concrete configuration file containing an MCP server declaration.Plugin identity associated with an MCP server declaration.Canonical identity and location of the effective MCP server declaration.Metadata controlling an MCP task's lifetime.MCP tool metadata with tool name, optional description, and normalized MCP Apps discovery metadata.Normalized MCP Apps discovery metadata from a tool's `_meta.ui` block.Consumer allowed to call an MCP tool.Exact inert removal plan.Memory configuration for this session.The current agent mode for this session (e.g., 'interactive', 'plan', 'autopilot')Remote-session-specific metadata.The repository the remote session targets.Whether the remote task originated from Copilot Coding Agent (cca) or a CLI `--remote` invocation.Copilot model metadata, including identifier, display name, capabilities, policy, billing, reasoning efforts, and picker categories.Billing informationActive server-driven promotion for a model, including its discount and optional expiry.Token-level pricing information for this modelLong context tier pricing (available for models with extended context windows)Model capabilities and limitsToken limits for prompts, outputs, and context windowVision-specific limitsOptional capability overrides (vision, tool_calls, reasoning, etc.).Token limits for prompts, outputs, and context windowVision-specific limitsFeature flags indicating what the model supportsFeature flags indicating what the model supportsOrigin of an effective session model change.A service-published message about a model, carrying a stable machine-readable code alongside human-readable text.Model capability category for grouping in the model pickerRelative cost tier for token-based billing usersFilesystem and environment context used to resolve model-picker settings.Policy state (if applicable)Current policy state for this modelOne model provider available to the session — the model analog of the account `ProviderDescriptor`.The neutral kind of a model provider — the model analog of `AccountKind`.A neutral reference to the model provider that produced a model: an opaque id, a human-readable label, and the provider kind.The running runtime's complete catalog of well-known built-in model IDs, including supported models and additional IDs with built-in metadata.Request parameters for themodels.listRPC method.List of Copilot models available to the resolved user, including capabilities and billing metadata.Whether the requested preference was already effective or was accepted for later transactional activation.Service-published warning text that hosts should display when presenting a model.External SDK input for a named custom model provider.Open canvas instance snapshot.Content-exclusion policy supplied to `session.options.update`, with rules, last-updated data, and scope.Single content-exclusion rule supplied to `session.options.update`, with paths, match conditions, and source.Source descriptor for a `session.options.update` content-exclusion rule, with source name and type.Allowed values for the `OptionsUpdateAdditionalContentExclusionPolicyScope` enumeration.Context tier for models with tiered pricing.How env values are passed to MCP servers (`direct` inlines literal values; `indirect` resolves at launch).Reasoning summary mode for supported model clients.Controls how availableTools (allowlist) and excludedTools (denylist) combine when both are set.Pending permission prompt reconstructed from event history, with request ID and user-facing prompt details.Optional informational context describing how and where the permission decision was made.Disposition of a permission request as observed by the responding client.Controlled reason or actor responsible for a permission response.Client surface that submitted a permission response.Whether the location is a git repo or directoryCurrent or requested permission mode.Optional source for permission-mode telemetry.If specified, replaces the session's path-permission policy.Runtime handling applied to a recovery attemptControlled reason for an individual attempt dispositionRelationship of an attempt to earlier permission requestsAuthoritative snapshot of an Autopilot permission-recovery episodeAction selected when autonomous recovery cannot continueControlled reason for a permission-recovery episode transitionLifecycle state of a permission-recovery episodeResponse capability available to the client when it settled a permission request.A permission approval or denial rule matched against a tool request, identified by a rule kind with an optional argument value.If specified, replaces the session's approved/denied permission rules.Content-exclusion policy supplied to `session.permissions.configure`, with rules, last-updated data, and scope.Single content-exclusion rule supplied to `session.permissions.configure`, with paths, match conditions, and source.Source descriptor for a `session.permissions.configure` content-exclusion rule, with source name and type.Allowed values for the `PermissionsConfigureAdditionalContentExclusionPolicyScope` enumeration.Whether the change applies to ephemeral session-scoped rules (cleared at session end) or to location-scoped rules persisted via the location-permissions config file.Optional source for allow-all telemetry.If specified, replaces the session's URL-permission policy.Optional message to echo back to the caller.Server liveness response, including the echoed message, current server timestamp, and protocol version.A single dependency edge read from the session SQL `todo_deps` table, indicating that one todo must complete before another.A single todo row read from the session SQL `todos` table.Session plugin metadata, with name, marketplace, optional version, and enabled state.Where completed plugin content was staged before atomic promotion.Trusted built-in plugin directories to use for this runtime process.Plugin names (or specs) to disable, plus the optional working directory the repository-controlled guard is evaluated against.Plugin names (or specs) to enable, plus the optional working directory the repository-controlled guard is evaluated against.Plugin source and optional working directory for relative-path resolution.Result of installing a plugin.Plugins installed in user/global state.Marketplace source and optional working directory for relative-path resolution.Result of registering a new marketplace.Name of the marketplace whose plugin catalog to fetch.Plugins advertised by the marketplace.All registered marketplaces, including built-in defaults.Request parameters for theplugins.marketplaces.refreshRPC method.Result of refreshing one or more marketplace catalogs.Name of the marketplace to remove and an optional force flag.Outcome of the remove attempt, including dependent-plugin info when applicable.Name (or spec) of the plugin to uninstall.Result of updating all installed plugins.Name (or spec) of the plugin to update.Result of updating a single plugin.Per-plugin result from updating all plugins, with versions, skills installed, success flag, and optional error.Controls whether the runtime may defer loading an external tool definition.Serializable definition of a caller-implemented tool whose execution is handled over the SDK connection.Custom model-provider configuration (BYOK).Azure-specific provider options.Provider transport.Provider type.Wire API format (openai/azure only).A provider offered for interactive login.Transport to be used for provider requests.Provider family.Wire API to be used, when required for the provider type.A BYOK model definition referencing a named provider.Short-lived, rotating credential the caller must send on every request, in addition to `apiKey` if one is present.Serializable message fields accepted by queue.insertAt.User-facing pending queue entry, with kind and display text for a queued message, slash command, or model change.Whether this item is a queued user message or a queued slash command / model changeReasoning summary mode to request for supported model clientsWhat the user must do to recover from a failure, named as an action rather than as one client's affordance.Configuration for the runtime-managed remote-control singleton.Reattach to an existing MC session without creating a new one.What a remote host says one of its sessions is doing right now.GitHub repository the remote session belongs to.Whether the remote task originated from CCA or CLI `--remote`.Remote session metadata for the session to hand off (typically obtained from `sessions.list` with `source: "remote"`).Per-session remote mode.Repository context for the remote session.Interface for invoking JSON-RPC methods with typed responses.Resolved sandbox configuration.Credential-injection capability flags applied while the sandbox is enabled.Origin of the sandbox choice supplied by the host.User-managed sandbox policy fragment merged into the auto-discovered base policy.Platform-specific experimental policy fields.macOS seatbelt experimental options.Filesystem rules to merge into the base policy.Network rules to merge into the base policy.HTTP proxy configuration for sandboxed traffic.macOS seatbelt-specific options.Whole-value environment credential masking for sandboxed children.Whether the host running this runtime can run the command sandbox.Whether this host can run one sandbox policy feature.Destinations authorized to receive one masked environment credential.A session-scoped sandbox transition applied while handling a slash commandScheduled prompt entry with ID, timing (`intervalMs`, `cron`, or `at`), prompt text, recurrence, and next run time.Secret values to add to the redaction filter.Confirmation that the secret values were registered.The UI mode the agent was in when this message was sent.A single user message to append to the session as part of a `session.sendMessages` turnHow to deliver the message.API methods for theaccountnamespace.API methods for theaccountsnamespace.API methods for theagentRegistrynamespace.API methods for theagentsnamespace.API methods for thecatalognamespace.API methods for thecommandsnamespace.API methods for theenvironmentsnamespace.API methods for theextensionsnamespace.API methods for thehooksnamespace.API methods for thehostnamespace.API methods for theinstructionsnamespace.API methods for thellmInferencenamespace.API methods for themanagedSettingsnamespace.API methods for themcpnamespace.API methods for themcp.confignamespace.API methods for themcp.installationsnamespace.API methods for themodelsnamespace.API methods for thepluginsnamespace.API methods for theplugins.builtinnamespace.API methods for theplugins.marketplacesnamespace.API methods for theruntimenamespace.API methods for thesandboxnamespace.API methods for thesecretsnamespace.API methods for thesessionFsnamespace.API methods for thesessionsnamespace.Server-side skill metadata, including name, description, source, enabled/invocable state, path, project path, and argument hint.API methods for theskillsnamespace.API methods for theskills.confignamespace.API methods for theskills.installationsnamespace.API methods for thetoolsnamespace.API methods for theusernamespace.API methods for theuser.settingsnamespace.Parameters for aborting the current turnResult of aborting the current turnAPI methods for theaccountsnamespace.Enumerate request carrying the typed collection query.Read request carrying the typed datum query.Advance an in-flight login flow, optionally fulfilling an input-required step.API methods for theaccounts.loginnamespace.Begin an interactive login flow for a provider kind.A started login flow: its opaque id and first step.Cancel an in-flight login flow.Mutation request carrying the typed write command.Result of a non-interactive accounts mutation.API methods for theagentnamespace.The currently selected custom agent, or null when using the default agent.Request parameters for thesession.agent.listRPC method.Agents available to the session.Custom agents available to the session after reloading definitions from disk.Name of the custom agent to select for subsequent turns.The newly selected custom agent.An in-memory authored prompt override for an available agent.Authentication status and account metadata for the session.API methods for theautopilotObjectivenamespace.Canonical runtime state for the session's current autopilot objective.API methods for thecanvas.actionnamespace.Canvas action invocation parameters.Canvas action invocation result.API methods for thecanvasnamespace.Canvas close parameters.Live open-canvas snapshot.Declared canvases available in this session.Canvas open parameters.Open canvas instance snapshot.API methods for thecanvas.providernamespace.Internal canvas provider registration parameters.Internal canvas provider unregistration parameters.Session capability enabled for this sessionAPI methods for thecommandsnamespace.Slash-prefixed command string to enqueue for FIFO processing.Slash command name and argument string to execute synchronously.Error message produced while executing the command, if any.The pending slash-command invocation effect to finalize, plus whether the host applied or cancelled it.Whether finalizing the invocation effect succeeded, and the failure reason when it did not.Pending command request ID and an optional error if the client handler failed.Indicates whether the pending client-handled command was completed successfully.Slash command name and optional raw input string to invoke.Request parameters for thesession.commands.listRPC method.Slash commands available in the session, after applying any include/exclude filters.Queued-command request ID and the result indicating whether the host executed it (and whether to stop processing further queued commands).Indicates whether the queued-command response was matched to a pending request.A single host-driven completion.API methods for thecompletionsnamespace.Characters that, when typed in the composer, should trigger a `completions.request`.Request host-driven completions for the current composer input.Host-driven completion items for the current composer input.API methods for theconnectorsnamespace.Selects one Connector and the pinned host-owned account used for its service and MCP authorization.Explicitly bounded continuation of a pending Connector connection.Selects one Connector and the pinned host-owned account used for its service and MCP authorization.Authoritative result after disconnect and MCP reconciliation.Feature detection and hard polling limits for the EXPERIMENTAL session connector API.Authoritative session connector state.Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.Validated Connector catalog snapshot cached by the session.Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.Authoritative session connector state.Requests authoritative Connector-to-MCP reconciliation for the pinned account.Authoritative session connector state.Selects one Connector and the pinned host-owned account used for its service and MCP authorization.Pins a Connector operation to one host-owned GitHub account through its opaque selection ID.Validated Connector catalog snapshot cached by the session.Authoritative session connector state.API methods for thecontentExclusionnamespace.Local file system absolute paths within the session working directory to check against its content-exclusion policy.Batch content-exclusion result.Pre-resolved working-directory context for session startup.Repository host typeAPI methods for thecustomizationsnamespace.Diagnostics from reloading skill definitions, with warnings and errors as separate lists.API methods for thedebugnamespace.Options for collecting a session debug bundle with configurable redaction.Result of collecting a session debug bundle.API methods for thediagnosticsnamespace.Patch session diagnostic thresholds for explicitly supplied sources.Per-source session diagnostics configuration.Cursor-based request for session diagnostics.One cursor-addressed page of retained session diagnostics.API methods for theeventLognamespace.Cursor, batch size, and optional long-poll/filter parameters for reading session events.Batch of session events returned by a read, with cursor and continuation metadata.Event type to register consumer interest for, used by runtime gating logic.Opaque handle representing an event-type interest registration.Opaque handle previously returned by `registerInterest` to release.Indicates whether the operation succeeded.Snapshot of the current tail cursor without returning any events.API methods for theextensionsnamespace.Source-qualified extension identifier to disable for the session.Source-qualified extension identifier to enable for the session.Extensions discovered for the session, with their current status.Parameters for session.extensions.sendAttachmentsToMessage.API methods for thefleetnamespace.Parameters for starting fleet orchestration: an optional user prompt combined with the fleet instructions, plus the send options forwarded to the resulting turn.Indicates whether fleet mode was successfully activated.Describes a filesystem error.Error classificationDirectory entry returned by session filesystem `readdirWithTypes`, with name and entry type.Entry typeOptional capabilities declared by the providerPath conventions used by this filesystemInitial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.Indicates whether the calling client was registered as the session filesystem provider.Query results including rows, columns, and rows affected, or a filesystem error if execution failed.How to execute the query: 'exec' for DDL/multi-statement (no results), 'query' for SELECT (returns rows), 'run' for INSERT/UPDATE/DELETE (returns rowsAffected)Classified SQLite transaction failure. busyOrLocked guarantees rollback; postCommitAmbiguous must never be retried.SQLite transaction failure classification.One statement in an atomic SQLite transaction.API methods for thegitHubAuthnamespace.Authentication status and account metadata for the session.Internal GitHub login parameters.Parameters identifying a GitHub authentication to log out.New auth credentials to install on the session.Indicates whether the credential update succeeded.Parameters for switching the session's active authentication.Indicates whether an in-progress manual compaction was aborted.API methods for thehistorynamespace.Indicates whether an in-progress background compaction was cancelled.Parameters for clearing the conversation and seeding the window that replaces it.What a successful clear removed.Request parameters for thesession.history.compactRPC method.What initiated this compaction request, recorded as the `trigger` on the persisted `session.compaction_start` / `session.compaction_complete` events.Compaction outcome with the number of tokens and messages removed, summary text, and the resulting context window breakdown.Rewind points and file-change-tracking availability for the session.Event boundary to preview for conversation-and-files rewind.Files and aggregate changes for a prospective rewind.Boundary and mode for rewinding session history.Structured outcome of a rewind request.Markdown summary of the conversation context (empty when not available).Identifier of the event to truncate to; this event and all later events are removed.Number of events that were removed by the truncation.Installed plugin record for a session, with marketplace, version, install time, enabled state, cache path, and source.API methods for theinstructionsnamespace.Instruction sources loaded for the session, in merge order.Parameters for interrupting the main agent turn.Result of interrupting the main agent turn.API methods for thelimitPredictionnamespace.Baseline data provenance for a prediction.Client population used for the prediction baseline.Explainable AI-credit session-limit prediction.Request parameters for thesession.limitPrediction.predictRPC method.Prediction result.Baseline fallback level used to create the prediction.Semantic usage tier used for a recommended cap or additional headroom.Semantic usage tier and its AI-credit cap.Reason a prediction could not be computed.Optional session limits.Optional filter applied to the returned sessionsLog severity level.Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.Identifier of the session event that was emitted for the log message.API methods for thelspnamespace.Parameters for (re)loading the merged LSP configuration set.Enterprise permission policy expressed with the runtime's managed permission-rule syntax.Managed settings an SDK host may inject at session startup.API methods for themanagedSettingsnamespace.Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed.API methods for themcpnamespace.API methods for themcp.appsnamespace.MCP server, tool name, and arguments to invoke from an MCP App view.MCP server to diagnose MCP Apps wiring for.Diagnostic snapshot of MCP Apps wiring for the named server.Current host context advertised to MCP App guests.MCP server to list app-callable tools for.App-callable tools from the named MCP server.MCP server and resource URI to fetch.Resource contents returned by the MCP server.Host context to advertise to MCP App guests.The requestId previously passed to executeSampling that should be cancelled.Indicates whether an in-flight sampling execution with the given requestId was found and cancelled.Credential-free authentication identity used to configure GitHub MCP.Result of configuring GitHub MCP.Name of the MCP server to disable for the session.Name of the MCP server to disable for the session.Name of the MCP server to enable for the session.Name of the MCP server to enable for the session.Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.Outcome of an MCP sampling execution: success result, failure error, or cancellation.API methods for themcp.headersnamespace.MCP headers refresh request id and the host response.Indicates whether the pending MCP headers refresh response was accepted.Server name to check running status for.Whether the named MCP server is running.MCP servers configured for the session, with their connection status and host-level state.Server name whose tool list should be returned.Tools exposed by the connected MCP server.Result of moving in-flight MCP loading to the background.API methods for themcp.oauthnamespace.Identifies the MCP server whose persisted OAuth credentials were updated.Targets only the original prepared/applying owned login on this exact session requester.Honest terminal cancellation result; persistence or recovery failures remain RPC errors.Pending MCP OAuth request ID and host-provided token or cancellation response.Indicates whether the pending MCP OAuth response was accepted.Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.Remote MCP server name and optional overrides controlling reauthentication, OAuth client display name, callback success-page copy, and static OAuth client selection.OAuth authorization URL the caller should open, or empty when cached tokens already authenticated the server.Effect-free preparation bound to the existing local session, requester and installation, with frozen options.An inert runtime-issued login handle.Remote MCP server name for a passive OAuth status probe.Remote MCP server name for a passive OAuth status probe.Pending MCP OAuth request id to respond to.Indicates whether the pending MCP OAuth response was accepted.Registration parameters for an external MCP client.Opaque MCP reload configuration.MCP server startup filtering result.Indicates whether the auto-managed `github` MCP server was removed (false when nothing to remove).API methods for themcp.resourcesnamespace.MCP server whose resources to enumerate.One page of resources advertised by the named MCP server.MCP server whose resource templates to enumerate.One page of resource templates advertised by the named MCP server.MCP server and resource URI to fetch.Resource contents returned by the MCP server.Server name and optional replacement configuration for an individual MCP server restart.Server name and optional replacement configuration for an individual MCP server restart.Mode controlling how MCP server env values are resolved (`direct` or `indirect`).Env-value mode recorded on the session after the update.Server name and optional configuration for an individual MCP server start.Server name and optional configuration for an individual MCP server start.Server name for an individual MCP server stop.Server name for an individual MCP server stop.Server name identifying the external client to remove.Current activity flags for the session.API methods for themetadatanamespace.Model identifier and token limits used to compute the context-info breakdown.Token breakdown for the session's current context window, or null if uninitialized.Token-usage breakdown for the session's current context windowPer-source attribution breakdown for the session's current context window, or null if uninitialized.Per-source token attribution snapshot for the current context window.The six normalized `/context` header buckets, computed from the same tokenization as `entries` so the two never disagree.Successful compaction history for the session.Parameters for the heaviest-messages query.The heaviest individual messages in the session's context window, most-expensive first.Indicates whether the local session is currently processing a turn or background continuation.Model identifier to use when re-tokenizing the session's existing messages.Re-tokenize the session's existing messages against `modelId` and return the token totals.Updated working-directory/git context to record on the session.Absolute path to set as the session's new working directory.Update the session's working directory.Point-in-time snapshot of slow-changing session identifier and state fieldsPublic-facing projection of workspace metadata for SDK / TUI consumersAtomic patch for client-owned session metadata.The session mode the agent is operating inAPI methods for themodenamespace.API methods for themodelnamespace.Managed, repository, and CLI model overrides to overlay onto the session at startup.The model identifier active on the session after the switch.The session's authoritative model snapshot.Request parameters for thesession.model.listRPC method.The list of models available to this session.Cost-category metadata for a CAPI model.Host-supplied exact model selection IDs to allow for this running session.The applied host allowlist and effective session model policy after intersection.Reasoning effort level to apply to the currently selected model.Update the session's reasoning effort without changing the selected model.An Auto preference request for the session.Immediate acknowledgement and Auto preference snapshot after a switch request.Target model identifier and optional reasoning effort, summary, capability overrides, and context tier.The model identifier active on the session after the switch.Agent interaction mode to apply to the session.Outcome of a session mode change, including any model switch it triggered and follow-up the host must perform.API methods for thenamenamespace.The session's friendly name, or null when not yet set.Auto-generated session summary to apply as the session's name when no user-set name exists.Indicates whether the auto-generated summary was applied as the session's name.New friendly name to apply to the session.Session construction options.Content-exclusion policy supplied to `sessions.open` options, with rules, last-updated data, and scope.Single content-exclusion rule supplied to `sessions.open` options, with paths, match conditions, and source.Source descriptor for a `sessions.open` content-exclusion rule, with source name and type.Allowed values for the `SessionOpenOptionsAdditionalContentExclusionPolicyScope` enumeration.How MCP server environment values are interpreted.Initial reasoning summary mode for supported model clients.API methods for theoptionsnamespace.Patch of mutable session options to apply to the running session.Indicates whether the session options patch was applied successfully.API methods for thepermissionsnamespace.Patch of permission policy fields to apply (omit a field to leave it unchanged).Indicates whether the operation succeeded.Folder path to add to trusted folders.Indicates whether the operation succeeded.API methods for thepermissions.folderTrustnamespace.Folder path to check for trust.Folder trust check result.Current permission mode.Pending permission request ID and the decision to apply (approve/reject and scope).Indicates whether the permission decision was applied; false when the request was already resolved.Location-scoped tool approval to persist.Indicates whether the operation succeeded.API methods for thepermissions.locationsnamespace.Working directory to load persisted location permissions for.Summary of persisted location permissions applied to the session.Working directory to resolve into a location-permissions key.Resolved location-permissions key and type.Scope and add/remove instructions for modifying session- or location-scoped permission rules.Indicates whether the operation succeeded.Notification payload describing the permission prompt that the client just rendered.Indicates whether the operation succeeded.Directory path to add to the session's allowed directories.Indicates whether the operation succeeded.API methods for thepermissions.pathsnamespace.Path to evaluate against the session's allowed directories.Indicates whether the supplied path is within the session's allowed directories.Path to evaluate against the session's workspace (primary) directory.Indicates whether the supplied path is within the session's workspace directory.Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.Directory path to set as the session's new primary working directory.Indicates whether the operation succeeded.List of pending permission requests reconstructed from event history.Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.Indicates whether the operation succeeded.Allow-all toggle for tool permission requests, with an optional telemetry source.Indicates whether the operation succeeded.Permission mode to apply for the session.Indicates whether the requested permission mode was applied and reports the authoritative post-mutation mode.Toggles whether permission prompts should be bridged into session events for this client.Indicates whether the operation succeeded.API methods for thepermissions.urlsnamespace.Whether the URL-permission policy should run in unrestricted mode.Indicates whether the operation succeeded.API methods for theplannamespace.Existence, contents, and resolved path of the session plan file.Todo rows read from the session SQL database.Todo rows + dependency edges read from the session SQL database.Replacement contents to write to the session plan file.API methods for thepluginsnamespace.Plugin names (or specs) to disable in the session's authoritative working directory.Plugin names (or specs) to enable in the session's authoritative working directory.Plugin source resolved relative to the session's authoritative working directory.Result of installing a plugin.Plugins installed for the session, with their enabled state and version metadata.Marketplace source and optional working directory for relative-path resolution.Result of registering a new marketplace.API methods for theplugins.marketplacesnamespace.Name of the marketplace whose plugin catalog to fetch.Plugins advertised by the marketplace.All registered marketplaces, including built-in defaults.Request parameters for thesession.plugins.marketplaces.refreshRPC method.Result of refreshing one or more marketplace catalogs.Name of the marketplace to remove and an optional force flag.Outcome of the remove attempt, including dependent-plugin info when applicable.Request parameters for thesession.plugins.reloadRPC method.Name (or spec) of the plugin to uninstall.Name (or spec) of the plugin to update.Result of updating a single plugin.BYOK providers and/or models to add to the session's registry at runtime.The selectable model entries synthesized for the models added by this call.API methods for theprovidernamespace.Request parameters for thesession.provider.getEndpointRPC method.A snapshot of the provider endpoint the session is currently configured to talk to.Authoritative BYOK provider and model registry snapshot to apply atomically to the session.The selectable model entries and selection ids synthesized for the synchronized BYOK models.Host-managed model selection ids to withdraw from the session's BYOK registry.What the withdrawal actually removed from the registry.API methods for thequeuenamespace.Append to one pending steering message without changing its identity or delivery position.Result of editing a queued message.Inputs for starting a deferred-idle drain.Whether a deferred-idle drain should run.Internal filter for consuming queued system notifications.Indicates whether a user-facing pending item was removed.Inputs for marking session.idle deferred in native state.Parameters for duplicating a queued item.Result of duplicating a queued item.Result of enqueueing the resume-pending wake item.Inputs for completing a deferred-idle drain.Action selected by the native deferred-idle drain.Whether the native queue has pending work.Parameters for inserting a queued message at a public visible position.Result of inserting a queued message.Parameters for moving a queued item by stable id.Result of moving a queued item.Snapshot of the session's pending queued items and immediate-steering messages.Parameters for removing a queued item by stable id.Result of removing a queued item.Indicates whether a user-facing pending item was removed.Parameters for steering a queued message into a live turn.Result of trying to steer a queued message into a live turn.Parameters for acquiring or releasing the queued-lane drain pause.Internal snapshot of native queue state for local session orchestration.Parameters for editing a single queued message.Result of editing a queued message.Conditional withdrawal of a single user message, from its queue or from the running turn it started.Result of withdrawing a user message.API methods for theremotenamespace.Optional remote session mode ("off", "export", or "on"); defaults to enabling both export and remote steering.GitHub URL for the session and a flag indicating whether remote steering is enabled.New remote-steerability state to persist as a `session.remote_steerable_changed` event.API methods for thesandboxnamespace.Request to disable sandboxing for the current session while resolving an active sandbox-bypass permission prompt.Result of attempting to disable sandboxing for the current session.Managed sandbox enforcement state for a session.Request to accept the sandbox path grant offered on an active sandbox escalation permission prompt.Result of accepting a sandbox path grant.Session IDs to close, deactivate, and delete from disk.Map of sessionId -> bytes freed by removing the session's workspace directory.Session IDs to test for live in-use locks.Session IDs from the input set that are currently in use by another process.Register an absolute-time scheduled prompt.Result of registering or re-arming a scheduled prompt.Register a cron scheduled prompt.Result of registering or re-arming a scheduled prompt.Register a relative-interval scheduled prompt.Result of registering or re-arming a scheduled prompt.Register a self-paced scheduled prompt.Result of registering or re-arming a scheduled prompt.API methods for theschedulenamespace.Whether the session currently has an active self-paced schedule.Snapshot of the currently active recurring prompts for this session.Re-arm a self-paced scheduled prompt.Result of registering or re-arming a scheduled prompt.Identifier of the scheduled prompt to remove.Remove a scheduled prompt by id.Session ID to close.Params to attach or detach an in-process ExtensionController delegate.Remote session connection parameters.Remote session connection result.Session ID to delete from disk.Parameters for sending zero or more user messages to the session in a single turn.Result of sending zero or more user messagesParameters for sending a user message to the sessionResult of sending a user messageInternal request for sending a system notification.Session metadata records to enrich with summary and context information.The enriched metadata records, with summary and context fields backfilled where available.API methods for thesettingsnamespace.Availability of built-in job tools surfaced to boundary consumers.Named Rust-owned settings predicate to evaluate for this session.Result of evaluating a Rust-owned settings predicate.Redacted job settings for a session.Redacted model routing settings for a session.Online-evaluation settings safe to expose across the SDK boundary.Rust-owned settings predicates exposed across the SDK boundary.Redacted repository and GitHub host settings for a session.Redacted, serializable view of session runtime settings for SDK boundary consumers.Redacted validation and memory-tool settings for a session.UUID prefix to resolve to a unique session ID.Session ID matching the prefix, omitted when no unique match exists.GitHub task ID to look up.ID of the local session bound to the given GitHub task, or omitted when none.Source session identifier to fork from, optional event-ID boundary, and optional friendly name for the new session.Identifier and optional friendly name assigned to the newly forked session.Session ID whose board entry count should be returned.Dynamic-context board entry count, when available.Bounded batch request for client-owned metadata from persisted local sessions.Session ID whose event-log file path to compute.Absolute path to the session's events.jsonl file on disk.Optional working-directory context used to score session relevance.Most-relevant session ID for the supplied context, or omitted when no sessions exist.Session ID whose persisted metadata should be read.Persisted local session metadata when the session exists.Session ID to look up the persisted remote-steerable flag for.The session's persisted remote-steerable flag, or omitted when no value has been persisted.Wrapper for the singleton's current status.Map of sessionId -> on-disk size in bytes for each session's workspace directory.API methods for theshellnamespace.User-requested shell execution cancellation handle.Cancellation result for a user-requested shell command.Shell command to run, with optional working directory and timeout in milliseconds.Identifier of the spawned process, used to correlate streamed output and exit notifications.User-requested shell command and cancellation handle.Result of a user-requested shell command.Identifier of a process previously returned by "shell.exec" and the signal to send.Indicates whether the signal was delivered; false if the process was unknown or already exited.Parameters for shutting down the sessionAPI methods for theskillsnamespace.Name of the skill to disable for the session.Name of the skill to enable for the session.Skills invoked during this session, ordered by invocation time (most recent last).Skills available to the session, with their enabled state.Diagnostics from reloading skill definitions, with warnings and errors as separate lists.Limit for non-empty local session IDs.Recent local session IDs that contain user-visible history.Optional source filter, metadata-load limit, and context filter applied to the returned sessions.Sessions matching the filter, ordered most-recently-modified first.Active session ID whose deferred repo-level hooks should be loaded.Queued repo-level startup prompts and the total hook command count after loading.Task type determines the handoff strategy (CCA fetches events; CLI prepares a transient session).Open a session by creating, resuming, attaching, connecting to a remote, or handing off.`sessions.open` handoff progress update with step, status, and optional message.Step status.Handoff step.Result of opening a session.Outcome of the open request.Which session sources to include.Age threshold and optional flags controlling which old sessions are pruned (or simulated when dryRun is true).Outcome of the prune operation: deleted IDs, dry-run candidates, skipped IDs, total bytes freed, and the dry-run flag.Pagination options for reading an inactive or active local session's persisted event journal.Batch of session events returned by a read, with cursor and continuation metadata.Session ID whose in-use lock should be released.Active session ID and an optional flag for deferring repo-level hooks until folder trust.Session ID whose pending events should be flushed to disk.Manager-wide additional plugins to register; replaces any previously-configured set.Patch for the singleton's steering state.Wrapper for the singleton's current status.Parameters for attaching the remote-control singleton to a session.Wrapper for the singleton's current status.Request parameters for thesessions.stopRemoteControlRPC method.Outcome of a stopRemoteControl call.Parameters for atomically rebinding the remote-control singleton.Outcome of a transferRemoteControl call.API methods for thetasksnamespace.Identifier of the background task to cancel.Indicates whether the background task was successfully cancelled.The first sync-waiting task that can currently be promoted to background mode.Identifier of the background task to fetch progress for.Progress information for the task, or null when no task with that ID is tracked.Background tasks currently tracked by the session.The promoted task as it now exists in background mode, omitted if no promotable task was waiting.Identifier of the task to promote to background mode.Indicates whether the task was successfully promoted to background mode.Registers or reclaims a client-owned task.Result of registering or reclaiming a client-owned task.Identifier of the completed or cancelled task to remove from tracking.Indicates whether the task was removed.Identifier of the target agent task, message content, and optional sender agent ID.Indicates whether the message was delivered, with an error message when delivery failed.Agent type, prompt, name, and optional description and model override for the new task.Identifier assigned to the newly started background agent task.Updates a client-owned task.Result of publishing a client-owned task update.API methods for thetelemetrynamespace.Telemetry engagement ID for the session, when available.Feature override key/value pairs to attach to subsequent telemetry events from this session.API methods for thetoolsnamespace.A tool name and arguments to execute through the session's native invocation pipeline.Options controlling how Rust-owned built-in tool descriptors are materialized.Rust-owned built-in tool descriptors for the session.Current lightweight tool metadata snapshot for the session.Pending external tool call request ID, with the tool result or an error describing why it failed.Indicates whether the external tool call result was handled successfully.Complete externally implemented tool list for the calling connection.Task-completion tool arguments and final result used to build a label-safe session event payload.Task completion notification with summary from the agentSubagent settings to apply to the current sessionConfigured per-agent subagent overridesAPI methods for theuinamespace.Prompt message and JSON schema describing the form fields to elicit from the user.The elicitation response (accept with form values, decline, or cancel)Transient question to answer without adding it to conversation history.Completed transient query.Request ID of a pending `auto_mode_switch.requested` event and the user's response.Indicates whether the pending UI request was resolved by this call.Pending elicitation request ID and the user's response (accept/decline/cancel + form values).Indicates whether the elicitation response was accepted; false if it was already resolved by another client.Request ID of a pending `exit_plan_mode.requested` event and the user's response.Indicates whether the pending UI request was resolved by this call.Request ID of a pending `sampling.requested` event and an optional sampling result payload (omit to reject).Indicates whether the pending UI request was resolved by this call.Request ID of a pending `session_limits_exhausted.requested` event and the user's selected limit action.Indicates whether the pending UI request was resolved by this call.Request ID of a pending `user_input.requested` event and the user's response.Indicates whether the pending UI request was resolved by this call.Register an in-process handler for `auto_mode_switch.requested` events.Opaque handle previously returned by `registerDirectAutoModeSwitchHandler` to release.Indicates whether the handle was active and the registration count was decremented.API methods for theusagenamespace.Accumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals.API methods for thevisibilitynamespace.Current sharing status and shareable GitHub URL for a session.Desired sharing status for the session.Effective sharing status and shareable GitHub URL after updating session visibility.Sharing status for a synced session.Parameters for one workflow-scoped subagent call.Result of one workflow-scoped subagent call.API methods for theworkflownamespace.Parameters for cancelling a workflow run.Complete current or terminal workflow run envelope.Parameters for retrieving a workflow run.Full workflow run observability detail.Parameters for retrieving a workflow run.Parameters for paging workflow progress.A bidirectional page of workflow progress.Complete current or terminal workflow run envelope.API methods for theworkflow.journalnamespace.Parameters for reading a workflow journal entry.Result of reading a workflow journal entry.Parameters for storing a workflow journal entry.Parameters for paging workflow runs.A page of workflow runs in durable creation order.Parameters for recording workflow progress.Parameters for an owned durable pause checkpoint.Result for thesession.workflow.pauseAtCheckpointRPC method.Parameters for pausing a running workflow.Complete current or terminal workflow run envelope.Internal parameters for resuming a workflow run from a tool.Resolved persisted workflow identity and resumed run envelope.Parameters for resuming a workflow run from its persisted identity.Resolved persisted workflow identity and resumed run envelope.Internal parameters for invoking a registered workflow from a tool.Complete current or terminal workflow run envelope.Parameters for invoking a registered workflow.Complete current or terminal workflow run envelope.Updated working directory and git context.Hosting platform type of the repositoryCompaction summary checkpoint to persist.Persisted summary metadata and refreshed workspace metadata.API methods for theworkspacesnamespace.Whether the autopilot objective file exists.Directory to create within the session workspace files directory.Relative path and UTF-8 content for the workspace file to create or overwrite.Result of deleting the autopilot objective file.Parameters for computing a workspace diff.Workspace diff result for the requested mode.Optional session context used when creating a local workspace.Current workspace metadata for the session, including its absolute filesystem path when available.Current workspace metadata for the session, including its absolute filesystem path when available.Workspace checkpoints in chronological order; empty when the workspace is not enabled.Relative paths of files stored in the session workspace files directory.Autopilot objective file content, or null when missing.Checkpoint number to read.Checkpoint content as a UTF-8 string, or null when the checkpoint or workspace is missing.Relative path of the workspace file to read.Contents of the requested workspace file as a UTF-8 string.File or directory to remove from the session workspace files directory.Source and destination paths for a rename within the session workspace files directory.Pasted content to save as a UTF-8 file in the session workspace.Descriptor for the saved paste file, or null when the workspace is unavailable.Relative path of the workspace file or directory to inspect.Filesystem metadata for a path in the session workspace files directory.Rollback point for local workspace summaries.Current workspace metadata for the session, including its absolute filesystem path when available.Workspace metadata fields to update.Current workspace metadata for the session, including its absolute filesystem path when available.Autopilot objective file content to persist.Result of writing the autopilot objective file.Command-scoped GitHub credential injection for the shell commands an agent runs.Controls automatic non-interactive profile loading where supported.A host-provided script sourced before each built-in shell command when its shell target matches the active shell.Supported built-in shells for initialization scripts.Signal to send (default: SIGTERM)Per-session settings for built-in shell tools.Why the session is being shut down.Skill metadata available to a session, with name, description, source, enabled/invocable state, path, plugin, and argument hint.Canonical directory where skills can be discovered or created, with scope, preference, and optional project path.Which tier this directory belongs toBounded refusal categories for verified Skill installation management.One reviewed Skill file.A user-facing personal Skill installation location without absolute host paths.Management outcome for verified Skill inventory, planning and removal.Skill installation management result with the honoured contract, or a typed refusal.Status snapshot from the original connection, independent of new-work account availability.Owned Skill state observed from files and receipts.Skill installation result with the honoured contract, or a typed request/negotiation refusal.Safe verified Skill review fields.Bound-session observation after reconciling persisted enablement.Source identity retained from Agent Finder and the pinned GitHub descriptor.Durable verified Skill ownership summary.A computed Skill install plan.Catalog-only metadata for one SDK-provided skill.Applies exactly one retained verified Skill installation plan.One-use application of the exact retained Skill removal plan.Skill names to mark as disabled in global configuration, replacing any previous list.Adds or removes a single skill from the global disabled list, leaving every other entry untouched.Optional project paths and additional skill directories to include in discovery.Skills discovered across global and project sources.Optional project paths to enumerate.Canonical locations where skills can be created so the runtime will recognize them.Existing-operation control.Inventory request under an explicitly selected existing session.Inventory request under an explicitly selected existing session.Persisted enablement update for one owned Skill installation.Existing-operation control.Skill invocation record with name, path, content, allowed tools, and turn number.Source location type (e.g., project, personal-copilot, plugin, builtin, sdk)Side-effect-free planning of one verified Agent Finder Skill candidate.Read-only preparation of one owned Skill removal under fresh selected-session authority.A computed Skill uninstall plan.Slash-command metadata with name, aliases, description, kind, input hint, execution allowance, and schedulability.Optional unstructured input hintA literal choice the command input accepts, with a human-facing descriptionOptional completion hint for the input (e.g.Result of invoking the slash command (text output, prompt to send to the agent, completion, or subcommand selection).Coarse command category for grouping and behavior: runtime built-in, skill-backed command, or SDK/client-owned commandSelectable slash-command subcommand option with name, description, and optional group label.Subagent model, reasoning effort, context tier, and auto-invocation settingsContext tier override for matching subagentsStructured reason that the task cannot continue without interventionCategory of structured task blockerClient-owned tasks always execute outside the runtime in background mode.Tracked client-owned task metadata.Public owner attribution for a client-owned task.Connection class owning a client task.Presence of the task's bound join.Lifecycle status of a client-owned task.Discriminator for a client-owned task.Semantic result of evaluating a task completion requestClosed set of public task kinds a connection can negotiate.Built-in tool metadata with identifier, optional namespaced name, description, input-parameter schema, and usage instructions.Expanded canonical result returned by a session tool.A message injected by a tool result.Execution outcome classification.Optional model identifier whose tool overrides should be applied to the listing.Built-in tools available for the requested model, with their parameters and instructions.Shell-specific names and description lines used to materialize built-in shell tool descriptors.User's choice for auto-mode switching: yes (allow this turn), yes_always (allow + persist as setting), or no (decline).The elicitation response (accept with form values, decline, or cancel)The user's response: accept (submitted), decline (rejected), or cancel (dismissed)JSON Schema describing the form fields to present to the userThe action the user selected.User response for a pending exit-plan-mode request, with approval state, selected action, auto-approve flag, and feedback.Optional sampling result payload.The user's selected action for an exhausted session limit.User action selected for an exhausted session limit.User response for a pending user-input request, with answer text and whether it was typed freeform.Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model breakdown.Aggregated code change metricsPer-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details.Request count and cost metrics for this modelPer-model token-detail entry containing the accumulated token count for one token type.Token usage metrics for this modelSession-wide token-detail entry containing the accumulated token count for one token type.A single user setting's effective value alongside its default, so consumers can render settings left at their default.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.Partial user settings to write to settings.json.Outcome of writing user settings.Output verbosity level for supported modelsOptions for one workflow-scoped subagent call.Prompt-safe durable identity and live status for a direct workflow agent.Current workflow phase identity.Declared or approved workflow resource ceilings.One ordered workflow progress line.Kind of workflow progress line.Action the runtime selected for a durable workflow pause checkpoint.Durable lifecycle and timing for one workflow phase.Derived lifecycle state of a workflow phase.One durable workflow progress record.A bidirectional page of workflow progress.Durable workflow resource consumption.Wire-only per-invocation workflow resource ceiling overrides.Options controlling workflow invocation.Complete current or terminal workflow run envelope.Current or terminal state of a workflow run.Durable workflow run summary with read-time live overlays.Prompt-safe terminal workflow outcome.Options for an internal tool-originated workflow invocation.A single changed file and its unified diff.Type of change represented by this file diff.Diff mode requested by the client.Workspace checkpoint metadata with assigned number, human-readable title, and checkpoint filename.Repository host type, if knownAllowed values for the `WorkspacesWorkspaceDetailsHostType` enumeration. -
Classes in com.github.copilot.generated.rpc used by com.github.copilot.rpcClassDescriptionLightweight metadata for a currently initialized session toolPer-source session diagnostics configuration.A discovered extension entrypoint that the registered integrator may classify and resolve to an opaque launch profile.The launch profile for a supported entrypoint.Payload for a `gitHubTelemetry.event` notification: a single GitHub telemetry event the runtime forwards to a host connection that opted into telemetry forwarding during the `server.connect` handshake.Why the runtime is requesting a GitHub credential.One connection-owned, expiring request for a trusted host's explicit user decision.Explicit user decisions, never inferred from a permission grant or model response.Token-level pricing information for this modelOpen canvas instance snapshot.Optional informational context describing how and where the permission decision was made.Optional session limits.