Structs§
- Agent
Capabilities - Capabilities supported by the agent.
- Agent
Method Names - Names of all methods that agents handle.
- Agent
Side - Marker type representing the agent side of an ACP connection.
- Agent
Side Connection - An agent-side connection to a client.
- Annotations
- Optional annotations for the client. The client can use annotations to inform how objects are used or displayed
- Audio
Content - Audio provided to or from an LLM.
- Auth
Method - Describes an available authentication method.
- Auth
Method Id - Unique identifier for an authentication method.
- Authenticate
Request - Request parameters for the authenticate method.
- Authenticate
Response - Response to authenticate method
- Available
Command - Information about a command.
- Blob
Resource Contents - Binary resource contents.
- Cancel
Notification - Notification to cancel ongoing operations for a session.
- Client
Capabilities - Capabilities supported by the client.
- Client
Method Names - Names of all methods that clients handle.
- Client
Side - Marker type representing the client side of an ACP connection.
- Client
Side Connection - A client-side connection to an agent.
- Create
Terminal Request - Request to create a new terminal and execute a command.
- Create
Terminal Response - Response containing the ID of the created terminal.
- Diff
- A diff representing file modifications.
- Embedded
Resource - The contents of a resource, embedded into a prompt or tool call result.
- EnvVariable
- An environment variable to set when launching an MCP server.
- Error
- JSON-RPC error object.
- Error
Code - Predefined error codes for common JSON-RPC and ACP-specific errors.
- ExtNotification
- ExtRequest
- File
System Capability - File system capabilities that a client may support.
- Http
Header - An HTTP header to set when making requests to the MCP server.
- Image
Content - An image provided to or from an LLM.
- Initialize
Request - Request parameters for the initialize method.
- Initialize
Response - Response from the initialize method.
- Kill
Terminal Command Request - Request to kill a terminal command without releasing the terminal.
- Kill
Terminal Command Response - Response to terminal/kill command method
- Load
Session Request - Request parameters for loading an existing session.
- Load
Session Response - Response from loading an existing session.
- McpCapabilities
- MCP capabilities supported by the agent
- NewSession
Request - Request parameters for creating a new session.
- NewSession
Response - Response from creating a new session.
- Permission
Option - An option presented to the user when requesting permission.
- Permission
Option Id - Unique identifier for a permission option.
- Plan
- An execution plan for accomplishing complex tasks.
- Plan
Entry - A single entry in the execution plan.
- Prompt
Capabilities - Prompt capabilities supported by the agent in
session/prompt
requests. - Prompt
Request - Request parameters for sending a user prompt to the agent.
- Prompt
Response - Response from processing a user prompt.
- Protocol
Version - Protocol version identifier.
- RawValue
- Reference to a range of bytes encompassing a single valid JSON value in the input data.
- Read
Text File Request - Request to read content from a text file.
- Read
Text File Response - Response containing the contents of a text file.
- Release
Terminal Request - Request to release a terminal and free its resources.
- Release
Terminal Response - Response to terminal/release method
- Request
Permission Request - Request for user permission to execute a tool call.
- Request
Permission Response - Response to a permission request.
- Resource
Link - A resource that the server is capable of reading, included in a prompt or tool call result.
- Session
Id - A unique identifier for a conversation session between a client and agent.
- Session
Mode - A mode the agent can operate in.
- Session
Mode Id - Unique identifier for a Session Mode.
- Session
Mode State - The set of modes and the one currently active.
- Session
Notification - Notification containing a session update from the agent.
- SetSession
Mode Request - Request parameters for setting a session mode.
- SetSession
Mode Response - Response to
session/set_mode
method. - Stream
Message - A message that flows through the RPC stream.
- Stream
Receiver - A receiver for observing the message stream.
- Terminal
Exit Status - Exit status of a terminal command.
- Terminal
Id - Terminal
Output Request - Request to get the current output and status of a terminal.
- Terminal
Output Response - Response containing the terminal output and exit status.
- Text
Content - Text provided to or from an LLM.
- Text
Resource Contents - Text-based resource contents.
- Tool
Call - Represents a tool call that the language model has requested.
- Tool
Call Id - Unique identifier for a tool call within a session.
- Tool
Call Location - A file location being accessed or modified by a tool.
- Tool
Call Update - An update to an existing tool call.
- Tool
Call Update Fields - Optional fields that can be updated in a tool call.
- Wait
ForTerminal Exit Request - Request to wait for a terminal command to exit.
- Wait
ForTerminal Exit Response - Response containing the exit status of a terminal command.
- Write
Text File Request - Request to write content to a text file.
- Write
Text File Response - Response to
fs/write_text_file
Enums§
- Agent
Notification - All possible notifications that an agent can send to a client.
- Agent
Request - All possible requests that an agent can send to a client.
- Agent
Response - All possible responses that an agent can send to a client.
- Available
Command Input - The input specification for a command.
- Client
Notification - All possible notifications that a client can send to an agent.
- Client
Request - All possible requests that a client can send to an agent.
- Client
Response - All possible responses that a client can send to an agent.
- Content
Block - Content blocks represent displayable information in the Agent Client Protocol.
- Embedded
Resource Resource - Resource content that can be embedded in a message.
- McpServer
- Configuration for connecting to an MCP (Model Context Protocol) server.
- Permission
Option Kind - The type of permission option being presented to the user.
- Plan
Entry Priority - Priority levels for plan entries.
- Plan
Entry Status - Status of a plan entry in the execution flow.
- Request
Permission Outcome - The outcome of a permission request.
- Role
- The sender or recipient of messages and data in a conversation.
- Session
Update - Different types of updates that can be sent during session processing.
- Stop
Reason - Reasons why an agent stops processing a prompt turn.
- Stream
Message Content - The content of a stream message.
- Stream
Message Direction - The direction of a message in the RPC stream.
- Tool
Call Content - Content produced by a tool call.
- Tool
Call Status - Execution status of a tool call.
- Tool
Kind - Categories of tools that can be invoked.
Constants§
- AGENT_
METHOD_ NAMES - Constant containing all agent method names.
- CLIENT_
METHOD_ NAMES - Constant containing all client method names.
- V0
- V1
- VERSION
Traits§
- Agent
- Defines the interface that all ACP-compliant agents must implement.
- Client
- Defines the interface that ACP-compliant clients must implement.