ACP v1 TypeScript SDK — UNSTABLE - v2.0.1
Stable ACP v1
Experimental ACP v2
Protocol Docs
GitHub
NPM
Preparing search index...
ACP v1 TypeScript SDK — UNSTABLE - v2.0.1
Classes
RequestError
MessageTooLargeError
AgentContext
ClientContext
SessionBuilder
ActiveSession
AgentApp
ClientApp
TerminalHandle
Interfaces
NdJsonStreamOptions
AgentConnectOptions
AgentConnectionLifecycle
AgentConnector
AcpConnection
AgentConnection
ClientConnection
Type Aliases
ParamsParser
AnyMessage
AnyRequest
AnyResponse
AnyNotification
JsonRpcId
SendRequestOptions
Result
ErrorResponse
MaybePromise
Stream
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
CreateElicitationRequest
ElicitationPropertySchema
MultiSelectItems
StateUpdate
IdleStateUpdate
CreateElicitationResponse
AgentRequest
RequestId
WriteTextFileRequest
SessionId
ReadTextFileRequest
RequestPermissionRequest
ToolCallUpdate
ToolCallId
ToolKind
ToolCallStatus
ToolCallContent
ContentBlock
Annotations
Role
TextContent
ImageContent
AudioContent
ResourceLink
EmbeddedResourceResource
TextResourceContents
BlobResourceContents
EmbeddedResource
Content
Diff
TerminalId
Terminal
ToolCallLocation
PermissionOption
PermissionOptionId
PermissionOptionKind
CreateTerminalRequest
EnvVariable
TerminalOutputRequest
ReleaseTerminalRequest
WaitForTerminalExitRequest
KillTerminalRequest
ElicitationSessionScope
ElicitationRequestScope
ElicitationSchema
ElicitationSchemaType
StringFormat
EnumOption
StringPropertySchema
NumberPropertySchema
IntegerPropertySchema
BooleanPropertySchema
StringMultiSelectItems
TitledMultiSelectItems
MultiSelectPropertySchema
ElicitationFormMode
ElicitationId
ElicitationUrlMode
MessageMcpRequest
McpServerAcpId
McpRequestId
ExtRequest
AgentResponse
InitializeResponse
ProtocolVersion
AgentCapabilities
PromptCapabilities
McpCapabilities
SessionCapabilities
SessionListCapabilities
SessionDeleteCapabilities
SessionAdditionalDirectoriesCapabilities
SessionSystemPromptCapabilities
SessionSystemPromptModeCapabilities
SessionSystemPromptOverrideCapabilities
SessionForkCapabilities
SessionResumeCapabilities
SessionCloseCapabilities
AgentAuthCapabilities
LogoutCapabilities
ProvidersCapabilities
AuthMethod
AuthMethodId
AuthMethodTerminal
AuthMethodAgent
Implementation
AuthenticateResponse
ListProvidersResponse
ProviderInfo
ProviderId
LlmProtocol
ProviderCurrentConfig
SetProviderResponse
DisableProviderResponse
LogoutResponse
NewSessionResponse
SessionModeState
SessionModeId
SessionMode
SessionConfigOption
SessionConfigId
SessionConfigOptionCategory
SessionConfigValueId
SessionConfigSelectOptions
SessionConfigSelectOption
SessionConfigSelectGroup
SessionConfigGroupId
SessionConfigSelect
SessionConfigBoolean
LoadSessionResponse
ListSessionsResponse
SessionInfo
DeleteSessionResponse
ForkSessionResponse
ResumeSessionResponse
CloseSessionResponse
SetSessionModeResponse
SetSessionConfigOptionResponse
PromptResponse
StopReason
Usage
ExtResponse
Error
ErrorCode
AgentNotification
SessionNotification
SessionUpdate
MessageId
ContentChunk
ToolCall
PlanEntry
PlanEntryPriority
PlanEntryStatus
Plan
PlanUpdateContent
PlanId
PlanItems
PlanFile
PlanMarkdown
PlanUpdate
PlanRemoved
AvailableCommand
AvailableCommandInput
UnstructuredCommandInput
AvailableCommandsUpdate
CurrentModeUpdate
ConfigOptionUpdate
SessionInfoUpdate
Cost
UsageUpdate
NoticeSeverity
Notice
CompactionId
CompactionStatus
CompactionUpdate
CompactionSummaryChunk
SubagentSessionCapabilities
SessionCancelCapabilities
RunningStateUpdate
ErrorStopReason
RequiresActionStateUpdate
UnknownStateUpdate
SubagentUpdate
SessionMessage
SessionMessageChunk
CompleteElicitationNotification
ExtNotification
ClientRequest
InitializeRequest
ClientCapabilities
FileSystemCapabilities
ClientSessionCapabilities
CompactionCapabilities
SessionConfigOptionsCapabilities
BooleanConfigOptionCapabilities
NoticeCapabilities
SubagentCapabilities
PlanCapabilities
AuthCapabilities
ElicitationCapabilities
ElicitationFormCapabilities
ElicitationUrlCapabilities
AuthenticateRequest
ListProvidersRequest
SetProviderRequest
DisableProviderRequest
LogoutRequest
NewSessionRequest
McpServer
HttpHeader
McpServerHttp
McpServerSse
McpServerAcp
McpServerStdio
SystemPrompt
SystemPromptMode
LoadSessionRequest
ListSessionsRequest
DeleteSessionRequest
ForkSessionRequest
ResumeSessionRequest
CloseSessionRequest
SetSessionModeRequest
SetSessionConfigOptionRequest
PromptRequest
ClientResponse
WriteTextFileResponse
ReadTextFileResponse
RequestPermissionResponse
RequestPermissionOutcome
SelectedPermissionOutcome
CreateTerminalResponse
TerminalOutputResponse
TerminalExitStatus
ReleaseTerminalResponse
WaitForTerminalExitResponse
KillTerminalResponse
ElicitationContentValue
ElicitationAcceptAction
MessageMcpResponse
McpError
ClientNotification
CancelNotification
MessageMcpNotification
CancelRequestNotification
Variables
DEFAULT_MAX_MESSAGE_BYTES
methods
CreateElicitationRequest
ElicitationPropertySchema
MultiSelectItems
StateUpdate
IdleStateUpdate
CreateElicitationResponse
AGENT_METHODS
CLIENT_METHODS
PROTOCOL_METHODS
PROTOCOL_VERSION
Functions
ndJsonStream
agent
client
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Request
Error
Message
Too
Large
Error
Agent
Context
Client
Context
Session
Builder
Active
Session
Agent
App
Client
App
Terminal
Handle
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
Request
Any
Response
Any
Notification
Json
Rpc
Id
Send
Request
Options
Result
Error
Response
Maybe
Promise
Stream
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
Create
Elicitation
Request
Elicitation
Property
Schema
Multi
Select
Items
State
Update
Idle
State
Update
Create
Elicitation
Response
Agent
Request
Request
Id
Write
Text
File
Request
Session
Id
Read
Text
File
Request
Request
Permission
Request
Tool
Call
Update
Tool
Call
Id
Tool
Kind
Tool
Call
Status
Tool
Call
Content
Content
Block
Annotations
Role
Text
Content
Image
Content
Audio
Content
Resource
Link
Embedded
Resource
Resource
Text
Resource
Contents
Blob
Resource
Contents
Embedded
Resource
Content
Diff
Terminal
Id
Terminal
Tool
Call
Location
Permission
Option
Permission
Option
Id
Permission
Option
Kind
Create
Terminal
Request
Env
Variable
Terminal
Output
Request
Release
Terminal
Request
Wait
For
Terminal
Exit
Request
Kill
Terminal
Request
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
Agent
Capabilities
Prompt
Capabilities
Mcp
Capabilities
Session
Capabilities
Session
List
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
Session
Resume
Capabilities
Session
Close
Capabilities
Agent
Auth
Capabilities
Logout
Capabilities
Providers
Capabilities
Auth
Method
Auth
Method
Id
Auth
Method
Terminal
Auth
Method
Agent
Implementation
Authenticate
Response
List
Providers
Response
Provider
Info
Provider
Id
Llm
Protocol
Provider
Current
Config
Set
Provider
Response
Disable
Provider
Response
Logout
Response
New
Session
Response
Session
Mode
State
Session
Mode
Id
Session
Mode
Session
Config
Option
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
Load
Session
Response
List
Sessions
Response
Session
Info
Delete
Session
Response
Fork
Session
Response
Resume
Session
Response
Close
Session
Response
Set
Session
Mode
Response
Set
Session
Config
Option
Response
Prompt
Response
Stop
Reason
Usage
Ext
Response
Error
Error
Code
Agent
Notification
Session
Notification
Session
Update
Message
Id
Content
Chunk
Tool
Call
Plan
Entry
Plan
Entry
Priority
Plan
Entry
Status
Plan
Plan
Update
Content
Plan
Id
Plan
Items
Plan
File
Plan
Markdown
Plan
Update
Plan
Removed
Available
Command
Available
Command
Input
Unstructured
Command
Input
Available
Commands
Update
Current
Mode
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
Running
State
Update
Error
Stop
Reason
Requires
Action
State
Update
Unknown
State
Update
Subagent
Update
Session
Message
Session
Message
Chunk
Complete
Elicitation
Notification
Ext
Notification
Client
Request
Initialize
Request
Client
Capabilities
File
System
Capabilities
Client
Session
Capabilities
Compaction
Capabilities
Session
Config
Options
Capabilities
Boolean
Config
Option
Capabilities
Notice
Capabilities
Subagent
Capabilities
Plan
Capabilities
Auth
Capabilities
Elicitation
Capabilities
Elicitation
Form
Capabilities
Elicitation
Url
Capabilities
Authenticate
Request
List
Providers
Request
Set
Provider
Request
Disable
Provider
Request
Logout
Request
New
Session
Request
Mcp
Server
Http
Header
Mcp
Server
Http
Mcp
Server
Sse
Mcp
Server
Acp
Mcp
Server
Stdio
System
Prompt
System
Prompt
Mode
Load
Session
Request
List
Sessions
Request
Delete
Session
Request
Fork
Session
Request
Resume
Session
Request
Close
Session
Request
Set
Session
Mode
Request
Set
Session
Config
Option
Request
Prompt
Request
Client
Response
Write
Text
File
Response
Read
Text
File
Response
Request
Permission
Response
Request
Permission
Outcome
Selected
Permission
Outcome
Create
Terminal
Response
Terminal
Output
Response
Terminal
Exit
Status
Release
Terminal
Response
Wait
For
Terminal
Exit
Response
Kill
Terminal
Response
Elicitation
Content
Value
Elicitation
Accept
Action
Message
Mcp
Response
Mcp
Error
Client
Notification
Cancel
Notification
Message
Mcp
Notification
Cancel
Request
Notification
Variables
DEFAULT_
MAX_
MESSAGE_
BYTES
methods
Create
Elicitation
Request
Elicitation
Property
Schema
Multi
Select
Items
State
Update
Idle
State
Update
Create
Elicitation
Response
AGENT_
METHODS
CLIENT_
METHODS
PROTOCOL_
METHODS
PROTOCOL_
VERSION
Functions
nd
Json
Stream
agent
client
Stable ACP v1
Experimental ACP v2
Protocol Docs
GitHub
NPM
ACP v1 TypeScript SDK — UNSTABLE - v2.0.1
Loading...