experimental/v2 library
Explicit opt-in surface for the experimental draft ACP v2 baseline.
This library is versioned independently from the stable-v1 API contract and may change incompatibly while ACP v2 remains a draft.
Classes
- AbsentJsonRpcParams
-
An omitted JSON-RPC
paramsmember. - AbsolutePath
- An absolute filesystem path used by the protocol.
- AbsolutePathCodec
- Codec for AbsolutePath.
-
AcpAbsent<
T> - An absent optional value.
-
AcpCodec<
T> - Encodes and decodes one concrete protocol value type.
-
AcpDuplexStream<
T> - A typed pair of incoming and outgoing stream halves.
-
AcpInProcessTransportPair<
T> - A pair of connected, platform-neutral in-process transports.
- AcpInt64
- A signed 64-bit integer represented exactly on every Dart platform.
- AcpJsonArray
- An immutable JSON array.
- AcpJsonBoolean
- A JSON boolean.
- AcpJsonEncodable
- An interface for protocol values with an explicit recursive JSON boundary.
- AcpJsonNull
-
The JSON
nullvalue. - AcpJsonNumber
- A finite JSON number.
- AcpJsonObject
- An immutable JSON object whose keys are always strings.
- AcpJsonObjectConverter
- Strictly converts JSON objects.
- AcpJsonString
- A JSON string.
- AcpJsonValue
-
A value that can be represented by JSON without using
dynamic. - AcpJsonValueConverter
- Converts any recursive JSON value to and from AcpJsonValue.
- AcpMetaConverter
-
Implements ACP's forgiving
_metadecoding rule. -
AcpMethodDescriptor<
P, R> - Schema-derived facts for one ACP request or notification.
- AcpMethodDescriptorBase
- Type-erased schema facts shared by all method descriptors.
- AcpMethodKey
- A unique method-registry key.
- AcpMethodRegistry
- An immutable, duplicate-checked collection of method descriptors.
- AcpNoResult
- The explicit result type used by notification descriptors.
- AcpNoResultCodec
- Codec for the explicit notification no-result type.
- AcpNullableJsonObjectConverter
- Converts nullable JSON objects.
- AcpNullableJsonValueConverter
- Converts nullable recursive JSON values.
-
AcpOptional<
T> - A value whose presence is distinct from its value.
-
AcpPatch<
T> -
A protocol field whose omission, explicit
null, and value are distinct. -
AcpPatchClear<
T> - A patch that explicitly clears a nullable field.
-
AcpPatchSet<
T> - A patch that replaces a field with value.
-
AcpPatchUnchanged<
T> - A patch that omits the field and leaves stored state unchanged.
-
AcpPresent<
T> - A present optional value.
- AcpStdioTransport
- Platform-neutral entry point for ACP's NDJSON stdio transport.
- AcpUint64
- An unsigned 64-bit integer represented exactly on every Dart platform.
- AcpV2ActiveSession
- A locally routed draft-v2 session.
- AcpV2AgentApp
- Immutable agent-side application for the draft ACP v2 baseline.
- AcpV2AgentConnection
- Agent connection and client-calling context.
- AcpV2AgentContext
- Agent-side context used to call the client.
-
AcpV2AgentNotificationContext<
P> - Agent notification handler context.
-
AcpV2AgentRequestContext<
P> - Agent request handler context.
- AcpV2ApplicationOptions
- Application behavior switches for draft ACP v2.
- AcpV2Batch
- A non-empty advanced-form heterogeneous batch.
-
AcpV2BatchEntry<
T> - One typed entry in a heterogeneous draft-v2 batch.
-
AcpV2BatchNotification<
P> -
A notification entry whose output slot is
void. -
AcpV2BatchRequest<
P, R> - A typed request entry.
- AcpV2CallContext
- Shared descriptor-backed v2 call context.
- AcpV2ClientApp
- Immutable client-side application for the draft ACP v2 baseline.
- AcpV2ClientConnection
- Client connection and agent-calling context.
- AcpV2ClientContext
- Client-side context used to call the agent.
-
AcpV2ClientNotificationContext<
P> - Client notification handler context.
-
AcpV2ClientRequestContext<
P> - Client request handler context.
- AcpV2CollectedText
- Result of v2 text collection.
- AcpV2Connection
- Shared behavior for a draft-v2 connection.
- AcpV2ConnectionLifecycle
- Coordinates v2 initialization and connection state.
- AcpV2ConnectOptions
- Per-connection startup behavior.
- AcpV2DirectConnectionPair
- Both sides of a bounded direct v2 connection.
- AcpV2MessageState
- Materialized message content after replacement and chunk semantics.
- AcpV2Methods
- Curated generated method descriptors for the baseline draft-v2 API.
- AcpV2PeerCapabilities
- Immutable peer capabilities negotiated during v2 initialization.
- AcpV2PromptAcceptedEvent
- Prompt acceptance event; this is not completion.
- AcpV2PromptCompletedEvent
- Prompt completion event.
- AcpV2PromptCompletion
- Information from the first post-acceptance idle update.
- AcpV2PromptTurn
- One prompt turn with independent acceptance and idle completion.
-
AcpV2RequestContext<
P> - Shared request handler data.
- AcpV2SessionBuilder
-
Immutable builder for
session/new. - AcpV2SessionEvent
- Base event emitted by active v2 sessions and prompt turns.
- AcpV2Sessions
- Session lifecycle helpers for one initialized client connection.
- AcpV2SessionSnapshot
- Materialized client-side session state.
- AcpV2SessionSubscription
- Idempotent registration for a local v2 update route.
- AcpV2SessionUpdateEvent
- One sequenced session update.
- AcpV2TerminalState
- Materialized terminal state.
-
AcpWritable<
T> - An asynchronous writable transport half.
- AgentAuthCapabilities
- Authentication-related extension capabilities supported by the agent.
- AgentAuthCapabilitiesCodec
- Codec for AgentAuthCapabilities.
- AgentCapabilities
- Capabilities supported by the agent.
- AgentCapabilitiesCodec
- Codec for AgentCapabilities.
- AgentMessage
- An agent message upsert.
- AgentMessageCodec
- Codec for AgentMessage.
- AgentNotification
- A JSON-RPC notification object.
- AgentNotificationCodec
- Codec for AgentNotification.
- AgentRequest
- A JSON-RPC request object.
- AgentRequestCodec
- Codec for AgentRequest.
- AgentResponse
- A JSON-RPC response object.
- AgentResponseCodec
- Codec for AgentResponse.
- AgentThought
- An agent thought or reasoning message upsert.
- AgentThoughtCodec
- Codec for AgentThought.
- Annotations
- Optional annotations for the client. The client can use annotations to inform how objects are used or displayed
- AnnotationsCodec
- Codec for Annotations.
- AudioContent
- Audio provided to or from an LLM.
- AudioContentCodec
- Codec for AudioContent.
- AuthMethod
- Describes an available authentication method.
- AuthMethodAgent
-
Agent handles authentication itself through
auth/login. - AuthMethodAgentCodec
- Codec for AuthMethodAgent.
- AuthMethodAgentVariant
-
Agent handles authentication itself through
auth/login. - AuthMethodCodec
- Codec for AuthMethod.
- AuthMethodCustom
-
An unknown future or
_-prefixed AuthMethod variant. - AuthMethodId
- Typed identifier used for auth method values on the wire.
- AuthMethodIdCodec
- Codec for AuthMethodId.
- AvailableCommand
- Information about a command.
- AvailableCommandCodec
- Codec for AvailableCommand.
- AvailableCommandInput
- The input specification for a command.
- AvailableCommandInputCodec
- Codec for AvailableCommandInput.
- AvailableCommandInputCustom
-
An unknown future or
_-prefixed AvailableCommandInput variant. - AvailableCommandInputText
- All text that was typed after the command name is provided as input.
- AvailableCommandsUpdate
- Available commands are ready or have changed
- AvailableCommandsUpdateCodec
- Codec for AvailableCommandsUpdate.
- BlobResourceContents
- Binary resource contents.
- BlobResourceContentsCodec
- Codec for BlobResourceContents.
- BooleanPropertySchema
- Schema for boolean properties in an elicitation form.
- BooleanPropertySchemaCodec
- Codec for BooleanPropertySchema.
- CancellationRegistration
- An idempotent registration for a cancellation callback.
- CancellationSource
- The owner that can cancel a token.
- CancellationToken
- A read-only cooperative cancellation signal.
- CancelRequestNotification
- Notification to cancel an ongoing request.
- CancelRequestNotificationCodec
- Codec for CancelRequestNotification.
- CancelSessionNotification
- Notification to cancel ongoing operations for a session.
- CancelSessionNotificationCodec
- Codec for CancelSessionNotification.
- ClientCapabilities
- Capabilities supported by the client.
- ClientCapabilitiesCodec
- Codec for ClientCapabilities.
- ClientNotification
- A JSON-RPC notification object.
- ClientNotificationCodec
- Codec for ClientNotification.
- ClientRequest
- A JSON-RPC request object.
- ClientRequestCodec
- Codec for ClientRequest.
- ClientResponse
- A JSON-RPC response object.
- ClientResponseCodec
- Codec for ClientResponse.
- CloseSessionRequest
- Request parameters for closing an active session.
- CloseSessionRequestCodec
- Codec for CloseSessionRequest.
- CloseSessionResponse
- Response from closing a session.
- CloseSessionResponseCodec
- Codec for CloseSessionResponse.
- CommandPermissionSubject
- Permission request details for a command.
- CommandPermissionSubjectCodec
- Codec for CommandPermissionSubject.
- CompleteElicitationNotification
- Notification sent by the agent when a URL-based elicitation is complete.
- CompleteElicitationNotificationCodec
- Codec for CompleteElicitationNotification.
- ConfigOptionUpdate
- Session configuration options have been updated.
- ConfigOptionUpdateCodec
- Codec for ConfigOptionUpdate.
- Content
- Standard content block (text, images, resources).
- ContentBlock
- Content blocks represent displayable information in the Agent Client Protocol.
- ContentBlockAudio
- Audio data for transcription or analysis.
- ContentBlockCodec
- Codec for ContentBlock.
- ContentBlockCustom
-
An unknown future or
_-prefixed ContentBlock variant. - ContentBlockImage
- Images for visual context or analysis.
- ContentBlockResource
- Complete resource contents embedded directly in the message.
- ContentBlockResourceLink
- References to resources that the agent can access.
- ContentBlockText
- Text content. May be plain text or formatted with Markdown.
- ContentChunk
- A streamed item of message content.
- ContentChunkCodec
- Codec for ContentChunk.
- ContentCodec
- Codec for Content.
- Cost
- Cost information for a session.
- CostCodec
- Codec for Cost.
- CreateElicitationRequest
- Request from the agent to elicit structured user input.
- CreateElicitationRequestCodec
- Codec for CreateElicitationRequest.
- CreateElicitationRequestCustom
-
An unknown future or
_-prefixed CreateElicitationRequest variant. - CreateElicitationRequestForm
- Form-based elicitation where the client renders a form from the provided schema.
- CreateElicitationRequestUrl
- URL-based elicitation where the client directs the user to a URL.
- CreateElicitationResponse
- Response from the client to an elicitation request.
- CreateElicitationResponseAccept
- The user accepted and provided content.
- CreateElicitationResponseCancel
- The elicitation was cancelled.
- CreateElicitationResponseCodec
- Codec for CreateElicitationResponse.
- CreateElicitationResponseCustom
-
An unknown future or
_-prefixed CreateElicitationResponse variant. - CreateElicitationResponseDecline
- The user declined the elicitation.
- DeleteSessionRequest
-
Request parameters for deleting an existing session from
session/list. - DeleteSessionRequestCodec
- Codec for DeleteSessionRequest.
- DeleteSessionResponse
- Response from deleting a session.
- DeleteSessionResponseCodec
- Codec for DeleteSessionResponse.
- Diff
- File changes produced by a tool call.
- DiffChange
-
One file-level change described by a
Diff. - DiffChangeAdd
- A file was added.
- DiffChangeCodec
- Codec for DiffChange.
- DiffChangeCopy
- A file was copied.
- DiffChangeCustom
-
An unknown future or
_-prefixed DiffChange variant. - DiffChangeDelete
- A file was deleted.
- DiffChangeModify
- A file was modified in place.
- DiffChangeMove
- A file was moved or renamed.
- DiffCodec
- Codec for Diff.
- DiffFileType
- Kind of file content represented by a diff change.
- DiffFileTypeCodec
- Codec for DiffFileType.
- DiffPatch
- Renderable patch text and its format.
- DiffPatchCodec
- Codec for DiffPatch.
- DiffPatchFormat
-
Text patch format used by
DiffPatch. - DiffPatchFormatCodec
- Codec for DiffPatchFormat.
- DiffPathChange
- Operation metadata for add, delete, and modify changes.
- DiffPathChangeCodec
- Codec for DiffPathChange.
- DiffPathPairChange
- Operation metadata for move and copy changes.
- DiffPathPairChangeCodec
- Codec for DiffPathPairChange.
- ElicitationAcceptAction
- The user accepted the elicitation and provided content.
- ElicitationAcceptActionCodec
- Codec for ElicitationAcceptAction.
- ElicitationCapabilities
- Elicitation capabilities supported by the client.
- ElicitationCapabilitiesCodec
- Codec for ElicitationCapabilities.
- ElicitationContentValue
-
Allowed wire representations for
ElicitationContentValue. - ElicitationContentValueBoolean
- Boolean value accepted in elicitation response content.
- ElicitationContentValueCodec
- Codec for ElicitationContentValue.
- ElicitationContentValueInteger
- Integer value accepted in elicitation response content.
- ElicitationContentValueNumber
- Number value accepted in elicitation response content.
- ElicitationContentValueString
- String value accepted in elicitation response content.
- ElicitationContentValueStringArray
- String array value accepted in elicitation response content.
- ElicitationFormCapabilities
- Form-based elicitation capabilities.
- ElicitationFormCapabilitiesCodec
- Codec for ElicitationFormCapabilities.
- ElicitationFormMode
- Form-based elicitation mode where the client renders a form from the provided schema.
- ElicitationFormModeCodec
- Codec for ElicitationFormMode.
- ElicitationFormModeRequest
- Tied to a specific JSON-RPC request outside of a session (e.g., during auth/configuration phases before any session is started).
- ElicitationFormModeSession
- Tied to a session, optionally to a specific tool call within that session.
- ElicitationFormModeVariant
- One concrete composition branch for ElicitationFormMode.
- ElicitationId
- Unique identifier for an elicitation.
- ElicitationIdCodec
- Codec for ElicitationId.
- ElicitationPropertySchema
- Property schema for elicitation form fields.
- ElicitationPropertySchemaArray
- Multi-select array property.
- ElicitationPropertySchemaBoolean
- Boolean property.
- ElicitationPropertySchemaCodec
- Codec for ElicitationPropertySchema.
- ElicitationPropertySchemaCustom
-
An unknown future or
_-prefixed ElicitationPropertySchema variant. - ElicitationPropertySchemaInteger
- Integer property.
- ElicitationPropertySchemaNumber
- Number (floating-point) property.
- ElicitationPropertySchemaString
-
String property (or single-select enum when
enum/oneOfis set). - ElicitationRequestScope
- Request-scoped elicitation, tied to a specific JSON-RPC request outside of a session (e.g., during auth/configuration phases before any session is started).
- ElicitationRequestScopeCodec
- Codec for ElicitationRequestScope.
- ElicitationSchema
- Type-safe elicitation schema for requesting structured user input.
- ElicitationSchemaCodec
- Codec for ElicitationSchema.
- ElicitationSchemaType
- Type discriminator for elicitation schemas.
- ElicitationSchemaTypeCodec
- Codec for ElicitationSchemaType.
- ElicitationSessionScope
- Session-scoped elicitation, optionally tied to a specific tool call.
- ElicitationSessionScopeCodec
- Codec for ElicitationSessionScope.
- ElicitationUrlCapabilities
- URL-based elicitation capabilities.
- ElicitationUrlCapabilitiesCodec
- Codec for ElicitationUrlCapabilities.
- ElicitationUrlMode
- URL-based elicitation mode where the client directs the user to a URL.
- ElicitationUrlModeCodec
- Codec for ElicitationUrlMode.
- ElicitationUrlModeRequest
- Tied to a specific JSON-RPC request outside of a session (e.g., during auth/configuration phases before any session is started).
- ElicitationUrlModeSession
- Tied to a session, optionally to a specific tool call within that session.
- ElicitationUrlModeVariant
- One concrete composition branch for ElicitationUrlMode.
- EmbeddedResource
- The contents of a resource, embedded into a prompt or tool call result.
- EmbeddedResourceCodec
- Codec for EmbeddedResource.
- EmbeddedResourceResource
- Resource content that can be embedded in a message.
- EmbeddedResourceResourceBlobResourceContents
- Binary resource contents embedded directly in the message.
- EmbeddedResourceResourceCodec
- Codec for EmbeddedResourceResource.
- EmbeddedResourceResourceTextResourceContents
- Text resource contents embedded directly in the message.
- EnumOption
- A titled enum option with a const value, human-readable title, and optional description.
- EnumOptionCodec
- Codec for EnumOption.
- EnvVariable
- An environment variable to set when launching a process.
- EnvVariableCodec
- Codec for EnvVariable.
- Error
- JSON-RPC error object.
- ErrorCode
- Predefined error codes for common JSON-RPC and ACP-specific errors.
- ErrorCodec
- Codec for Error.
- ErrorCodeCodec
- Codec for ErrorCode.
- ExtNotification
- Allows the Agent to send an arbitrary notification that is not part of the ACP spec. Extension notifications provide a way to send one-way messages for custom functionality while maintaining protocol compatibility.
- ExtNotificationCodec
- Codec for ExtNotification.
- ExtRequest
- Allows for sending an arbitrary request that is not part of the ACP spec. Extension methods provide a way to add custom functionality while maintaining protocol compatibility.
- ExtRequestCodec
- Codec for ExtRequest.
- ExtResponse
-
Allows for sending an arbitrary response to an
ExtRequestthat is not part of the ACP spec. Extension methods provide a way to add custom functionality while maintaining protocol compatibility. - ExtResponseCodec
- Codec for ExtResponse.
- HttpHeader
- An HTTP header to set when making requests to the MCP server.
- HttpHeaderCodec
- Codec for HttpHeader.
- Icon
- An optionally-sized icon that can be displayed in a user interface.
- IconCodec
- Codec for Icon.
- IconTheme
- Theme an icon is designed for.
- IconThemeCodec
- Codec for IconTheme.
- IdleStateUpdate
- The agent is ready to process a new prompt.
- IdleStateUpdateCodec
- Codec for IdleStateUpdate.
- ImageContent
- An image provided to or from an LLM.
- ImageContentCodec
- Codec for ImageContent.
- Implementation
- Metadata about the implementation of the client or agent. Describes the name and version of an ACP implementation, with an optional title for UI representation.
- ImplementationCodec
- Codec for Implementation.
- InitializeRequest
- Request parameters for the initialize method.
- InitializeRequestCodec
- Codec for InitializeRequest.
- InitializeResponse
-
Response to the
initializemethod. - InitializeResponseCodec
- Codec for InitializeResponse.
- IntegerPropertySchema
- Schema for integer properties in an elicitation form.
- IntegerPropertySchemaCodec
- Codec for IntegerPropertySchema.
- JsonRpcConnectionOptions
- Limits and behavior for JsonRpcConnection.
- JsonRpcDiagnostic
- A structured, payload-safe connection diagnostic.
- JsonRpcDiagnosticError
- Payload-safe classification of an error associated with a diagnostic.
- JsonRpcErrorObject
- A JSON-RPC error object.
- JsonRpcId
- A JSON-RPC request identifier.
- JsonRpcParams
-
The optional
paramsmember of a JSON-RPC call. - ListSessionsRequest
- Request parameters for listing existing sessions.
- ListSessionsRequestCodec
- Codec for ListSessionsRequest.
- ListSessionsResponse
- Response from listing sessions.
- ListSessionsResponseCodec
- Codec for ListSessionsResponse.
- LoginAuthRequest
-
Request parameters for the
auth/loginmethod. - LoginAuthRequestCodec
- Codec for LoginAuthRequest.
- LoginAuthResponse
-
Response to the
auth/loginmethod. - LoginAuthResponseCodec
- Codec for LoginAuthResponse.
- LogoutAuthRequest
-
Request parameters for the
auth/logoutmethod. - LogoutAuthRequestCodec
- Codec for LogoutAuthRequest.
- LogoutAuthResponse
-
Response to the
auth/logoutmethod. - LogoutAuthResponseCodec
- Codec for LogoutAuthResponse.
- McpCapabilities
- MCP capabilities supported by the agent for session lifecycle requests.
- McpCapabilitiesCodec
- Codec for McpCapabilities.
- McpHttpCapabilities
- Capabilities for HTTP MCP server transports.
- McpHttpCapabilitiesCodec
- Codec for McpHttpCapabilities.
- McpServer
- Configuration for connecting to an MCP (Model Context Protocol) server.
- McpServerCodec
- Codec for McpServer.
- McpServerCustom
-
An unknown future or
_-prefixed McpServer variant. - McpServerHttp
- HTTP transport configuration for MCP.
- McpServerHttpCodec
- Codec for McpServerHttp.
- McpServerHttpVariant
- HTTP transport configuration
- McpServerStdio
- Stdio transport configuration for MCP.
- McpServerStdioCodec
- Codec for McpServerStdio.
- McpServerStdioVariant
- Stdio transport configuration
- McpStdioCapabilities
- Capabilities for stdio MCP server transports.
- McpStdioCapabilitiesCodec
- Codec for McpStdioCapabilities.
- MediaType
- An Internet media type identifying the format of protocol content.
- MediaTypeCodec
- Codec for MediaType.
- MessageId
- Unique identifier for a message within a session.
- MessageIdCodec
- Codec for MessageId.
- MultiSelectItems
- Items for a multi-select (array) property schema.
- MultiSelectItemsCodec
- Codec for MultiSelectItems.
- MultiSelectItemsOther
- Custom or future typed multi-select items.
- MultiSelectItemsStringMultiSelectItems
- Multi-select string items with plain string values.
- MultiSelectItemsTitled
- Titled multi-select items with human-readable labels.
- MultiSelectPropertySchema
- Schema for multi-select (array) properties in an elicitation form.
- MultiSelectPropertySchemaCodec
- Codec for MultiSelectPropertySchema.
- NdJsonDiagnostic
- A diagnostic emitted while decoding NDJSON.
- NdJsonStreamOptions
- Configuration for ndJsonStream.
- NewSessionRequest
- Request parameters for creating a new session.
- NewSessionRequestCodec
- Codec for NewSessionRequest.
- NewSessionResponse
- Response from creating a new session.
- NewSessionResponseCodec
- Codec for NewSessionResponse.
- NullJsonRpcId
-
The explicit JSON
nullrequest identifier. - NumberJsonRpcId
- A numeric JSON-RPC identifier.
- NumberPropertySchema
- Schema for number (floating-point) properties in an elicitation form.
- NumberPropertySchemaCodec
- Codec for NumberPropertySchema.
- PermissionOption
- An option presented to the user when requesting permission.
- PermissionOptionCodec
- Codec for PermissionOption.
- PermissionOptionId
- Unique identifier for a permission option.
- PermissionOptionIdCodec
- Codec for PermissionOptionId.
- PermissionOptionKind
- The type of permission option being presented to the user.
- PermissionOptionKindCodec
- Codec for PermissionOptionKind.
- PlanEntry
- A single entry in the execution plan.
- PlanEntryCodec
- Codec for PlanEntry.
- PlanEntryPriority
- Priority levels for plan entries.
- PlanEntryPriorityCodec
- Codec for PlanEntryPriority.
- PlanEntryStatus
- Status of a plan entry in the execution flow.
- PlanEntryStatusCodec
- Codec for PlanEntryStatus.
- PlanId
- Unique identifier for a plan within a session.
- PlanIdCodec
- Codec for PlanId.
- PlanItems
- A plan represented as structured entries.
- PlanItemsCodec
- Codec for PlanItems.
- PlanUpdate
- A content update for a plan identified by ID.
- PlanUpdateCodec
- Codec for PlanUpdate.
- PlanUpdateContent
- Updated content for a plan.
- PlanUpdateContentCodec
- Codec for PlanUpdateContent.
- PlanUpdateContentCustom
-
An unknown future or
_-prefixed PlanUpdateContent variant. - PlanUpdateContentItems
- Structured plan entries.
- PresentJsonRpcParams
-
A present JSON-RPC
paramsmember. - PromptAudioCapabilities
- Capabilities for audio content in prompt requests.
- PromptAudioCapabilitiesCodec
- Codec for PromptAudioCapabilities.
- PromptCapabilities
-
Prompt capabilities supported by the agent in
session/promptrequests. - PromptCapabilitiesCodec
- Codec for PromptCapabilities.
- PromptEmbeddedContextCapabilities
- Capabilities for embedded context in prompt requests.
- PromptEmbeddedContextCapabilitiesCodec
- Codec for PromptEmbeddedContextCapabilities.
- PromptImageCapabilities
- Capabilities for image content in prompt requests.
- PromptImageCapabilitiesCodec
- Codec for PromptImageCapabilities.
- PromptRequest
- Request parameters for sending a user prompt to the agent.
- PromptRequestCodec
- Codec for PromptRequest.
- PromptResponse
- Response acknowledging that a user prompt was accepted.
- PromptResponseCodec
- Codec for PromptResponse.
- ProtocolLevelNotification
- A JSON-RPC notification object.
- ProtocolLevelNotificationCodec
- Codec for ProtocolLevelNotification.
- ProtocolVersion
- Protocol version identifier.
- ProtocolVersionCodec
- Codec for ProtocolVersion.
- ReplayFrom
- Inclusive cursor describing where replayed session history should begin.
- ReplayFromCodec
- Codec for ReplayFrom.
- ReplayFromCustom
-
An unknown future or
_-prefixed ReplayFrom variant. - ReplayFromStart
- Inclusive replay cursor requesting replay from the start of the conversation.
- ReplayFromStartCodec
- Codec for ReplayFromStart.
- ReplayFromStartVariant
- Replay the whole conversation from its first replayable entry.
- RequestId
- JSON RPC Request Id
- RequestIdCodec
- Codec for RequestId.
- RequestIdNull
-
The JSON-RPC
nullrequest id. - RequestIdNumber
- A numeric JSON-RPC request id.
- RequestIdStr
- A string JSON-RPC request id.
- RequestPermissionOutcome
- The outcome of a permission request.
- RequestPermissionOutcomeCancelled
- Active session work was cancelled before the user responded.
- RequestPermissionOutcomeCodec
- Codec for RequestPermissionOutcome.
- RequestPermissionOutcomeCustom
-
An unknown future or
_-prefixed RequestPermissionOutcome variant. - RequestPermissionOutcomeSelected
- The user selected one of the provided options.
- RequestPermissionRequest
- Request for user permission to proceed with an operation.
- RequestPermissionRequestCodec
- Codec for RequestPermissionRequest.
- RequestPermissionResponse
- Response to a permission request.
- RequestPermissionResponseCodec
- Codec for RequestPermissionResponse.
- RequestPermissionSubject
- The operation requiring permission.
- RequestPermissionSubjectCodec
- Codec for RequestPermissionSubject.
- RequestPermissionSubjectCommand
- Permission is requested before running a command.
- RequestPermissionSubjectCustom
-
An unknown future or
_-prefixed RequestPermissionSubject variant. - RequestPermissionSubjectToolCall
- Permission is requested before executing a tool call.
- RequiresActionStateUpdate
- Foreground work is blocked on user action.
- RequiresActionStateUpdateCodec
- Codec for RequiresActionStateUpdate.
- ResourceLink
- A resource that the server is capable of reading, included in a prompt or tool call result.
- ResourceLinkCodec
- Codec for ResourceLink.
- ResumeSessionRequest
- Request parameters for resuming an existing session.
- ResumeSessionRequestCodec
- Codec for ResumeSessionRequest.
- ResumeSessionResponse
- Response from resuming an existing session.
- ResumeSessionResponseCodec
- Codec for ResumeSessionResponse.
- Role
- The sender or recipient of messages and data in a conversation.
- RoleCodec
- Codec for Role.
- RunningStateUpdate
- Foreground work is in progress.
- RunningStateUpdateCodec
- Codec for RunningStateUpdate.
- SelectedPermissionOutcome
- The user selected one of the provided options.
- SelectedPermissionOutcomeCodec
- Codec for SelectedPermissionOutcome.
- SessionAdditionalDirectoriesCapabilities
- Capabilities for additional session directories support.
- SessionAdditionalDirectoriesCapabilitiesCodec
- Codec for SessionAdditionalDirectoriesCapabilities.
- SessionCapabilities
- Session capabilities supported by the agent.
- SessionCapabilitiesCodec
- Codec for SessionCapabilities.
- SessionConfigBoolean
- A boolean on/off toggle session configuration option payload.
- SessionConfigBooleanCodec
- Codec for SessionConfigBoolean.
- SessionConfigGroupId
- Unique identifier for a session configuration option value group.
- SessionConfigGroupIdCodec
- Codec for SessionConfigGroupId.
- SessionConfigId
- Unique identifier for a session configuration option.
- SessionConfigIdCodec
- Codec for SessionConfigId.
- SessionConfigOption
- A session configuration option selector and its current state.
- SessionConfigOptionBoolean
- Boolean on/off toggle.
- SessionConfigOptionCategory
- Semantic category for a session configuration option.
- SessionConfigOptionCategoryCodec
- Codec for SessionConfigOptionCategory.
- SessionConfigOptionCodec
- Codec for SessionConfigOption.
- SessionConfigOptionCustom
-
An unknown future or
_-prefixed SessionConfigOption variant. - SessionConfigOptionSelect
- Single-value selector (dropdown).
- SessionConfigSelect
- A single-value selector (dropdown) session configuration option payload.
- SessionConfigSelectCodec
- Codec for SessionConfigSelect.
- SessionConfigSelectGroup
- A group of possible values for a session configuration option.
- SessionConfigSelectGroupCodec
- Codec for SessionConfigSelectGroup.
- SessionConfigSelectOption
- A possible value for a session configuration option.
- SessionConfigSelectOptionCodec
- Codec for SessionConfigSelectOption.
- SessionConfigSelectOptions
- Possible values for a session configuration option.
- SessionConfigSelectOptionsCodec
- Codec for SessionConfigSelectOptions.
- SessionConfigSelectOptionsGrouped
- A list of options grouped under headers.
- SessionConfigSelectOptionsUngrouped
- A flat list of options with no grouping.
- SessionConfigValueId
- Unique identifier for a session configuration option value.
- SessionConfigValueIdCodec
- Codec for SessionConfigValueId.
- SessionDeleteCapabilities
-
Capabilities for the
session/deletemethod. - SessionDeleteCapabilitiesCodec
- Codec for SessionDeleteCapabilities.
- SessionId
- A unique identifier for a conversation session between a client and agent.
- SessionIdCodec
- Codec for SessionId.
- SessionInfo
- Information about a session returned by session/list
- SessionInfoCodec
- Codec for SessionInfo.
- SessionInfoUpdate
- Update to session metadata. All fields are optional to support partial updates.
- SessionInfoUpdateCodec
- Codec for SessionInfoUpdate.
- SessionListCursor
-
An opaque cursor used to paginate
session/listresults. - SessionListCursorCodec
- Codec for SessionListCursor.
- SessionUpdate
- Different types of updates that can be sent while a session exists.
- SessionUpdateAgentMessage
- An agent message has been created or updated.
- SessionUpdateAgentMessageChunk
- A chunk of the agent's response being streamed.
- SessionUpdateAgentThought
- An agent thought or reasoning message has been created or updated.
- SessionUpdateAgentThoughtChunk
- A chunk of the agent's internal reasoning being streamed.
- SessionUpdateAvailableCommandsUpdate
- Available commands are ready or have changed
- SessionUpdateCodec
- Codec for SessionUpdate.
- SessionUpdateConfigOptionUpdate
- Session configuration options have been updated.
- SessionUpdateCustom
-
An unknown future or
_-prefixed SessionUpdate variant. - SessionUpdatePlanUpdate
- A content update for a plan identified by ID. See protocol docs: Agent Plan
- SessionUpdateSessionInfoUpdate
- Session metadata has been updated (title, timestamps, custom metadata)
- SessionUpdateStateUpdate
- The state of the agent's foreground work has changed.
- SessionUpdateTerminalOutputChunk
- A chunk of bytes appended to an agent-owned terminal's output.
- SessionUpdateTerminalUpdate
- An agent-owned terminal has been created or updated.
- SessionUpdateToolCallContentChunk
- A chunk of tool-call content being streamed.
- SessionUpdateToolCallUpdate
- A tool call has been created or updated.
- SessionUpdateUsageUpdate
- Context window and cost update for the session.
- SessionUpdateUserMessage
- A user message has been created or updated.
- SessionUpdateUserMessageChunk
- A chunk of the user's message being streamed.
- SetSessionConfigOptionRequest
- Request parameters for setting a session configuration option.
- SetSessionConfigOptionRequestBoolean
-
A boolean value (
type: "boolean"). - SetSessionConfigOptionRequestCodec
- Codec for SetSessionConfigOptionRequest.
- SetSessionConfigOptionRequestCustom
-
An unknown future or
_-prefixed SetSessionConfigOptionRequest variant. - SetSessionConfigOptionRequestId
-
A
SessionConfigValueIdstring value (type: "id"). - SetSessionConfigOptionResponse
-
Response to
session/set_config_optionmethod. - SetSessionConfigOptionResponseCodec
- Codec for SetSessionConfigOptionResponse.
- StateUpdate
- The state of the agent's foreground work has changed.
- StateUpdateCodec
- Codec for StateUpdate.
- StateUpdateCustom
-
An unknown future or
_-prefixed StateUpdate variant. - StateUpdateIdle
- The agent is ready to process a new prompt.
- StateUpdateRequiresAction
- Foreground work is blocked on user action.
- StateUpdateRunning
- Foreground work is in progress.
- StopReason
- Reasons why an agent stops active session work.
- StopReasonCodec
- Codec for StopReason.
- StringFormat
- String format types for string properties in elicitation schemas.
- StringFormatCodec
- Codec for StringFormat.
- StringJsonRpcId
- A string JSON-RPC identifier.
- StringMultiSelectItems
- String item schema for multi-select enum properties.
- StringMultiSelectItemsCodec
- Codec for StringMultiSelectItems.
- StringPropertySchema
- Schema for string properties in an elicitation form.
- StringPropertySchemaCodec
- Codec for StringPropertySchema.
- Terminal
- A display-only reference to an agent-owned terminal.
- TerminalCodec
- Codec for Terminal.
- TerminalExitStatus
- Exit information for an agent-owned terminal.
- TerminalExitStatusCodec
- Codec for TerminalExitStatus.
- TerminalId
- Unique identifier for an agent-owned terminal within a session.
- TerminalIdCodec
- Codec for TerminalId.
- TerminalOutput
- An authoritative replacement snapshot of terminal output bytes.
- TerminalOutputChunk
- A chunk of bytes appended to an agent-owned terminal's output.
- TerminalOutputChunkCodec
- Codec for TerminalOutputChunk.
- TerminalOutputCodec
- Codec for TerminalOutput.
- TerminalUpdate
- An upsert for the stored state of an agent-owned terminal.
- TerminalUpdateCodec
- Codec for TerminalUpdate.
- TextCommandInput
- All text that was typed after the command name is provided as input.
- TextCommandInputCodec
- Codec for TextCommandInput.
- TextContent
- Text provided to or from an LLM.
- TextContentCodec
- Codec for TextContent.
- TextResourceContents
- Text-based resource contents.
- TextResourceContentsCodec
- Codec for TextResourceContents.
- TitledMultiSelectItems
- Items definition for titled multi-select enum properties.
- TitledMultiSelectItemsCodec
- Codec for TitledMultiSelectItems.
- ToolCallContent
- Content produced by a tool call.
- ToolCallContentChunk
- A streamed item of tool-call content.
- ToolCallContentChunkCodec
- Codec for ToolCallContentChunk.
- ToolCallContentCodec
- Codec for ToolCallContent.
- ToolCallContentContent
- Standard content block (text, images, resources).
- ToolCallContentCustom
-
An unknown future or
_-prefixed ToolCallContent variant. - ToolCallContentDiff
- File modification shown as a diff.
- ToolCallContentTerminal
- A display-only reference to an agent-owned terminal.
- ToolCallId
- Unique identifier for a tool call within a session.
- ToolCallIdCodec
- Codec for ToolCallId.
- ToolCallLocation
- A file location being accessed or modified by a tool.
- ToolCallLocationCodec
- Codec for ToolCallLocation.
- ToolCallPermissionSubject
- Permission request details for a tool call.
- ToolCallPermissionSubjectCodec
- Codec for ToolCallPermissionSubject.
- ToolCallStatus
- Execution status of a tool call.
- ToolCallStatusCodec
- Codec for ToolCallStatus.
- ToolCallUpdate
- Represents an upsert for a tool call that the language model has requested.
- ToolCallUpdateCodec
- Codec for ToolCallUpdate.
- ToolKind
- Categories of tools that can be invoked.
- ToolKindCodec
- Codec for ToolKind.
- UpdateSessionNotification
- Notification containing a session update from the agent.
- UpdateSessionNotificationCodec
- Codec for UpdateSessionNotification.
- UsageUpdate
- Context window and cost update for a session.
- UsageUpdateCodec
- Codec for UsageUpdate.
- UserMessage
- A user message upsert.
- UserMessageCodec
- Codec for UserMessage.
Enums
- AcpMethodDirection
- The side that sends a protocol method.
- AcpMethodKind
- Whether a JSON-RPC method expects a response.
- AcpMethodStability
- The stability of a generated protocol method.
- AcpProtocolGeneration
- The negotiated ACP protocol generation.
- AcpV2ConnectionState
- Current draft-v2 application lifecycle state.
- AcpV2MessageKind
- Kind of message stored in a v2 snapshot.
- JsonRpcDiagnosticLevel
- The severity of a connection diagnostic.
Extension Types
- AcpAbsolutePath
- An absolute path written in POSIX, Windows drive-root, or UNC form.
- AcpDateTimeString
- An RFC 3339 date-time string that preserves its exact wire spelling.
Extensions
- AcpV2AgentHandlers on AcpV2AgentApp
- Baseline agent-side named handler conveniences.
- AcpV2AgentMethods on AcpV2AgentContext
- Baseline methods sent by an agent.
-
AcpV2BatchRecord2
on (AcpV2BatchEntry<
A> , AcpV2BatchEntry<B> ) - Practical two-entry typed record helper.
-
AcpV2BatchRecord3
on (AcpV2BatchEntry<
A> , AcpV2BatchEntry<B> , AcpV2BatchEntry<C> ) - Practical three-entry typed record helper.
- AcpV2ClientHandlers on AcpV2ClientApp
- Baseline client-side named handler conveniences.
- AcpV2ClientMethods on AcpV2ClientContext
- Baseline methods sent by a client.
-
AcpV2NotificationBatchEntry
on AcpMethodDescriptor<
P, AcpNoResult> - Creates batch notification entries directly from generated descriptors.
-
AcpV2RequestBatchEntry
on AcpMethodDescriptor<
P, R> - Creates batch request entries directly from generated descriptors.
Constants
- absolutePathCodec → const AbsolutePathCodec
- Shared codec for AbsolutePath.
- acpNoResultCodec → const AcpNoResultCodec
- The shared no-result codec for generated notification descriptors.
- agentAuthCapabilitiesCodec → const AgentAuthCapabilitiesCodec
- Shared codec for AgentAuthCapabilities.
- agentCapabilitiesCodec → const AgentCapabilitiesCodec
- Shared codec for AgentCapabilities.
- agentMessageCodec → const AgentMessageCodec
- Shared codec for AgentMessage.
- agentNotificationCodec → const AgentNotificationCodec
- Shared codec for AgentNotification.
- agentRequestCodec → const AgentRequestCodec
- Shared codec for AgentRequest.
- agentResponseCodec → const AgentResponseCodec
- Shared codec for AgentResponse.
- agentThoughtCodec → const AgentThoughtCodec
- Shared codec for AgentThought.
- annotationsCodec → const AnnotationsCodec
- Shared codec for Annotations.
- audioContentCodec → const AudioContentCodec
- Shared codec for AudioContent.
-
authLoginMethod
→ const AcpMethodDescriptor<
LoginAuthRequest, LoginAuthResponse> -
Request parameters for the
auth/loginmethod. -
authLogoutMethod
→ const AcpMethodDescriptor<
LogoutAuthRequest, LogoutAuthResponse> -
Request parameters for the
auth/logoutmethod. - authMethodAgentCodec → const AuthMethodAgentCodec
- Shared codec for AuthMethodAgent.
- authMethodCodec → const AuthMethodCodec
- Shared codec for AuthMethod.
- authMethodIdCodec → const AuthMethodIdCodec
- Shared codec for AuthMethodId.
- availableCommandCodec → const AvailableCommandCodec
- Shared codec for AvailableCommand.
- availableCommandInputCodec → const AvailableCommandInputCodec
- Shared codec for AvailableCommandInput.
- availableCommandsUpdateCodec → const AvailableCommandsUpdateCodec
- Shared codec for AvailableCommandsUpdate.
- blobResourceContentsCodec → const BlobResourceContentsCodec
- Shared codec for BlobResourceContents.
- booleanPropertySchemaCodec → const BooleanPropertySchemaCodec
- Shared codec for BooleanPropertySchema.
-
cancelRequestMethod
→ const AcpMethodDescriptor<
CancelRequestNotification, AcpNoResult> - Notification to cancel an ongoing request.
- cancelRequestNotificationCodec → const CancelRequestNotificationCodec
- Shared codec for CancelRequestNotification.
- cancelSessionNotificationCodec → const CancelSessionNotificationCodec
- Shared codec for CancelSessionNotification.
- clientCapabilitiesCodec → const ClientCapabilitiesCodec
- Shared codec for ClientCapabilities.
- clientNotificationCodec → const ClientNotificationCodec
- Shared codec for ClientNotification.
- clientRequestCodec → const ClientRequestCodec
- Shared codec for ClientRequest.
- clientResponseCodec → const ClientResponseCodec
- Shared codec for ClientResponse.
- closeSessionRequestCodec → const CloseSessionRequestCodec
- Shared codec for CloseSessionRequest.
- closeSessionResponseCodec → const CloseSessionResponseCodec
- Shared codec for CloseSessionResponse.
- commandPermissionSubjectCodec → const CommandPermissionSubjectCodec
- Shared codec for CommandPermissionSubject.
- completeElicitationNotificationCodec → const CompleteElicitationNotificationCodec
- Shared codec for CompleteElicitationNotification.
- configOptionUpdateCodec → const ConfigOptionUpdateCodec
- Shared codec for ConfigOptionUpdate.
- contentBlockCodec → const ContentBlockCodec
- Shared codec for ContentBlock.
- contentChunkCodec → const ContentChunkCodec
- Shared codec for ContentChunk.
- contentCodec → const ContentCodec
- Shared codec for Content.
- costCodec → const CostCodec
- Shared codec for Cost.
- createElicitationRequestCodec → const CreateElicitationRequestCodec
- Shared codec for CreateElicitationRequest.
- createElicitationResponseCodec → const CreateElicitationResponseCodec
- Shared codec for CreateElicitationResponse.
- deleteSessionRequestCodec → const DeleteSessionRequestCodec
- Shared codec for DeleteSessionRequest.
- deleteSessionResponseCodec → const DeleteSessionResponseCodec
- Shared codec for DeleteSessionResponse.
- diffChangeCodec → const DiffChangeCodec
- Shared codec for DiffChange.
- diffCodec → const DiffCodec
- Shared codec for Diff.
- diffFileTypeCodec → const DiffFileTypeCodec
- Shared codec for DiffFileType.
- diffPatchCodec → const DiffPatchCodec
- Shared codec for DiffPatch.
- diffPatchFormatCodec → const DiffPatchFormatCodec
- Shared codec for DiffPatchFormat.
- diffPathChangeCodec → const DiffPathChangeCodec
- Shared codec for DiffPathChange.
- diffPathPairChangeCodec → const DiffPathPairChangeCodec
- Shared codec for DiffPathPairChange.
- elicitationAcceptActionCodec → const ElicitationAcceptActionCodec
- Shared codec for ElicitationAcceptAction.
- elicitationCapabilitiesCodec → const ElicitationCapabilitiesCodec
- Shared codec for ElicitationCapabilities.
-
elicitationCompleteMethod
→ const AcpMethodDescriptor<
CompleteElicitationNotification, AcpNoResult> - Notification sent by the agent when a URL-based elicitation is complete.
- elicitationContentValueCodec → const ElicitationContentValueCodec
- Shared codec for ElicitationContentValue.
-
elicitationCreateMethod
→ const AcpMethodDescriptor<
CreateElicitationRequest, CreateElicitationResponse> - Request from the agent to elicit structured user input.
- elicitationFormCapabilitiesCodec → const ElicitationFormCapabilitiesCodec
- Shared codec for ElicitationFormCapabilities.
- elicitationFormModeCodec → const ElicitationFormModeCodec
- Shared codec for ElicitationFormMode.
- elicitationIdCodec → const ElicitationIdCodec
- Shared codec for ElicitationId.
- elicitationPropertySchemaCodec → const ElicitationPropertySchemaCodec
- Shared codec for ElicitationPropertySchema.
- elicitationRequestScopeCodec → const ElicitationRequestScopeCodec
- Shared codec for ElicitationRequestScope.
- elicitationSchemaCodec → const ElicitationSchemaCodec
- Shared codec for ElicitationSchema.
- elicitationSchemaTypeCodec → const ElicitationSchemaTypeCodec
- Shared codec for ElicitationSchemaType.
- elicitationSessionScopeCodec → const ElicitationSessionScopeCodec
- Shared codec for ElicitationSessionScope.
- elicitationUrlCapabilitiesCodec → const ElicitationUrlCapabilitiesCodec
- Shared codec for ElicitationUrlCapabilities.
- elicitationUrlModeCodec → const ElicitationUrlModeCodec
- Shared codec for ElicitationUrlMode.
- embeddedResourceCodec → const EmbeddedResourceCodec
- Shared codec for EmbeddedResource.
- embeddedResourceResourceCodec → const EmbeddedResourceResourceCodec
- Shared codec for EmbeddedResourceResource.
- enumOptionCodec → const EnumOptionCodec
- Shared codec for EnumOption.
- envVariableCodec → const EnvVariableCodec
- Shared codec for EnvVariable.
- errorCodec → const ErrorCodec
- Shared codec for Error.
- errorCodeCodec → const ErrorCodeCodec
- Shared codec for ErrorCode.
- extNotificationCodec → const ExtNotificationCodec
- Shared codec for ExtNotification.
- extRequestCodec → const ExtRequestCodec
- Shared codec for ExtRequest.
- extResponseCodec → const ExtResponseCodec
- Shared codec for ExtResponse.
- httpHeaderCodec → const HttpHeaderCodec
- Shared codec for HttpHeader.
- iconCodec → const IconCodec
- Shared codec for Icon.
- iconThemeCodec → const IconThemeCodec
- Shared codec for IconTheme.
- idleStateUpdateCodec → const IdleStateUpdateCodec
- Shared codec for IdleStateUpdate.
- imageContentCodec → const ImageContentCodec
- Shared codec for ImageContent.
- implementationCodec → const ImplementationCodec
- Shared codec for Implementation.
-
initializeMethod
→ const AcpMethodDescriptor<
InitializeRequest, InitializeResponse> - Request parameters for the initialize method.
- initializeRequestCodec → const InitializeRequestCodec
- Shared codec for InitializeRequest.
- initializeResponseCodec → const InitializeResponseCodec
- Shared codec for InitializeResponse.
- integerPropertySchemaCodec → const IntegerPropertySchemaCodec
- Shared codec for IntegerPropertySchema.
- listSessionsRequestCodec → const ListSessionsRequestCodec
- Shared codec for ListSessionsRequest.
- listSessionsResponseCodec → const ListSessionsResponseCodec
- Shared codec for ListSessionsResponse.
- loginAuthRequestCodec → const LoginAuthRequestCodec
- Shared codec for LoginAuthRequest.
- loginAuthResponseCodec → const LoginAuthResponseCodec
- Shared codec for LoginAuthResponse.
- logoutAuthRequestCodec → const LogoutAuthRequestCodec
- Shared codec for LogoutAuthRequest.
- logoutAuthResponseCodec → const LogoutAuthResponseCodec
- Shared codec for LogoutAuthResponse.
- mcpCapabilitiesCodec → const McpCapabilitiesCodec
- Shared codec for McpCapabilities.
- mcpHttpCapabilitiesCodec → const McpHttpCapabilitiesCodec
- Shared codec for McpHttpCapabilities.
- mcpServerCodec → const McpServerCodec
- Shared codec for McpServer.
- mcpServerHttpCodec → const McpServerHttpCodec
- Shared codec for McpServerHttp.
- mcpServerStdioCodec → const McpServerStdioCodec
- Shared codec for McpServerStdio.
- mcpStdioCapabilitiesCodec → const McpStdioCapabilitiesCodec
- Shared codec for McpStdioCapabilities.
- mediaTypeCodec → const MediaTypeCodec
- Shared codec for MediaType.
- messageIdCodec → const MessageIdCodec
- Shared codec for MessageId.
- multiSelectItemsCodec → const MultiSelectItemsCodec
- Shared codec for MultiSelectItems.
- multiSelectPropertySchemaCodec → const MultiSelectPropertySchemaCodec
- Shared codec for MultiSelectPropertySchema.
- newSessionRequestCodec → const NewSessionRequestCodec
- Shared codec for NewSessionRequest.
- newSessionResponseCodec → const NewSessionResponseCodec
- Shared codec for NewSessionResponse.
- numberPropertySchemaCodec → const NumberPropertySchemaCodec
- Shared codec for NumberPropertySchema.
- permissionOptionCodec → const PermissionOptionCodec
- Shared codec for PermissionOption.
- permissionOptionIdCodec → const PermissionOptionIdCodec
- Shared codec for PermissionOptionId.
- permissionOptionKindCodec → const PermissionOptionKindCodec
- Shared codec for PermissionOptionKind.
- planEntryCodec → const PlanEntryCodec
- Shared codec for PlanEntry.
- planEntryPriorityCodec → const PlanEntryPriorityCodec
- Shared codec for PlanEntryPriority.
- planEntryStatusCodec → const PlanEntryStatusCodec
- Shared codec for PlanEntryStatus.
- planIdCodec → const PlanIdCodec
- Shared codec for PlanId.
- planItemsCodec → const PlanItemsCodec
- Shared codec for PlanItems.
- planUpdateCodec → const PlanUpdateCodec
- Shared codec for PlanUpdate.
- planUpdateContentCodec → const PlanUpdateContentCodec
- Shared codec for PlanUpdateContent.
- promptAudioCapabilitiesCodec → const PromptAudioCapabilitiesCodec
- Shared codec for PromptAudioCapabilities.
- promptCapabilitiesCodec → const PromptCapabilitiesCodec
- Shared codec for PromptCapabilities.
- promptEmbeddedContextCapabilitiesCodec → const PromptEmbeddedContextCapabilitiesCodec
- Shared codec for PromptEmbeddedContextCapabilities.
- promptImageCapabilitiesCodec → const PromptImageCapabilitiesCodec
- Shared codec for PromptImageCapabilities.
- promptRequestCodec → const PromptRequestCodec
- Shared codec for PromptRequest.
- promptResponseCodec → const PromptResponseCodec
- Shared codec for PromptResponse.
- protocolLevelNotificationCodec → const ProtocolLevelNotificationCodec
- Shared codec for ProtocolLevelNotification.
- protocolVersionCodec → const ProtocolVersionCodec
- Shared codec for ProtocolVersion.
- replayFromCodec → const ReplayFromCodec
- Shared codec for ReplayFrom.
- replayFromStartCodec → const ReplayFromStartCodec
- Shared codec for ReplayFromStart.
- requestIdCodec → const RequestIdCodec
- Shared codec for RequestId.
- requestPermissionOutcomeCodec → const RequestPermissionOutcomeCodec
- Shared codec for RequestPermissionOutcome.
- requestPermissionRequestCodec → const RequestPermissionRequestCodec
- Shared codec for RequestPermissionRequest.
- requestPermissionResponseCodec → const RequestPermissionResponseCodec
- Shared codec for RequestPermissionResponse.
- requestPermissionSubjectCodec → const RequestPermissionSubjectCodec
- Shared codec for RequestPermissionSubject.
- requiresActionStateUpdateCodec → const RequiresActionStateUpdateCodec
- Shared codec for RequiresActionStateUpdate.
- resourceLinkCodec → const ResourceLinkCodec
- Shared codec for ResourceLink.
- resumeSessionRequestCodec → const ResumeSessionRequestCodec
- Shared codec for ResumeSessionRequest.
- resumeSessionResponseCodec → const ResumeSessionResponseCodec
- Shared codec for ResumeSessionResponse.
- roleCodec → const RoleCodec
- Shared codec for Role.
- runningStateUpdateCodec → const RunningStateUpdateCodec
- Shared codec for RunningStateUpdate.
-
schemaDefinitionNames
→ const Set<
String> - Every schema definition generated for ACP v2 baseline.
- schemaSourceSha256 → const String
- SHA-256 of the schema that produced this library.
- selectedPermissionOutcomeCodec → const SelectedPermissionOutcomeCodec
- Shared codec for SelectedPermissionOutcome.
- sessionAdditionalDirectoriesCapabilitiesCodec → const SessionAdditionalDirectoriesCapabilitiesCodec
- Shared codec for SessionAdditionalDirectoriesCapabilities.
-
sessionCancelMethod
→ const AcpMethodDescriptor<
CancelSessionNotification, AcpNoResult> - Notification to cancel ongoing operations for a session.
- sessionCapabilitiesCodec → const SessionCapabilitiesCodec
- Shared codec for SessionCapabilities.
-
sessionCloseMethod
→ const AcpMethodDescriptor<
CloseSessionRequest, CloseSessionResponse> - Request parameters for closing an active session.
- sessionConfigBooleanCodec → const SessionConfigBooleanCodec
- Shared codec for SessionConfigBoolean.
- sessionConfigGroupIdCodec → const SessionConfigGroupIdCodec
- Shared codec for SessionConfigGroupId.
- sessionConfigIdCodec → const SessionConfigIdCodec
- Shared codec for SessionConfigId.
- sessionConfigOptionCategoryCodec → const SessionConfigOptionCategoryCodec
- Shared codec for SessionConfigOptionCategory.
- sessionConfigOptionCodec → const SessionConfigOptionCodec
- Shared codec for SessionConfigOption.
- sessionConfigSelectCodec → const SessionConfigSelectCodec
- Shared codec for SessionConfigSelect.
- sessionConfigSelectGroupCodec → const SessionConfigSelectGroupCodec
- Shared codec for SessionConfigSelectGroup.
- sessionConfigSelectOptionCodec → const SessionConfigSelectOptionCodec
- Shared codec for SessionConfigSelectOption.
- sessionConfigSelectOptionsCodec → const SessionConfigSelectOptionsCodec
- Shared codec for SessionConfigSelectOptions.
- sessionConfigValueIdCodec → const SessionConfigValueIdCodec
- Shared codec for SessionConfigValueId.
- sessionDeleteCapabilitiesCodec → const SessionDeleteCapabilitiesCodec
- Shared codec for SessionDeleteCapabilities.
-
sessionDeleteMethod
→ const AcpMethodDescriptor<
DeleteSessionRequest, DeleteSessionResponse> -
Request parameters for deleting an existing session from
session/list. - sessionIdCodec → const SessionIdCodec
- Shared codec for SessionId.
- sessionInfoCodec → const SessionInfoCodec
- Shared codec for SessionInfo.
- sessionInfoUpdateCodec → const SessionInfoUpdateCodec
- Shared codec for SessionInfoUpdate.
- sessionListCursorCodec → const SessionListCursorCodec
- Shared codec for SessionListCursor.
-
sessionListMethod
→ const AcpMethodDescriptor<
ListSessionsRequest, ListSessionsResponse> - Request parameters for listing existing sessions.
-
sessionNewMethod
→ const AcpMethodDescriptor<
NewSessionRequest, NewSessionResponse> - Request parameters for creating a new session.
-
sessionPromptMethod
→ const AcpMethodDescriptor<
PromptRequest, PromptResponse> - Request parameters for sending a user prompt to the agent.
-
sessionRequestPermissionMethod
→ const AcpMethodDescriptor<
RequestPermissionRequest, RequestPermissionResponse> - Request for user permission to proceed with an operation.
-
sessionResumeMethod
→ const AcpMethodDescriptor<
ResumeSessionRequest, ResumeSessionResponse> - Request parameters for resuming an existing session.
-
sessionSetConfigOptionMethod
→ const AcpMethodDescriptor<
SetSessionConfigOptionRequest, SetSessionConfigOptionResponse> - Request parameters for setting a session configuration option.
- sessionUpdateCodec → const SessionUpdateCodec
- Shared codec for SessionUpdate.
-
sessionUpdateMethod
→ const AcpMethodDescriptor<
UpdateSessionNotification, AcpNoResult> - Notification containing a session update from the agent.
- setSessionConfigOptionRequestCodec → const SetSessionConfigOptionRequestCodec
- Shared codec for SetSessionConfigOptionRequest.
- setSessionConfigOptionResponseCodec → const SetSessionConfigOptionResponseCodec
- Shared codec for SetSessionConfigOptionResponse.
- stateUpdateCodec → const StateUpdateCodec
- Shared codec for StateUpdate.
- stopReasonCodec → const StopReasonCodec
- Shared codec for StopReason.
- stringFormatCodec → const StringFormatCodec
- Shared codec for StringFormat.
- stringMultiSelectItemsCodec → const StringMultiSelectItemsCodec
- Shared codec for StringMultiSelectItems.
- stringPropertySchemaCodec → const StringPropertySchemaCodec
- Shared codec for StringPropertySchema.
- terminalCodec → const TerminalCodec
- Shared codec for Terminal.
- terminalExitStatusCodec → const TerminalExitStatusCodec
- Shared codec for TerminalExitStatus.
- terminalIdCodec → const TerminalIdCodec
- Shared codec for TerminalId.
- terminalOutputChunkCodec → const TerminalOutputChunkCodec
- Shared codec for TerminalOutputChunk.
- terminalOutputCodec → const TerminalOutputCodec
- Shared codec for TerminalOutput.
- terminalUpdateCodec → const TerminalUpdateCodec
- Shared codec for TerminalUpdate.
- textCommandInputCodec → const TextCommandInputCodec
- Shared codec for TextCommandInput.
- textContentCodec → const TextContentCodec
- Shared codec for TextContent.
- textResourceContentsCodec → const TextResourceContentsCodec
- Shared codec for TextResourceContents.
- titledMultiSelectItemsCodec → const TitledMultiSelectItemsCodec
- Shared codec for TitledMultiSelectItems.
- toolCallContentChunkCodec → const ToolCallContentChunkCodec
- Shared codec for ToolCallContentChunk.
- toolCallContentCodec → const ToolCallContentCodec
- Shared codec for ToolCallContent.
- toolCallIdCodec → const ToolCallIdCodec
- Shared codec for ToolCallId.
- toolCallLocationCodec → const ToolCallLocationCodec
- Shared codec for ToolCallLocation.
- toolCallPermissionSubjectCodec → const ToolCallPermissionSubjectCodec
- Shared codec for ToolCallPermissionSubject.
- toolCallStatusCodec → const ToolCallStatusCodec
- Shared codec for ToolCallStatus.
- toolCallUpdateCodec → const ToolCallUpdateCodec
- Shared codec for ToolCallUpdate.
- toolKindCodec → const ToolKindCodec
- Shared codec for ToolKind.
- updateSessionNotificationCodec → const UpdateSessionNotificationCodec
- Shared codec for UpdateSessionNotification.
- usageUpdateCodec → const UsageUpdateCodec
- Shared codec for UsageUpdate.
- userMessageCodec → const UserMessageCodec
- Shared codec for UserMessage.
-
v2StableMethodDescriptors
→ const List<
AcpMethodDescriptorBase> - Every generated method descriptor in this lane.
Properties
- v2StableMethodRegistry → AcpMethodRegistry
-
Duplicate-checked lookup registry for this lane.
final
Functions
-
acpInProcessTransportPair<
T> ({int maximumBufferedMessages = 1024}) → AcpInProcessTransportPair< T> - Creates two bounded in-memory transport endpoints.
-
acpStdioTransport(
{NdJsonStreamOptions options = const NdJsonStreamOptions()}) → AcpDuplexStream< Object?> - Connects the current process's stdin and stdout as an ACP transport.
-
acpV2ConnectApps(
{required AcpV2AgentApp agent, required AcpV2ClientApp client, int maximumBufferedMessages = 1024}) → Future< AcpV2DirectConnectionPair> - Opens a bounded direct v2 app pair and waits for initialization.
-
acpV2CustomNotificationMethod<
P> ({required String name, required AcpMethodDirection direction, required AcpCodec< P> paramsCodec}) → AcpMethodDescriptor<P, AcpNoResult> - Creates a typed custom v2 notification descriptor.
-
acpV2CustomRequestMethod<
P, R> ({required String name, required AcpMethodDirection direction, required AcpCodec< P> paramsCodec, required AcpCodec<R> resultCodec}) → AcpMethodDescriptor<P, R> - Creates a typed custom v2 request descriptor.
-
ndJsonStream(
{required AcpWritable< List< output, required Stream<int> >List< input, NdJsonStreamOptions options = const NdJsonStreamOptions()}) → AcpDuplexStream<int> >Object?> - Adapts byte streams to newline-delimited JSON values.
Typedefs
-
AcpV2AgentConnectHandler
= FutureOr<
void> Function(AcpV2AgentConnection connection) - Runs after an agent connection becomes ready.
-
AcpV2AgentNotificationHandler<
P> = FutureOr< void> Function(AcpV2AgentNotificationContext<P> context) - Handles a typed notification received by a v2 agent.
-
AcpV2AgentRequestHandler<
P, R> = FutureOr< R> Function(AcpV2AgentRequestContext<P> context) - Handles a typed request received by a v2 agent.
-
AcpV2ClientConnectHandler
= FutureOr<
void> Function(AcpV2ClientConnection connection) - Runs after a client connection becomes ready.
-
AcpV2ClientNotificationHandler<
P> = FutureOr< void> Function(AcpV2ClientNotificationContext<P> context) - Handles a typed notification received by a v2 client.
-
AcpV2ClientRequestHandler<
P, R> = FutureOr< R> Function(AcpV2ClientRequestContext<P> context) - Handles a typed request received by a v2 client.
- NdJsonDiagnosticHandler = void Function(NdJsonDiagnostic diagnostic)
- Receives NDJSON diagnostics.
Exceptions / Errors
- A local call was blocked by capability negotiation.
- AcpV2ConnectionStateException
- A local draft-v2 lifecycle rule was violated.
- AcpV2SessionStateException
- A local v2 session operation was attempted after disposal.
- CancellationException
- A cooperative cancellation exception thrown by CancellationToken.
- JsonRpcFormatException
- A malformed JSON-RPC wire value.
- JsonRpcRequestException
- An error returned by a JSON-RPC peer or request handler.