@runloop/agent-axon-client
    Preparing search index...

    Module acp

    ACP (Agent Client Protocol) module for connecting to ACP-compatible agents running inside Runloop devboxes via the Axon event bus.

    Getting started: Create an ACPAxonConnection with your Axon channel, call initialize(), then use newSession() and prompt() to interact with the agent. Subscribe to streaming updates with onSessionUpdate() and narrow them using the type guard functions.

    Connection

    The main connection class and its low-level stream factory.

    ACPAxonConnection
    axonStream

    Configuration

    Options, callbacks, and listener types used when creating a connection.

    ACPAxonConnectionOptions
    AxonStreamOptions
    BaseConnectionOptions
    AxonEventListener
    CreateClientFn
    SessionUpdateListener

    Session Updates

    Type guards and narrowed types for discriminating SessionUpdate variants received via onSessionUpdate().

    AgentMessageChunkUpdate
    AgentTextChunkUpdate
    AgentThoughtChunkUpdate
    AvailableCommandsSessionUpdate
    ConfigOptionSessionUpdate
    CurrentModeSessionUpdate
    PlanSessionUpdate
    SessionInfoSessionUpdate
    ThoughtTextChunkUpdate
    ToolCallProgressSessionUpdate
    ToolCallSessionUpdate
    UsageSessionUpdate
    UserMessageChunkUpdate
    isAgentMessageChunk
    isAgentTextChunk
    isAgentThoughtChunk
    isAvailableCommandsUpdate
    isConfigOptionUpdate
    isCurrentModeUpdate
    isPlan
    isSessionInfoUpdate
    isThoughtTextChunk
    isToolCall
    isToolCallProgress
    isUsageUpdate
    isUserMessageChunk

    ACP Protocol

    Re-exported request/response types and constants from the upstream @agentclientprotocol/sdk. Use these to type method parameters.

    AgentSideConnection
    ClientSideConnection
    RequestError
    TerminalHandle
    Agent
    AxonEventView
    Client
    AcceptNesNotification
    AgentAuthCapabilities
    AgentCapabilities
    AgentNotification
    AgentRequest
    AgentResponse
    Annotations
    AnyMessage
    AudioContent
    AuthCapabilities
    AuthenticateRequest
    AuthenticateResponse
    AuthEnvVar
    AuthMethod
    AuthMethodAgent
    AuthMethodEnvVar
    AuthMethodTerminal
    AvailableCommand
    AvailableCommandInput
    AvailableCommandsUpdate
    AxonEventListener
    BlobResourceContents
    BooleanPropertySchema
    CancelNotification
    CancelRequestNotification
    ClientCapabilities
    ClientNesCapabilities
    ClientNotification
    ClientRequest
    ClientResponse
    CloseNesRequest
    CloseNesResponse
    CloseSessionRequest
    CloseSessionResponse
    ConfigOptionUpdate
    Content
    ContentBlock
    ContentChunk
    Cost
    CreateClientFn
    CreateTerminalRequest
    CreateTerminalResponse
    CurrentModeUpdate
    DidChangeDocumentNotification
    DidCloseDocumentNotification
    DidFocusDocumentNotification
    DidOpenDocumentNotification
    DidSaveDocumentNotification
    Diff
    ElicitationAcceptAction
    ElicitationAction
    ElicitationCapabilities
    ElicitationCompleteNotification
    ElicitationContentValue
    ElicitationFormCapabilities
    ElicitationFormMode
    ElicitationId
    ElicitationPropertySchema
    ElicitationRequest
    ElicitationResponse
    ElicitationSchema
    ElicitationSchemaType
    ElicitationStringType
    ElicitationUrlCapabilities
    ElicitationUrlMode
    EmbeddedResource
    EmbeddedResourceResource
    EnumOption
    EnvVariable
    Error
    ErrorCode
    ExtNotification
    ExtractedUserMessage
    ExtRequest
    ExtResponse
    FileSystemCapabilities
    ForkSessionRequest
    ForkSessionResponse
    HttpHeader
    ImageContent
    Implementation
    InitializeRequest
    InitializeResponse
    IntegerPropertySchema
    KillTerminalRequest
    KillTerminalResponse
    ListSessionsRequest
    ListSessionsResponse
    LoadSessionRequest
    LoadSessionResponse
    LogoutCapabilities
    LogoutRequest
    LogoutResponse
    McpCapabilities
    McpServer
    McpServerHttp
    McpServerSse
    McpServerStdio
    ModelId
    ModelInfo
    MultiSelectItems
    MultiSelectPropertySchema
    NesCapabilities
    NesContextCapabilities
    NesDiagnostic
    NesDiagnosticsCapabilities
    NesDiagnosticSeverity
    NesDocumentDidChangeCapabilities
    NesDocumentDidCloseCapabilities
    NesDocumentDidFocusCapabilities
    NesDocumentDidOpenCapabilities
    NesDocumentDidSaveCapabilities
    NesDocumentEventCapabilities
    NesEditHistoryCapabilities
    NesEditHistoryEntry
    NesEditSuggestion
    NesEventCapabilities
    NesExcerpt
    NesJumpCapabilities
    NesJumpSuggestion
    NesOpenFile
    NesOpenFilesCapabilities
    NesRecentFile
    NesRecentFilesCapabilities
    NesRejectReason
    NesRelatedSnippet
    NesRelatedSnippetsCapabilities
    NesRenameCapabilities
    NesRenameSuggestion
    NesRepository
    NesSearchAndReplaceCapabilities
    NesSearchAndReplaceSuggestion
    NesSuggestContext
    NesSuggestion
    NesTextEdit
    NesTriggerKind
    NesUserAction
    NesUserActionsCapabilities
    NewSessionRequest
    NewSessionResponse
    NumberPropertySchema
    PermissionOption
    PermissionOptionId
    PermissionOptionKind
    Plan
    PlanEntry
    PlanEntryPriority
    PlanEntryStatus
    Position
    PositionEncodingKind
    PromptCapabilities
    PromptRequest
    PromptResponse
    ProtocolVersion
    Range
    ReadTextFileRequest
    ReadTextFileResponse
    RejectNesNotification
    ReleaseTerminalRequest
    ReleaseTerminalResponse
    RequestId
    RequestPermissionOutcome
    RequestPermissionRequest
    RequestPermissionResponse
    ResumeSessionRequest
    ResumeSessionResponse
    Role
    SelectedPermissionOutcome
    SessionAdditionalDirectoriesCapabilities
    SessionCapabilities
    SessionCloseCapabilities
    SessionConfigBoolean
    SessionConfigGroupId
    SessionConfigId
    SessionConfigOption
    SessionConfigOptionCategory
    SessionConfigSelect
    SessionConfigSelectGroup
    SessionConfigSelectOption
    SessionConfigSelectOptions
    SessionConfigValueId
    SessionForkCapabilities
    SessionId
    SessionInfo
    SessionInfoUpdate
    SessionListCapabilities
    SessionMode
    SessionModeId
    SessionModelState
    SessionModeState
    SessionNotification
    SessionResumeCapabilities
    SessionUpdate
    SessionUpdateListener
    SetSessionConfigOptionRequest
    SetSessionConfigOptionResponse
    SetSessionModelRequest
    SetSessionModelResponse
    SetSessionModeRequest
    SetSessionModeResponse
    StartNesRequest
    StartNesResponse
    StopReason
    Stream
    StringFormat
    StringPropertySchema
    SuggestNesRequest
    SuggestNesResponse
    SystemEvent
    Terminal
    TerminalExitStatus
    TerminalOutputRequest
    TerminalOutputResponse
    TextContent
    TextDocumentContentChangeEvent
    TextDocumentSyncKind
    TextResourceContents
    TimelineEventListener
    TitledMultiSelectItems
    ToolCall
    ToolCallContent
    ToolCallId
    ToolCallLocation
    ToolCallStatus
    ToolCallUpdate
    ToolKind
    UnstructuredCommandInput
    UntitledMultiSelectItems
    Usage
    UsageUpdate
    WaitForTerminalExitRequest
    WaitForTerminalExitResponse
    WorkspaceFolder
    WriteTextFileRequest
    WriteTextFileResponse
    AGENT_METHODS
    classifyACPAxonEvent
    CLIENT_METHODS
    PROTOCOL_VERSION
    axonStream
    createCustomEventGuard
    extractACPUserMessage
    isACPProtocolEvent
    isACPProtocolEventType
    isAgentErrorEvent
    isAgentLogEvent
    isAgentMessageChunk
    isAgentTextChunk
    isAgentThoughtChunk
    isAudioContent
    isAvailableCommandsUpdate
    isBrokerErrorEvent
    isConfigOptionUpdate
    isCurrentModeUpdate
    isDevboxLifecycleEvent
    isElicitationCompleteEvent
    isElicitationRequestEvent
    isElicitationResponseEvent
    isEmbeddedResourceContent
    isImageContent
    isInitializeEvent
    isNewSessionEvent
    isPlan
    isPromptEvent
    isResourceLinkContent
    isSessionInfoUpdate
    isSessionUpdateEvent
    isSystemTimelineEvent
    isTextContent
    isThoughtTextChunk
    isToolCall
    isToolCallProgress
    isTurnCompletedEvent
    isTurnStartedEvent
    isUnknownTimelineEvent
    isUsageUpdate
    isUserMessageChunk
    ndJsonStream
    tryParseSystemEvent
    tryParseTimelinePayload

    Content Blocks

    isAudioContent
    isEmbeddedResourceContent
    isImageContent
    isResourceLinkContent
    isTextContent

    Timeline

    ACPInitializeTimelineEvent
    ACPNewSessionTimelineEvent
    ACPOtherProtocolTimelineEvent
    ACPPromptTimelineEvent
    ACPSessionUpdateTimelineEvent
    CustomTimelineEvent
    ExtractedACPUserMessage
    SystemTimelineEvent
    UnknownTimelineEvent
    ACPProtocolTimelineEvent
    ACPTimelineEvent
    AgentErrorTimelineEvent
    AgentLogTimelineEvent
    BrokerErrorTimelineEvent
    DevboxLifecycleTimelineEvent
    ElicitationCompleteTimelineEvent
    ElicitationTimelineEvent
    TimelineEventListener
    TurnCompletedTimelineEvent
    TurnStartedTimelineEvent
    classifyACPAxonEvent
    createCustomEventGuard
    extractACPUserMessage
    isACPProtocolEvent
    isACPProtocolEventType
    isAgentErrorEvent
    isAgentLogEvent
    isBrokerErrorEvent
    isDevboxLifecycleEvent
    isElicitationCompleteEvent
    isElicitationRequestEvent
    isElicitationResponseEvent
    isInitializeEvent
    isNewSessionEvent
    isPromptEvent
    isSessionUpdateEvent
    isSystemTimelineEvent
    isTurnCompletedEvent
    isTurnStartedEvent
    isUnknownTimelineEvent
    tryParseSystemEvent
    tryParseTimelinePayload