ACP v2 TypeScript SDK — UNSTABLE DRAFT - v2.0.0
Stable v2 features (draft)
Stable ACP v1
Draft v2 Protocol
GitHub
NPM
Preparing search index...
ACP v2 TypeScript SDK — UNSTABLE DRAFT - v2.0.0
Classes
RequestError
MessageTooLargeError
AgentProtocolRouter
AgentContext
ClientContext
SessionBuilder
ActiveSession
AgentApp
ClientApp
Interfaces
NdJsonStreamOptions
AgentConnectOptions
AgentConnectionLifecycle
AgentConnector
AcpConnection
AgentConnection
ClientConnection
Type Aliases
ParamsParser
AnyMessage
AnyCall
AnyBatchCall
AnyBatchResponse
AnyBatchMessage
AnyWireMessage
AnyRequest
AnyResponse
AnyNotification
JsonRpcId
SendRequestOptions
BatchRequest
BatchNotification
BatchEntry
BatchOutputs
Result
ErrorResponse
MaybePromise
WireStream
Stream
ExtensionMethod
UnrecognizedMethod
InitializationSnapshot
AgentBatchEntry
ClientBatchEntry
ActiveSessionMessage
AppOptions
AgentHandlerContext
AgentRequestContext
AgentNotificationContext
ClientHandlerContext
ClientRequestContext
ClientNotificationContext
AgentRequestHandler
AgentNotificationHandler
ClientRequestHandler
ClientNotificationHandler
AgentConnectHandler
ClientConnectHandler
AgentRequestHandlersByMethod
AgentRequestMethod
AgentNotificationHandlersByMethod
AgentNotificationMethod
ClientRequestHandlersByMethod
ClientRequestMethod
ClientNotificationHandlersByMethod
ClientNotificationMethod
AgentRequestParamsByMethod
AgentRequestResponsesByMethod
AgentNotificationParamsByMethod
ClientRequestParamsByMethod
ClientRequestResponsesByMethod
ClientNotificationParamsByMethod
RequestPermissionSubject
ToolCallContent
ContentBlock
DiffChange
CreateElicitationRequest
ElicitationPropertySchema
MultiSelectItems
AuthMethod
SessionConfigOption
AvailableCommandInput
SessionUpdate
IdleStateUpdate
StateUpdate
PlanUpdateContent
McpServer
ReplayFrom
SetSessionConfigOptionRequest
RequestPermissionOutcome
CreateElicitationResponse
UnknownVariant
AgentRequest
RequestId
RequestPermissionRequest
SessionId
ToolCallUpdate
ToolCallId
ToolKind
ToolCallStatus
Annotations
Role
TextContent
MediaType
ImageContent
AudioContent
Icon
IconTheme
ResourceLink
EmbeddedResourceResource
TextResourceContents
BlobResourceContents
EmbeddedResource
Content
DiffFileType
AbsolutePath
DiffPathChange
DiffPathPairChange
DiffPatch
DiffPatchFormat
Diff
TerminalId
Terminal
ToolCallLocation
ToolCallPermissionSubject
CommandPermissionSubject
PermissionOption
PermissionOptionId
PermissionOptionKind
ElicitationSessionScope
ElicitationRequestScope
ElicitationSchema
ElicitationSchemaType
StringFormat
EnumOption
StringPropertySchema
NumberPropertySchema
IntegerPropertySchema
BooleanPropertySchema
StringMultiSelectItems
TitledMultiSelectItems
MultiSelectPropertySchema
ElicitationFormMode
ElicitationId
ElicitationUrlMode
MessageMcpRequest
McpServerAcpId
McpRequestId
ExtRequest
AgentResponse
InitializeResponse
ProtocolVersion
Implementation
AgentCapabilities
SessionCapabilities
PromptCapabilities
PromptImageCapabilities
PromptAudioCapabilities
PromptEmbeddedContextCapabilities
McpCapabilities
McpStdioCapabilities
McpHttpCapabilities
McpAcpCapabilities
SessionDeleteCapabilities
SessionAdditionalDirectoriesCapabilities
SessionSystemPromptCapabilities
SessionSystemPromptModeCapabilities
SessionSystemPromptOverrideCapabilities
SessionForkCapabilities
AgentAuthCapabilities
ProvidersCapabilities
AuthMethodId
EnvVariable
AuthMethodTerminal
AuthMethodAgent
LoginAuthResponse
ListProvidersResponse
ProviderInfo
ProviderId
LlmProtocol
ProviderCurrentConfig
SetProviderResponse
DisableProviderResponse
LogoutAuthResponse
NewSessionResponse
SessionConfigId
SessionConfigOptionCategory
SessionConfigValueId
SessionConfigSelectOptions
SessionConfigSelectOption
SessionConfigSelectGroup
SessionConfigGroupId
SessionConfigSelect
SessionConfigBoolean
AvailableCommand
TextCommandInput
ListSessionsResponse
SessionInfo
SessionListCursor
DeleteSessionResponse
ForkSessionResponse
ResumeSessionResponse
CloseSessionResponse
SetSessionConfigOptionResponse
PromptResponse
MessageId
ExtResponse
Error
ErrorCode
AgentNotification
UpdateSessionNotification
ContentChunk
UserMessage
AgentMessage
AgentThought
RunningStateUpdate
ErrorStopReason
Usage
RequiresActionStateUpdate
UnknownStateUpdate
ToolCallContentChunk
TerminalOutput
TerminalExitStatus
TerminalUpdate
TerminalOutputChunk
PlanId
PlanEntry
PlanEntryPriority
PlanEntryStatus
PlanItems
PlanFile
PlanMarkdown
PlanUpdate
PlanRemoved
AvailableCommandsUpdate
ConfigOptionUpdate
SessionInfoUpdate
Cost
UsageUpdate
NoticeSeverity
Notice
CompactionId
CompactionStatus
CompactionUpdate
CompactionSummaryChunk
SubagentSessionCapabilities
SessionCancelCapabilities
SubagentUpdate
SessionMessage
SessionMessageChunk
CompleteElicitationNotification
ExtNotification
ClientRequest
InitializeRequest
ClientCapabilities
AuthCapabilities
TerminalAuthCapabilities
ElicitationCapabilities
ElicitationFormCapabilities
ElicitationUrlCapabilities
LoginAuthRequest
ListProvidersRequest
SetProviderRequest
DisableProviderRequest
LogoutAuthRequest
NewSessionRequest
HttpHeader
McpServerHttp
McpServerAcp
McpServerStdio
SystemPrompt
SystemPromptMode
ListSessionsRequest
DeleteSessionRequest
ForkSessionRequest
ResumeSessionRequest
ReplayFromStart
CloseSessionRequest
PromptRequest
ClientResponse
RequestPermissionResponse
SelectedPermissionOutcome
ElicitationContentValue
ElicitationAcceptAction
MessageMcpResponse
McpError
ClientNotification
CancelSessionNotification
MessageMcpNotification
ProtocolLevelNotification
CancelRequestNotification
Variables
DEFAULT_MAX_MESSAGE_BYTES
methods
RequestPermissionSubject
ToolCallContent
ContentBlock
DiffChange
CreateElicitationRequest
ElicitationPropertySchema
MultiSelectItems
AuthMethod
SessionConfigOption
AvailableCommandInput
SessionUpdate
IdleStateUpdate
StateUpdate
PlanUpdateContent
McpServer
ReplayFrom
SetSessionConfigOptionRequest
RequestPermissionOutcome
CreateElicitationResponse
AGENT_METHODS
CLIENT_METHODS
PROTOCOL_METHODS
PROTOCOL_VERSION
Functions
agentProtocolRouter
ndJsonStream
batchRequest
batchNotification
agent
client
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Request
Error
Message
Too
Large
Error
Agent
Protocol
Router
Agent
Context
Client
Context
Session
Builder
Active
Session
Agent
App
Client
App
Interfaces
Nd
Json
Stream
Options
Agent
Connect
Options
Agent
Connection
Lifecycle
Agent
Connector
Acp
Connection
Agent
Connection
Client
Connection
Type Aliases
Params
Parser
Any
Message
Any
Call
Any
Batch
Call
Any
Batch
Response
Any
Batch
Message
Any
Wire
Message
Any
Request
Any
Response
Any
Notification
Json
Rpc
Id
Send
Request
Options
Batch
Request
Batch
Notification
Batch
Entry
Batch
Outputs
Result
Error
Response
Maybe
Promise
Wire
Stream
Stream
Extension
Method
Unrecognized
Method
Initialization
Snapshot
Agent
Batch
Entry
Client
Batch
Entry
Active
Session
Message
App
Options
Agent
Handler
Context
Agent
Request
Context
Agent
Notification
Context
Client
Handler
Context
Client
Request
Context
Client
Notification
Context
Agent
Request
Handler
Agent
Notification
Handler
Client
Request
Handler
Client
Notification
Handler
Agent
Connect
Handler
Client
Connect
Handler
Agent
Request
Handlers
By
Method
Agent
Request
Method
Agent
Notification
Handlers
By
Method
Agent
Notification
Method
Client
Request
Handlers
By
Method
Client
Request
Method
Client
Notification
Handlers
By
Method
Client
Notification
Method
Agent
Request
Params
By
Method
Agent
Request
Responses
By
Method
Agent
Notification
Params
By
Method
Client
Request
Params
By
Method
Client
Request
Responses
By
Method
Client
Notification
Params
By
Method
Request
Permission
Subject
Tool
Call
Content
Content
Block
Diff
Change
Create
Elicitation
Request
Elicitation
Property
Schema
Multi
Select
Items
Auth
Method
Session
Config
Option
Available
Command
Input
Session
Update
Idle
State
Update
State
Update
Plan
Update
Content
Mcp
Server
Replay
From
Set
Session
Config
Option
Request
Request
Permission
Outcome
Create
Elicitation
Response
Unknown
Variant
Agent
Request
Request
Id
Request
Permission
Request
Session
Id
Tool
Call
Update
Tool
Call
Id
Tool
Kind
Tool
Call
Status
Annotations
Role
Text
Content
Media
Type
Image
Content
Audio
Content
Icon
Icon
Theme
Resource
Link
Embedded
Resource
Resource
Text
Resource
Contents
Blob
Resource
Contents
Embedded
Resource
Content
Diff
File
Type
Absolute
Path
Diff
Path
Change
Diff
Path
Pair
Change
Diff
Patch
Diff
Patch
Format
Diff
Terminal
Id
Terminal
Tool
Call
Location
Tool
Call
Permission
Subject
Command
Permission
Subject
Permission
Option
Permission
Option
Id
Permission
Option
Kind
Elicitation
Session
Scope
Elicitation
Request
Scope
Elicitation
Schema
Elicitation
Schema
Type
String
Format
Enum
Option
String
Property
Schema
Number
Property
Schema
Integer
Property
Schema
Boolean
Property
Schema
String
Multi
Select
Items
Titled
Multi
Select
Items
Multi
Select
Property
Schema
Elicitation
Form
Mode
Elicitation
Id
Elicitation
Url
Mode
Message
Mcp
Request
Mcp
Server
Acp
Id
Mcp
Request
Id
Ext
Request
Agent
Response
Initialize
Response
Protocol
Version
Implementation
Agent
Capabilities
Session
Capabilities
Prompt
Capabilities
Prompt
Image
Capabilities
Prompt
Audio
Capabilities
Prompt
Embedded
Context
Capabilities
Mcp
Capabilities
Mcp
Stdio
Capabilities
Mcp
Http
Capabilities
Mcp
Acp
Capabilities
Session
Delete
Capabilities
Session
Additional
Directories
Capabilities
Session
System
Prompt
Capabilities
Session
System
Prompt
Mode
Capabilities
Session
System
Prompt
Override
Capabilities
Session
Fork
Capabilities
Agent
Auth
Capabilities
Providers
Capabilities
Auth
Method
Id
Env
Variable
Auth
Method
Terminal
Auth
Method
Agent
Login
Auth
Response
List
Providers
Response
Provider
Info
Provider
Id
Llm
Protocol
Provider
Current
Config
Set
Provider
Response
Disable
Provider
Response
Logout
Auth
Response
New
Session
Response
Session
Config
Id
Session
Config
Option
Category
Session
Config
Value
Id
Session
Config
Select
Options
Session
Config
Select
Option
Session
Config
Select
Group
Session
Config
Group
Id
Session
Config
Select
Session
Config
Boolean
Available
Command
Text
Command
Input
List
Sessions
Response
Session
Info
Session
List
Cursor
Delete
Session
Response
Fork
Session
Response
Resume
Session
Response
Close
Session
Response
Set
Session
Config
Option
Response
Prompt
Response
Message
Id
Ext
Response
Error
Error
Code
Agent
Notification
Update
Session
Notification
Content
Chunk
User
Message
Agent
Message
Agent
Thought
Running
State
Update
Error
Stop
Reason
Usage
Requires
Action
State
Update
Unknown
State
Update
Tool
Call
Content
Chunk
Terminal
Output
Terminal
Exit
Status
Terminal
Update
Terminal
Output
Chunk
Plan
Id
Plan
Entry
Plan
Entry
Priority
Plan
Entry
Status
Plan
Items
Plan
File
Plan
Markdown
Plan
Update
Plan
Removed
Available
Commands
Update
Config
Option
Update
Session
Info
Update
Cost
Usage
Update
Notice
Severity
Notice
Compaction
Id
Compaction
Status
Compaction
Update
Compaction
Summary
Chunk
Subagent
Session
Capabilities
Session
Cancel
Capabilities
Subagent
Update
Session
Message
Session
Message
Chunk
Complete
Elicitation
Notification
Ext
Notification
Client
Request
Initialize
Request
Client
Capabilities
Auth
Capabilities
Terminal
Auth
Capabilities
Elicitation
Capabilities
Elicitation
Form
Capabilities
Elicitation
Url
Capabilities
Login
Auth
Request
List
Providers
Request
Set
Provider
Request
Disable
Provider
Request
Logout
Auth
Request
New
Session
Request
Http
Header
Mcp
Server
Http
Mcp
Server
Acp
Mcp
Server
Stdio
System
Prompt
System
Prompt
Mode
List
Sessions
Request
Delete
Session
Request
Fork
Session
Request
Resume
Session
Request
Replay
From
Start
Close
Session
Request
Prompt
Request
Client
Response
Request
Permission
Response
Selected
Permission
Outcome
Elicitation
Content
Value
Elicitation
Accept
Action
Message
Mcp
Response
Mcp
Error
Client
Notification
Cancel
Session
Notification
Message
Mcp
Notification
Protocol
Level
Notification
Cancel
Request
Notification
Variables
DEFAULT_
MAX_
MESSAGE_
BYTES
methods
Request
Permission
Subject
Tool
Call
Content
Content
Block
Diff
Change
Create
Elicitation
Request
Elicitation
Property
Schema
Multi
Select
Items
Auth
Method
Session
Config
Option
Available
Command
Input
Session
Update
Idle
State
Update
State
Update
Plan
Update
Content
Mcp
Server
Replay
From
Set
Session
Config
Option
Request
Request
Permission
Outcome
Create
Elicitation
Response
AGENT_
METHODS
CLIENT_
METHODS
PROTOCOL_
METHODS
PROTOCOL_
VERSION
Functions
agent
Protocol
Router
nd
Json
Stream
batch
Request
batch
Notification
agent
client
Stable v2 features (draft)
Stable ACP v1
Draft v2 Protocol
GitHub
NPM
ACP v2 TypeScript SDK — UNSTABLE DRAFT - v2.0.0
Loading...