The schema file can be downloaded directly from the latest GitHub
release.
Agent
Defines the interface that all ACP-compliant agents must implement. Agents are programs that use generative AI to autonomously modify code. They handle requests from clients and execute tasks using language models and tools.authenticate
Authenticates the client using the specified authentication method. Called when the agent requires authentication before allowing session creation. The client provides an authentication method ID that was advertised during initialization and whose type defines theauthenticate flow.
After successful authentication, the client can proceed to create sessions with
session/new without receiving an auth_required (-32000) error.
See protocol docs: Initialization
AuthenticateRequest
Request parameters for the authenticate method. Specifies which authentication method to use. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
The ID of the authentication method to use.
Must be one of the methods advertised in the initialize response.
AuthenticateResponse
Response to theauthenticate method.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
initialize
Establishes the connection with a client and negotiates protocol capabilities. This method is called once at the beginning of the connection to:- Negotiate the protocol version to use
- Exchange capability information between client and agent
- Determine available authentication methods
InitializeRequest
Request parameters for the initialize method. Sent by the client to establish connection and negotiate capabilities. See protocol docs: Initialization Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Capabilities supported by the client.
- Default:
{"fs":{"readTextFile":false,"writeTextFile":false},"terminal":false,"auth":{"terminal":false}}
Implementation | null
Information about the Client name and version sent to the Agent.Note: in future versions of the protocol, this will be required.
InitializeResponse
Response to theinitialize method.
Contains the negotiated protocol version and agent capabilities.
See protocol docs: Initialization
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Capabilities supported by the agent.
- Default:
{"loadSession":false,"promptCapabilities":{"image":false,"audio":false,"embeddedContext":false},"mcpCapabilities":{"http":false,"sse":false},"sessionCapabilities":{},"auth":{}}
Implementation | null
Information about the Agent name and version sent to the Client.Note: in future versions of the protocol, this will be required.
Authentication methods supported by the agent.
- Default:
[]
The protocol version the client specified if supported by the agent,
or the latest protocol version supported by the agent.The client should disconnect, if it doesn’t support this version.
logout
Logs out of the current authenticated state. After a successful logout, all new sessions will require authentication. There is no guarantee about the behavior of already running sessions.LogoutRequest
Request parameters for the logout method. Terminates the current authenticated session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
LogoutResponse
Response to thelogout method.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/cancel
Cancels ongoing operations for a session. This is a notification sent by the client to cancel an ongoing prompt turn. Upon receiving this notification, the Agent SHOULD:- Stop all language model requests as soon as possible
- Abort all tool call invocations in progress
- Send any pending
session/updatenotifications - Respond to the original
session/promptrequest with thecancelledstop reason
CancelNotification
Notification to cancel ongoing operations for a session. See protocol docs: Cancellation Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/close
Closes an active session and frees up any resources associated with it. This method is only available if the agent advertises thesessionCapabilities.close capability.
The agent must cancel any ongoing work (as if session/cancel was called)
and then free up any resources associated with the session.
CloseSessionRequest
Request parameters for closing an active session. If supported, the agent must cancel any ongoing work related to the session (treat it as ifsession/cancel was called) and then free up any resources
associated with the session.
Only available if the Agent supports the sessionCapabilities.close capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
CloseSessionResponse
Response from closing a session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/delete
Deletes an existing session fromsession/list.
This method is only available if the agent advertises the sessionCapabilities.delete capability.
DeleteSessionRequest
Request parameters for deleting an existing session fromsession/list.
Only available if the Agent supports the sessionCapabilities.delete capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
DeleteSessionResponse
Response from deleting a session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/list
Lists existing sessions known to the agent. This method is only available if the agent advertises thesessionCapabilities.list capability.
The agent should return metadata about sessions with optional filtering and pagination support.
ListSessionsRequest
Request parameters for listing existing sessions. Only available if the Agent supports thesessionCapabilities.list capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Opaque cursor token from a previous response’s nextCursor field for cursor-based pagination
ListSessionsResponse
Response from listing sessions. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Opaque cursor token. If present, pass this in the next request’s cursor parameter
to fetch the next page. If absent, there are no more results.
session/load
Loads an existing session to resume a previous conversation. This method is only available if the agent advertises theloadSession capability.
The agent should:
- Restore the session context and conversation history
- Connect to the specified MCP servers
- Stream the entire conversation history back to the client via notifications
LoadSessionRequest
Request parameters for loading an existing session. Only available if the Agent supports theloadSession capability.
See protocol docs: Loading Sessions
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Additional workspace roots to activate for this session. Each path must be absolute.When omitted or empty, no additional roots are activated. When non-empty,
this is the complete resulting additional-root list for the loaded
session. It may differ from any previously used or reported list as long as
the request
cwd matches the session’s cwd.SystemPrompt | null
System-level instructions for the loaded session.Optional. Omitted and
null are equivalent. The Agent may then keep a
system prompt it stored with the session or use its default instructions.
Clients MUST only send this when the Agent advertises
sessionCapabilities.systemPrompt, and SHOULD send the same value they used
when the session was created.LoadSessionResponse
Response from loading an existing session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigOption[] | null
Initial session configuration options if supported by the Agent.
SessionModeState | null
Initial mode state if supported by the AgentSee protocol docs: Session Modes
session/new
Creates a new conversation session with the agent. Sessions represent independent conversation contexts with their own history and state. The agent should:- Create a new session context
- Connect to any specified MCP servers
- Return a unique session ID for future requests
auth_required (-32000) error if the agent requires authentication.
See protocol docs: Session Setup
NewSessionRequest
Request parameters for creating a new session. See protocol docs: Creating a Session Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Additional workspace roots for this session. Each path must be absolute.These expand the session’s filesystem scope without changing
cwd, which
remains the base for relative paths. When omitted or empty, no
additional roots are activated for the new session.SystemPrompt | null
System-level instructions for the new session.Optional. Omitted and
null are equivalent and mean the Agent uses its
own default instructions. Clients MUST only send this when the Agent
advertises sessionCapabilities.systemPrompt.NewSessionResponse
Response from creating a new session. See protocol docs: Creating a Session Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigOption[] | null
Initial session configuration options if supported by the Agent.
SessionModeState | null
Initial mode state if supported by the AgentSee protocol docs: Session Modes
Unique identifier for the created session.Used in all subsequent requests for this conversation.
session/prompt
Processes a user prompt within a session. This method handles the whole lifecycle of a prompt:- Receives user messages with optional context (files, images, etc.)
- Processes the prompt using language models
- Reports language model content and tool calls to the Clients
- Requests permission to run tools
- Executes any requested tool calls
- Returns when the turn is complete with a stop reason
PromptRequest
Request parameters for sending a user prompt to the agent. Contains the user’s message and any additional context. See protocol docs: User Message Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
The blocks of content that compose the user’s message.As a baseline, the Agent MUST support
text and resource_link content blocks,
while other variants are optionally enabled via PromptCapabilities.The Client MUST adapt its interface according to PromptCapabilities.The client MAY include referenced pieces of context as either
resource or resource_link content blocks.When available, resource is preferred
as it avoids extra round-trips and allows the message to include
pieces of context from sources the agent may not have access to.PromptResponse
Response from processing a user prompt. See protocol docs: Check for Completion Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/resume
Resumes an existing session without returning previous messages. This method is only available if the agent advertises thesessionCapabilities.resume capability.
The agent should resume the session context, allowing the conversation to continue
without replaying the message history (unlike session/load).
ResumeSessionRequest
Request parameters for resuming an existing session. Resumes an existing session without returning previous messages (unlikesession/load).
This is useful for agents that can resume sessions but don’t implement full session loading.
Only available if the Agent supports the sessionCapabilities.resume capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Additional workspace roots to activate for this session. Each path must be absolute.When omitted or empty, no additional roots are activated. When non-empty,
this is the complete resulting additional-root list for the resumed
session. It may differ from any previously used or reported list as long as
the request
cwd matches the session’s cwd.List of MCP servers to connect to for this session.
SystemPrompt | null
System-level instructions for the resumed session.Optional. Omitted and
null are equivalent. The Agent may then keep a
system prompt it stored with the session or use its default instructions.
Clients MUST only send this when the Agent advertises
sessionCapabilities.systemPrompt, and SHOULD send the same value they used
when the session was created.ResumeSessionResponse
Response from resuming an existing session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigOption[] | null
Initial session configuration options if supported by the Agent.
SessionModeState | null
Initial mode state if supported by the AgentSee protocol docs: Session Modes
session/set_config_option
Sets the current value for a session configuration option.SetSessionConfigOptionRequest
Request parameters for setting a session configuration option. Type: Union Shared properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
A
SessionConfigValueId string value.This is the default when type is absent on the wire. Unknown type
values with string payloads also gracefully deserialize into this
variant.SetSessionConfigOptionResponse
Response tosession/set_config_option method.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/set_mode
Sets the current mode for a session. Allows switching between different agent modes (e.g., “ask”, “architect”, “code”) that affect system prompts, tool availability, and permission behaviors. The mode must be one of the modes advertised inavailableModes during session
creation or loading. Agents may also change modes autonomously and notify the
client via current_mode_update notifications.
This method can be called at any time during a session, whether the Agent is
idle or actively generating a response.
See protocol docs: Session Modes
SetSessionModeRequest
Request parameters for setting a session mode. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SetSessionModeResponse
Response tosession/set_mode method.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Client
Defines the interface that ACP-compliant clients must implement. Clients are typically code editors (IDEs, text editors) that provide the interface between users and AI agents. They manage the environment, handle user interactions, and control access to resources.elicitation/complete
Notification that a URL-based elicitation has completed. See protocol docs: ElicitationCompleteElicitationNotification
Notification sent by the agent when a URL-based elicitation is complete. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: Extensibilityelicitation/create
Requests structured user input via a form or URL. See protocol docs: ElicitationCreateElicitationRequest
Request from the agent to elicit structured user input. The agent sends this to the client to request information from the user, either via a form or by directing them to a URL. Elicitations are tied to a session (optionally a tool call) or a request. Type: Union Shared properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityForm-based elicitation where the client renders a form from the provided schema.Alternatives (
anyOf):Custom or future elicitation mode.Values beginning with
_ are reserved for implementation-specific
extensions. Unknown values that do not begin with _ are reserved for
future ACP variants.Clients that do not understand this mode should preserve the raw payload
when storing, replaying, proxying, or forwarding elicitation requests.
They MUST NOT render it as a known elicitation mode.Alternatives (anyOf):CreateElicitationResponse
Response from the client to an elicitation request. Type: Union Shared properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityCustom or future elicitation action.Values beginning with
_ are reserved for implementation-specific
extensions. Unknown values that do not begin with _ are reserved for
future ACP variants.Agents that do not understand this action should preserve the raw
payload when storing, replaying, proxying, or forwarding elicitation
responses. They MUST NOT treat it as a known elicitation action.fs/read_text_file
Reads content from a text file in the client’s file system. Only available if the client advertises thefs.readTextFile capability.
Allows the agent to access file contents within the client’s environment.
See protocol docs: Client
ReadTextFileRequest
Request to read content from a text file. Only available if the client supports thefs.readTextFile capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ReadTextFileResponse
Response containing the contents of a text file. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
fs/write_text_file
Writes content to a text file in the client’s file system. Only available if the client advertises thefs.writeTextFile capability.
Allows the agent to create or modify files within the client’s environment.
See protocol docs: Client
WriteTextFileRequest
Request to write content to a text file. Only available if the client supports thefs.writeTextFile capability.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
WriteTextFileResponse
Response tofs/write_text_file
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/request_permission
Requests permission from the user for a tool call operation. Called by the agent when it needs user authorization before executing a potentially sensitive operation. The client should present the options to the user and return their decision. If the client cancels the prompt turn viasession/cancel, it MUST
respond to this request with the cancelled outcome.
See protocol docs: Requesting Permission
RequestPermissionRequest
Request for user permission to execute a tool call. Sent when the agent needs authorization before performing a sensitive operation. See protocol docs: Requesting Permission Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
RequestPermissionResponse
Response to a permission request. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
session/update
Handles session update notifications from the agent. This is a notification endpoint (no response expected) that receives real-time updates about session progress, including message chunks, tool calls, and execution plans. Note: Clients SHOULD continue accepting tool call updates even after sending asession/cancel notification, as the agent may send final
updates before responding with the cancelled stop reason.
See protocol docs: Agent Reports Output
SessionNotification
Notification containing a session update from the agent. Used to stream real-time progress and results during prompt processing. See protocol docs: Agent Reports Output Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
terminal/create
Executes a command in a new terminal Only available if theterminal Client capability is set to true.
Returns a TerminalId that can be used with other terminal methods
to get the current output, wait for exit, and kill the command.
The TerminalId can also be used to embed the terminal in a tool call
by using terminal tool call content.
The Agent is responsible for releasing the terminal by using the terminal/release
method.
See protocol docs: Terminals
CreateTerminalRequest
Request to create a new terminal and execute a command. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Environment variables for the command.
Maximum number of output bytes to retain.When the limit is exceeded, the Client truncates from the beginning of the output
to stay within the limit.The Client MUST ensure truncation happens at a character boundary to maintain valid
string output, even if this means the retained output is slightly less than the
specified limit.
- Minimum:
0
CreateTerminalResponse
Response containing the ID of the created terminal. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
terminal/kill
Kills the terminal command without releasing the terminal Whileterminal/release will also kill the command, this method will keep
the TerminalId valid so it can be used with other methods.
This method can be helpful when implementing command timeouts which terminate
the command as soon as elapsed, and then get the final output so it can be sent
to the model.
Note: Call terminal/release when TerminalId is no longer needed.
See protocol docs: Terminals
KillTerminalRequest
Request to kill a terminal without releasing it. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
KillTerminalResponse
Response toterminal/kill method
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
terminal/output
Gets the terminal output and exit status Returns the current content in the terminal without waiting for the command to exit. If the command has already exited, the exit status is included. See protocol docs: TerminalsTerminalOutputRequest
Request to get the current output and status of a terminal. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
TerminalOutputResponse
Response containing the terminal output and exit status. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
TerminalExitStatus | null
Exit status if the command has completed.
terminal/release
Releases a terminal The command is killed if it hasn’t exited yet. Useterminal/wait_for_exit
to wait for the command to exit before releasing the terminal.
After release, the TerminalId can no longer be used with other terminal/* methods,
but tool calls that already contain it, continue to display its output.
The terminal/kill method can be used to terminate the command without releasing
the terminal, allowing the Agent to call terminal/output and other methods.
See protocol docs: Terminals
ReleaseTerminalRequest
Request to release a terminal and free its resources. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ReleaseTerminalResponse
Response to terminal/release method Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
terminal/wait_for_exit
Waits for the terminal command to exit and return its exit status See protocol docs: TerminalsWaitForTerminalExitRequest
Request to wait for a terminal command to exit. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
WaitForTerminalExitResponse
Response containing the exit status of a terminal command. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Protocol Level
Defines the interface that ACP-compliant agents and clients must both implement. Notifications whose methods start with ‘/cancel_request` notification. If an agent or client receives notifications starting with ’$/’ it is free to ignore the notification.$/cancel_request
Cancels an ongoing request. This is a notification sent by the side that sent a request to cancel that request. Upon receiving this notification, the receiver:- MAY cancel the corresponding request activity and all nested activities
- MAY send any pending notifications.
- MUST send one of these responses for the original request:
- Valid response with appropriate data (partial results or cancellation marker)
- Error response with code
-32800(Cancelled)
CancelRequestNotification
Notification to cancel an ongoing request. See protocol docs: Cancellation Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
AgentAuthCapabilities
Authentication-related capabilities supported by the agent. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
LogoutCapabilities | null
Whether the agent supports the logout method.Optional. Omitted or
null both mean the agent does not advertise support.
Supplying \{\} means the agent supports the logout method.AgentCapabilities
Capabilities supported by the agent. Advertised during initialization to inform the client about available features and content types. See protocol docs: Agent Capabilities Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Authentication-related capabilities supported by the agent.
- Default:
{}
MCP capabilities supported by the agent.
- Default:
{"http":false,"sse":false}
Prompt capabilities supported by the agent.
- Default:
{"image":false,"audio":false,"embeddedContext":false}
Session lifecycle and prompt capabilities advertised by the agent.
- Default:
{}
Annotations
Optional annotations for the client. The client can use annotations to inform how objects are used or displayed Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Role[] | null
Intended recipients for this content, such as the user or assistant.
AudioContent
Audio provided to or from an LLM. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Annotations | null
Optional annotations that help clients decide how to display or route this content.
AuthCapabilities
Authentication capabilities supported by the client. Advertised during initialization to inform the agent which authentication method types the client can handle. This governs opt-in types that require additional client-side support. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Whether the client supports
terminal authentication methods.The client should set this to true only when it can reproduce the
configured agent invocation in an interactive terminal. When true, the
agent may include terminal entries in its authentication methods.- Default:
false
AuthMethod
Describes an available authentication method. Thetype field acts as the discriminator in the serialized JSON form.
When no type is present, the method is treated as agent.
Type: Union
Client runs the configured agent program as a separate interactive
process, without passing this method to
authenticate.Agent handles authentication itself through
authenticate.This is the default when no type is specified.AuthMethodAgent
Agent handles authentication itself throughauthenticate.
This is the default authentication method type.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
AuthMethodId
Typed identifier used for auth method values on the wire. Type:string
AuthMethodTerminal
Terminal-based authentication method. The client runs the configured agent program as a separate interactive process for the user to authenticate via a TUI. Agents MUST advertise this method only when the client enabled its terminal authentication capability. A zero exit status signals success. Any other termination signals failure. The client MUST NOT pass this method toauthenticate.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Additional environment variables to set on the configured agent invocation for terminal auth.
These values override same-named variables in the base launch configuration.
AvailableCommand
Information about a command. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
AvailableCommandInput | null
Input for the command if required
AvailableCommandInput
The input specification for a command. All text that was typed after the command name is provided as input. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
AvailableCommandsUpdate
Available commands are ready or have changed Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
BlobResourceContents
Binary resource contents. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
BooleanConfigOptionCapabilities
Capabilities for boolean session configuration options. Supplying\{\} means the client supports boolean session configuration options.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
BooleanPropertySchema
Schema for boolean properties in an elicitation form. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityDefault value.Optional. Omitted and
null are equivalent and mean no default value is provided.Human-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.Optional title for the property.Optional. Omitted and
null are equivalent and mean no title is provided.ClientCapabilities
Capabilities supported by the client. Advertised during initialization to inform the agent about available features and methods. See protocol docs: Client Capabilities Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Authentication capabilities supported by the client.
Determines which authentication method types the agent may include
in its
InitializeResponse.- Default:
{"terminal":false}
ElicitationCapabilities | null
Elicitation capabilities supported by the client.
Determines which elicitation modes the agent may use.Optional. Omitted or
null both mean the client does not advertise
elicitation support.File system capabilities supported by the client.
Determines which file operations the agent can request.
- Default:
{"readTextFile":false,"writeTextFile":false}
ClientSessionCapabilities | null
Session-related capabilities supported by the client.Optional. Omitted or
null both mean the client does not advertise any
session-related extensions.ClientSessionCapabilities
Session-related capabilities supported by the client. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
CompactionCapabilities | null
Support for ID-addressed context compaction updates. Omitted or
null
means unsupported. \{\} advertises the complete compaction contract.Config option capabilities supported by the client.Omitted or
null both mean the client does not advertise support for any
config option extensions.NoticeCapabilities | null
Support for live user-facing
notice session updates.Optional. Omitted or null both mean the client does not advertise support.
Supplying \{\} means the client can present notices to the user.CompactionCapabilities
Client support for ID-addressed context compaction updates. Type:object
CompactionId
Unique identifier for a context compaction within a session. Type:string
CompactionStatus
Lifecycle state of a context compaction. Type: UnionCustom or future compaction status.Values beginning with
_ are reserved for implementation-specific
extensions. Other unknown values are reserved for future ACP statuses.CompactionSummaryChunk
A content block appended to a compaction’s summary. A first-seen ID creates an in-progress compaction. Chunks append in receive order. Agents MUST only send this update when the Client advertised thesession.compaction Client capability.
Type: Object
Properties:
CompactionUpdate
A context compaction upsert. The first notification fixes the compaction’s timeline position. Later updates with the same ID patch that entity in place. Agents MUST only send this update when the Client advertised thesession.compaction Client capability.
summary, error, and _meta have patch semantics: omission leaves the
stored value unchanged, null clears it, and a concrete value replaces it.
summary: [] also clears the summary.
Type: Object
Properties:
ContentBlock[] | null
Complete replacement user-displayable summary content for the compaction.
ConfigOptionUpdate
Session configuration options have been updated. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Content
Standard content block (text, images, resources). Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ContentBlock
Content blocks represent displayable information in the Agent Client Protocol. Content blocks appear in:- User prompts sent via
session/prompt - Language model output streamed through
session/updatenotifications - Progress updates and results from tool calls
Text content. May be plain text or formatted with Markdown.All agents MUST support text content blocks in prompts.
Clients SHOULD render this text as Markdown.
Images for visual context or analysis.Requires the
image prompt capability when included in prompts.Audio data for transcription or analysis.Requires the
audio prompt capability when included in prompts.References to resources that the agent can access.All agents MUST support resource links in prompts.
Complete resource contents embedded directly in the message.Preferred for including context as it avoids extra round-trips.Requires the
embeddedContext prompt capability when included in prompts.ContentChunk
A streamed item of content Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
MessageId | null
A unique identifier for the message this chunk belongs to.All chunks belonging to the same message share the same
messageId.
A change in messageId indicates a new message has started.Cost
Cost information for a session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Unit of
amount: an ISO 4217 currency code (e.g., “USD”, “EUR”) for money, or another
unit such as “credits”.CurrentModeUpdate
The current mode of the session has changed See protocol docs: Session Modes Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Diff
A diff representing file modifications. Shows changes to files in a format suitable for display in the client UI. See protocol docs: Content Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ElicitationAcceptAction
The user accepted the elicitation and provided content. Type: Object Properties:ElicitationCapabilities
Elicitation capabilities supported by the client. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityElicitationFormCapabilities | null
Whether the client supports form-based elicitation.Optional. Omitted and
null are equivalent and mean form support is not advertised.
Supplying \{\} explicitly advertises form support.ElicitationUrlCapabilities | null
Whether the client supports URL-based elicitation.Optional. Omitted or
null both mean the client does not advertise support.
Supplying \{\} means the client supports URL-based elicitation.ElicitationContentValue
Allowed wire representations forElicitationContentValue.
Type: Union
ElicitationFormCapabilities
Form-based elicitation capabilities. Supplying\{\} means the client supports form-based elicitation.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityElicitationFormMode
Form-based elicitation mode where the client renders a form from the provided schema. Type: Union Shared properties: Variants:Tied to a specific JSON-RPC request outside of a session
(e.g., during auth/configuration phases before any session is started).
ElicitationId
Unique identifier for an elicitation. Type:string
ElicitationPropertySchema
Property schema for elicitation form fields. Each variant corresponds to a JSON Schema"type" value.
Single-select enums use type: "string" with enum or oneOf set.
Multi-select enums use type: "array".
Type: Union
Custom or future elicitation property schema.Values beginning with
_ are reserved for implementation-specific
extensions. Unknown values that do not begin with _ are reserved for
future ACP variants.Clients that do not understand this property schema type should preserve
the raw schema when storing, replaying, proxying, or forwarding
elicitation requests. They MUST NOT render it as a known input control.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). Type: Object Properties:ElicitationSchema
Type-safe elicitation schema for requesting structured user input. This represents a JSON Schema object with primitive-typed properties, as required by the elicitation specification. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityOptional description of what this schema represents.Optional. Omitted and
null are equivalent and mean no schema description is provided.List of required property names.Optional. Omitted and
null are equivalent and mean no property names are required.Optional title for the schema.Optional. Omitted and
null are equivalent and mean no title is provided.Type discriminator. Always
"object".- Default:
"object"
ElicitationSchemaType
Type discriminator for elicitation schemas. Type: UnionElicitationSessionScope
Session-scoped elicitation, optionally tied to a specific tool call. WhentoolCallId is set, the elicitation is tied to a specific tool call.
This is useful when an agent receives an elicitation from an MCP server
during a tool call and needs to redirect it to the user.
Type: Object
Properties:
ToolCallId | null
Optional tool call within the session.Optional. Omitted and
null are equivalent and mean the elicitation is scoped to the
session without a specific tool call.ElicitationUrlCapabilities
URL-based elicitation capabilities. Supplying\{\} means the client supports URL-based elicitation.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityElicitationUrlMode
URL-based elicitation mode where the client directs the user to a URL. Type: Union Shared properties: Variants:Tied to a specific JSON-RPC request outside of a session
(e.g., during auth/configuration phases before any session is started).
EmbeddedResource
The contents of a resource, embedded into a prompt or tool call result. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Annotations | null
Optional annotations that help clients decide how to display or route this content.
EmbeddedResourceResource
Resource content that can be embedded in a message. Type: UnionEnumOption
A titled enum option with a const value, human-readable title, and optional description. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityHuman-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.EnvVariable
An environment variable to set when launching an MCP server. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Error
JSON-RPC error object. Represents an error that occurred during method execution, following the JSON-RPC 2.0 error object specification with optional additional data. See protocol docs: JSON-RPC Error Object Type: Object Properties:A number indicating the error type that occurred. This must be an integer as
defined in the JSON-RPC specification.
Optional primitive or structured value that contains additional information
about the error. This may include debugging information or context-specific
details.
A string providing a short description of the error. The message should be
limited to a concise single sentence.
ErrorCode
Predefined error codes for common JSON-RPC and ACP-specific errors. Standard errors use the JSON-RPC 2.0 codes. ACP-specific errors use the JSON-RPC server-error range (-32000 to -32099), and request cancellation uses -32800 from the range LSP reserves (-32899 to -32800). Type: UnionParse error: Invalid JSON was received by the server. An error occurred on
the server while parsing the JSON text.
Request cancelled: Execution of the method was aborted either due to a
cancellation request from the caller or because of resource constraints or
shutdown.
ExtNotification
Allows either side 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. See protocol docs: ExtensibilityExtRequest
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. See protocol docs: ExtensibilityExtResponse
Allows for sending an arbitrary response to an extension request that is not part of the ACP spec. Extension methods provide a way to add custom functionality while maintaining protocol compatibility. See protocol docs: ExtensibilityFileSystemCapabilities
File system capabilities that a client may support. See protocol docs: FileSystem Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
HttpHeader
An HTTP header to set when making requests to the MCP server. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ImageContent
An image provided to or from an LLM. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Annotations | null
Optional annotations that help clients decide how to display or route this content.
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. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Intended for programmatic or logical use, but can be used as a display
name fallback if title isn’t present.
Intended for UI and end-user contexts and optimized to be human-readable
and easily understood.If not provided, the name should be used for display.
Version of the implementation. Can be displayed to the user or used
for debugging or metrics purposes. (e.g. “1.0.0”).
IntegerPropertySchema
Schema for integer properties in an elicitation form. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityDefault value.Optional. Omitted and
null are equivalent and mean no default value is provided.Human-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.Maximum value (inclusive).Optional. Omitted and
null are equivalent and mean there is no inclusive upper bound.Minimum value (inclusive).Optional. Omitted and
null are equivalent and mean there is no inclusive lower bound.Optional title for the property.Optional. Omitted and
null are equivalent and mean no title is provided.LogoutCapabilities
Logout capabilities supported by the agent. Supplying\{\} means the agent supports the logout method.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
McpCapabilities
MCP capabilities supported by the agent Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
McpServer
Configuration for connecting to an MCP (Model Context Protocol) server. MCP servers provide tools and context that the agent can use when processing prompts. See protocol docs: MCP Servers Type: UnionHTTP transport configurationOnly available when the Agent capabilities indicate
mcp_capabilities.http is true.SSE transport configurationOnly available when the Agent capabilities indicate
mcp_capabilities.sse is true.McpServerHttp
HTTP transport configuration for MCP. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
McpServerSse
SSE transport configuration for MCP. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
McpServerStdio
Stdio transport configuration for MCP. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
MessageId
Unique identifier for a message within a session. Type:string
MultiSelectItems
Items for a multi-select (array) property schema. Type: UnionTitled multi-select items with human-readable labels.As in MCP, titled items omit
type and are identified by anyOf.MultiSelectPropertySchema
Schema for multi-select (array) properties in an elicitation form. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityDefault selected values.Optional. Omitted and
null are equivalent and mean no default selections are provided.Human-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.Maximum number of items to select.Optional. Omitted and
null are equivalent and mean there is no maximum selection count.- Minimum:
0
Minimum number of items to select.Optional. Omitted and
null are equivalent and mean there is no minimum selection count.- Minimum:
0
Optional title for the property.Optional. Omitted and
null are equivalent and mean no title is provided.Notice
Fire-and-forget information for the user. Notices are live events rather than session history. Agents must not rely on a notice being received, displayed, or seen by the user. Agents MUST only send notices when the Client advertised thesession.notices Client capability. Otherwise, Agents may use an agent
message when the information should still be surfaced to the user.
See RFD: Session Notices
Type: Object
Properties:
Metadata scoped to this notice.Omitted and
null are equivalent and mean no metadata was supplied.Optional plain-text detail or guidance.Omitted and
null are equivalent and mean no description was supplied.NoticeCapabilities
Client support for presenting live notices to the user. Type:object
NoticeSeverity
Severity hint for a session notice. Type: UnionCustom or future notice severity.Values beginning with
_ are reserved for implementation-specific
extensions. Other unknown values are reserved for future ACP severities.NumberPropertySchema
Schema for number (floating-point) properties in an elicitation form. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityDefault value.Optional. Omitted and
null are equivalent and mean no default value is provided.Human-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.Maximum value (inclusive).Optional. Omitted and
null are equivalent and mean there is no inclusive upper bound.Minimum value (inclusive).Optional. Omitted and
null are equivalent and mean there is no inclusive lower bound.Optional title for the property.Optional. Omitted and
null are equivalent and mean no title is provided.PermissionOption
An option presented to the user when requesting permission. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
PermissionOptionId
Unique identifier for a permission option. Type:string
PermissionOptionKind
The type of permission option being presented to the user. Helps clients choose appropriate icons and UI treatment. Type: UnionPlan
An execution plan for accomplishing complex tasks. Plans consist of multiple entries representing individual tasks or goals. Agents report plans to clients to provide visibility into their execution strategy. Plans can evolve during execution as the agent discovers new requirements or completes tasks. See protocol docs: Agent Plan Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
The list of tasks to be accomplished.When updating a plan, the agent must send a complete list of all entries
with their current status. The client replaces the entire plan with each update.
PlanEntry
A single entry in the execution plan. Represents a task or goal that the assistant intends to accomplish as part of fulfilling the user’s request. See protocol docs: Plan Entries Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
The relative importance of this task.
Used to indicate which tasks are most critical to the overall goal.
PlanEntryPriority
Priority levels for plan entries. Used to indicate the relative importance or urgency of different tasks in the execution plan. See protocol docs: Plan Entries Type: UnionPlanEntryStatus
Status of a plan entry in the execution flow. Tracks the lifecycle of each task from planning through completion. See protocol docs: Plan Entries Type: UnionPromptCapabilities
Prompt capabilities supported by the agent insession/prompt requests.
Baseline agent functionality requires support for text
and resource_link content blocks in prompt requests.
Other variants must be explicitly opted in to.
Capabilities for different types of content in prompt requests.
Indicates which content types beyond the baseline (text and resource links)
the agent can process.
See protocol docs: Prompt Capabilities
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Agent supports embedded context in
session/prompt requests.When enabled, the Client is allowed to include resource content blocks
in prompt requests for pieces of context that are referenced in the message.- Default:
false
ProtocolVersion
Protocol version identifier. This version is only bumped for breaking changes. Non-breaking changes should be introduced via capabilities. Type:integer (uint16)
RequestId
JSON RPC Request Id An identifier established by the Client that MUST contain a String, Number, or NULL value if included. If it is not included it is assumed to be a notification. The value SHOULD normally not be Null [1] and Numbers SHOULD NOT contain fractional parts [2] The Server MUST reply with the same value in the Response object if included. This member is used to correlate the context between the two objects. [1] The use of Null as a value for the id member in a Request object is discouraged, because this specification uses a value of Null for Responses with an unknown id. Also, because JSON-RPC 1.0 uses an id value of Null for Notifications this could cause confusion in handling. [2] Fractional parts may be problematic, since many decimal fractions cannot be represented exactly as binary fractions. Type: UnionRequestPermissionOutcome
The outcome of a permission request. Type: UnionThe prompt turn was cancelled before the user responded.When a client sends a
session/cancel notification to cancel an ongoing
prompt turn, it MUST respond to all pending session/request_permission
requests with this cancelled outcome.See protocol docs: CancellationResourceLink
A resource that the server is capable of reading, included in a prompt or tool call result. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Annotations | null
Optional annotations that help clients decide how to display or route this content.
Role
The sender or recipient of messages and data in a conversation. Type: UnionSelectedPermissionOutcome
The user selected one of the provided options. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionAdditionalDirectoriesCapabilities
Capabilities for additional session directories support. Supplying\{\} means the agent supports the additionalDirectories field on
supported session lifecycle requests. Agents that also support
session/list may return SessionInfo.additionalDirectories to report the
complete ordered additional-root list associated with a listed session.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionCapabilities
Session capabilities supported by the agent. As a baseline, all Agents MUST supportsession/new, session/prompt, session/cancel, and session/update.
Optionally, they MAY support other session methods and notifications by specifying additional capabilities.
Note: session/load is still handled by the top-level loadSession capability. This will be unified in future versions of the protocol.
See protocol docs: Session Capabilities
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Whether the agent supports
additionalDirectories on supported session lifecycle requests.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports additionalDirectories on
supported session lifecycle requests.Agents that also support session/list may return
SessionInfo.additionalDirectories to report the complete ordered
additional-root list associated with a listed session.SessionCloseCapabilities | null
Whether the agent supports
session/close.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports closing sessions.SessionDeleteCapabilities | null
Whether the agent supports
session/delete.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports deleting sessions from session/list.SessionListCapabilities | null
Whether the agent supports
session/list.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports listing sessions.SessionResumeCapabilities | null
Whether the agent supports
session/resume.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports resuming sessions.Whether the agent supports
systemPrompt on session lifecycle requests.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports systemPrompt in append mode.SessionCloseCapabilities
Capabilities for thesession/close method.
Supplying \{\} means the agent supports closing sessions.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigBoolean
A boolean on/off toggle session configuration option payload. Type: Object Properties:SessionConfigGroupId
Unique identifier for a session configuration option value group. Type:string
SessionConfigId
Unique identifier for a session configuration option. Type:string
SessionConfigOption
A session configuration option selector and its current state. Type: Union Shared properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigOptionCategory | null
Optional semantic category for this option (UX only).
SessionConfigOptionCategory
Semantic category for a session configuration option. This is intended to help Clients distinguish broadly common selectors (e.g. model selector vs session mode selector vs thought/reasoning level) for UX purposes (keyboard shortcuts, icons, placement). It MUST NOT be required for correctness. Clients MUST handle missing or unknown categories gracefully. Category names beginning with_ are free for custom use, like other ACP extension methods.
Category names that do not begin with _ are reserved for the ACP spec.
Type: Union
SessionConfigOptionsCapabilities
Session configuration option capabilities supported by the client. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Whether the client supports boolean session configuration options.Optional. Omitted or
null both mean the client does not advertise support.
Supplying \{\} means agents may include type: "boolean" entries in
configOptions, and the client may send session/set_config_option
requests with type: "boolean" and a boolean value.SessionConfigSelect
A single-value selector (dropdown) session configuration option payload. Type: Object Properties:SessionConfigSelectGroup
A group of possible values for a session configuration option. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigSelectOption
A possible value for a session configuration option. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionConfigSelectOptions
Possible values for a session configuration option. Type: UnionSessionConfigValueId
Unique identifier for a session configuration option value. Type:string
SessionDeleteCapabilities
Capabilities for thesession/delete method.
Supplying \{\} means the agent supports deleting sessions from session/list.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionId
A unique identifier for a conversation session between a client and agent. Each session has its own context, conversation history, and state, so one agent can run several independent sessions. See protocol docs: Session ID Type:string
SessionInfo
Information about a session returned by session/list Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Additional workspace roots reported for this session. Each path must be absolute.When present, this is the complete ordered additional-root list reported
by the Agent. Omitted and empty values are equivalent: the response
reports no additional roots.
SessionInfoUpdate
Update to session metadata. All fields are optional to support partial updates. Agents send this notification to update session information like title or custom metadata. Clients can use it to keep session titles and state current. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionListCapabilities
Capabilities for thesession/list method.
Supplying \{\} means the agent supports listing sessions.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionMode
A mode the agent can operate in. See protocol docs: Session Modes Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionModeId
Unique identifier for a Session Mode. Type:string
SessionModeState
The set of modes and the one currently active. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionResumeCapabilities
Capabilities for thesession/resume method.
Supplying \{\} means the agent supports resuming sessions.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionSystemPromptCapabilities
Capabilities for client-provided system prompts. Supplying\{\} means the agent supports systemPrompt on session lifecycle
requests in append mode.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Delivery modes the agent supports in addition to
append.Optional. Omitted or null both mean the agent supports only append.SessionSystemPromptModeCapabilities
System prompt delivery modes the agent supports in addition toappend.
append has no entry because every agent advertising
sessionCapabilities.systemPrompt supports it.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Whether the agent supports
override mode.Optional. Omitted or null both mean the agent does not advertise support.
Supplying \{\} means the agent supports replacing its built-in default
instructions with the client-provided system prompt.SessionSystemPromptOverrideCapabilities
Capabilities for theoverride system prompt mode.
Supplying \{\} means the agent supports replacing its built-in default
instructions with the client-provided system prompt.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
SessionUpdate
Different types of updates that can be sent during session processing. These updates provide real-time feedback about the agent’s progress. See protocol docs: Agent Reports Output Type: UnionThe agent’s execution plan for complex tasks.
See protocol docs: Agent Plan
The current mode of the session has changedSee protocol docs: Session Modes
Information for the user that is not part of session history.Agents MUST only send this update when the Client advertised
the
session.notices Client capability.A context compaction has been created or updated.Agents MUST only send this update when the Client advertised
the
session.compaction Client capability.A content block appended to a context compaction’s retained summary.Agents MUST only send this update when the Client advertised
the
session.compaction Client capability.StopReason
Reasons why an agent stops processing a prompt turn. See protocol docs: Stop Reasons Type: UnionThe turn ended because the agent reached the maximum number of allowed agent
requests between user turns.
The turn ended because the agent refused to continue. The user prompt and
everything that comes after it won’t be included in the next prompt, so this
should be reflected in the UI.
The turn was cancelled by the client via
session/cancel.This stop reason MUST be returned when the client sends a session/cancel
notification, even if the cancellation causes exceptions in underlying operations.
Agents should catch these exceptions and return this semantically meaningful
response to confirm successful cancellation.StringFormat
String format types for string properties in elicitation schemas. Type: UnionStringMultiSelectItems
String item schema for multi-select enum properties. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityStringPropertySchema
Schema for string properties in an elicitation form. Whenenum or oneOf is set, this represents a single-select enum
with "type": "string".
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityDefault value.Optional. Omitted and
null are equivalent and mean no default value is provided.Human-readable description.Optional. Omitted and
null are equivalent and mean no description is provided.Enum values for untitled single-select enums.
Optional. Omitted and
null are equivalent and mean no untitled single-select choices are
declared by enum.StringFormat | null
String format.Optional. Omitted and
null are equivalent and mean there is no format constraint.Maximum string length.Optional. Omitted and
null are equivalent and mean there is no maximum length constraint.- Minimum:
0
Minimum string length.Optional. Omitted and
null are equivalent and mean there is no minimum length constraint.- Minimum:
0
EnumOption[] | null
Titled enum options for titled single-select enums.
Optional. Omitted and
null are equivalent and mean no titled single-select choices are
declared by oneOf.Pattern the string must match.Optional. Omitted and
null are equivalent and mean there is no pattern constraint.Optional title for the property.Optional. Omitted and
null are equivalent and mean no title is provided.SystemPrompt
Client-provided system-level instructions for a session. Clients MUST only send this when the Agent advertisessessionCapabilities.systemPrompt. Agents that cannot apply it, for example
because of an unadvertised mode or an unsupported content block type, MUST
return an error instead of creating, loading, or resuming the session.
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
The system prompt content.Agents advertising the capability MUST accept
text content blocks.
Clients MUST NOT send other content block types until a future
capability allows them, and Agents MUST return an error for content
blocks they do not support.Clients MUST NOT send an empty array. Agents MAY reject one with
-32602 without creating, loading, or resuming the session.How the Agent combines
content with its own instructions.Required. Agents MUST return an error for a mode they do not support rather than
treating it as append or override.SystemPromptMode
How the Agent combines a client-provided system prompt with its own instructions. Unknown modes are preserved so they can be stored, proxied, or forwarded. An Agent MUST return an error for a mode it does not support rather than treating it asappend or override.
Type: Union
Add the content to the Agent’s own instructions rather than replacing them.Every Agent that advertises
sessionCapabilities.systemPrompt supports this mode.
Agents SHOULD give the content system-level precedence, for example in the
model’s system prompt or developer instructions rather than in user-turn
content. Where it is placed and how it is formatted is implementation-defined.Replace the Agent’s built-in default instructions with the content.This does not change tool availability, MCP servers, permissions, or session
configuration. Context the Agent supplies from the workspace or environment
MAY still be included. Clients that use this mode take responsibility for any
tool guidance or safety instructions the Agent’s default instructions
provided, and MUST only use it when the Agent advertises
sessionCapabilities.systemPrompt.mode.override.Custom or future system prompt mode.Values beginning with
_ are reserved for implementation-specific
extensions. Unknown values that do not begin with _ are reserved for
future ACP variants.Terminal
Embed a terminal created withterminal/create by its id.
The terminal must be added before calling terminal/release.
See protocol docs: Terminal
Type: Object
Properties:
The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
TerminalExitStatus
Exit status of a terminal command. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
TerminalId
Typed identifier used for terminal values on the wire. Type:string
TextContent
Text provided to or from an LLM. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Annotations | null
Optional annotations that help clients decide how to display or route this content.
TextResourceContents
Text-based resource contents. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
TitledMultiSelectItems
Items definition for titled multi-select enum properties. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.Optional. Omitted and
null are equivalent and mean no metadata.See protocol docs: ExtensibilityToolCall
Represents a tool call that the language model has requested. Tool calls are actions that the agent executes on behalf of the language model, such as reading files, executing code, or fetching data from external sources. See protocol docs: Tool Calls Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Content produced by the tool call.
The category of tool being invoked.
Helps clients choose appropriate icons and UI treatment.
File locations affected by this tool call.
Enables “follow-along” features in clients.
Programmatic name of the tool being invoked.This field is optional. Omitting it or sending
null both mean that no
tool name is available.Current execution status of the tool call.
ToolCallContent
Content produced by a tool call. Tool calls can produce different types of content including standard content blocks (text, images) or file diffs. See protocol docs: Content Type: UnionEmbed a terminal created with
terminal/create by its id.The terminal must be added before calling terminal/release.See protocol docs: TerminalToolCallId
Unique identifier for a tool call within a session. Type:string
ToolCallLocation
A file location being accessed or modified by a tool. Enables clients to implement “follow-along” features that track which files the agent is working with in real-time. See protocol docs: Following the Agent Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ToolCallStatus
Execution status of a tool call. Tool calls progress through different statuses during their lifecycle. See protocol docs: Status Type: UnionThe tool call hasn’t started running yet because the input is either streaming
or we’re awaiting approval.
ToolCallUpdate
An update to an existing tool call. Used to report progress and results as tools execute. All fields except the tool call ID are optional - only changed fields need to be included. See protocol docs: Updating Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
ToolCallContent[] | null
Replace the content collection.
ToolKind | null
Update the tool kind.
ToolCallLocation[] | null
Replace the locations collection.
Update the programmatic name of the tool being invoked.This field is optional. Omitting it or sending
null both mean that
the existing name is left unchanged.ToolCallStatus | null
Update the execution status.
ToolKind
Categories of tools that can be invoked. Tool kinds help clients choose appropriate icons and optimize how they display tool execution progress. See protocol docs: Creating Type: UnionUnstructuredCommandInput
All text that was typed after the command name is provided as input. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
UsageUpdate
Context window and cost update for a session. Type: Object Properties:The _meta property is reserved by ACP to allow clients and agents to attach additional
metadata to their interactions. Implementations MUST NOT make assumptions about values at
these keys.See protocol docs: Extensibility
Cost | null
Cumulative session cost (optional).