Agent Client Protocol - v0.28.0
    Preparing search index...

      Agent Client Protocol - v0.28.0

      Classes

      AgentContext
      ClientContext
      SessionBuilder
      ActiveSession
      AgentApp
      ClientApp
      AgentSideConnection
      TerminalHandle
      ClientSideConnection
      RequestError

      Interfaces

      AcpConnection
      Client
      Agent

      Type Aliases

      ActiveSessionMessage
      AppOptions
      ParamsParser
      AgentHandlerContext
      ClientHandlerContext
      AgentRequestHandler
      AgentNotificationHandler
      ClientRequestHandler
      ClientNotificationHandler
      AgentRequestHandlersByMethod
      AgentRequestMethod
      AgentNotificationHandlersByMethod
      AgentNotificationMethod
      ClientRequestHandlersByMethod
      ClientRequestMethod
      ClientNotificationHandlersByMethod
      ClientNotificationMethod
      AgentRequestParamsByMethod
      AgentRequestResponsesByMethod
      AgentNotificationParamsByMethod
      ClientRequestParamsByMethod
      ClientRequestResponsesByMethod
      ClientNotificationParamsByMethod
      AnyMessage
      AnyRequest
      AnyResponse
      AnyNotification
      Result
      ErrorResponse
      MaybePromise
      AgentRequest
      RequestId
      WriteTextFileRequest
      SessionId
      ReadTextFileRequest
      RequestPermissionRequest
      ToolCallUpdate
      ToolCallId
      ToolKind
      ToolCallStatus
      ToolCallContent
      ContentBlock
      Annotations
      Role
      TextContent
      ImageContent
      AudioContent
      EmbeddedResourceResource
      TextResourceContents
      BlobResourceContents
      EmbeddedResource
      Content
      Diff
      TerminalId
      Terminal
      ToolCallLocation
      PermissionOption
      PermissionOptionId
      PermissionOptionKind
      CreateTerminalRequest
      EnvVariable
      TerminalOutputRequest
      ReleaseTerminalRequest
      WaitForTerminalExitRequest
      KillTerminalRequest
      CreateElicitationRequest
      ElicitationSessionScope
      ElicitationRequestScope
      ElicitationSchema
      ElicitationSchemaType
      ElicitationPropertySchema
      StringFormat
      EnumOption
      StringPropertySchema
      NumberPropertySchema
      IntegerPropertySchema
      BooleanPropertySchema
      MultiSelectItems
      UntitledMultiSelectItems
      ElicitationStringType
      TitledMultiSelectItems
      MultiSelectPropertySchema
      ElicitationFormMode
      ElicitationId
      ElicitationUrlMode
      ConnectMcpRequest
      McpServerAcpId
      MessageMcpRequest
      McpConnectionId
      DisconnectMcpRequest
      ExtRequest
      AgentResponse
      InitializeResponse
      ProtocolVersion
      AgentCapabilities
      PromptCapabilities
      McpCapabilities
      SessionCapabilities
      SessionListCapabilities
      SessionDeleteCapabilities
      SessionAdditionalDirectoriesCapabilities
      SessionForkCapabilities
      SessionResumeCapabilities
      SessionCloseCapabilities
      AgentAuthCapabilities
      LogoutCapabilities
      ProvidersCapabilities
      NesCapabilities
      NesEventCapabilities
      NesDocumentEventCapabilities
      NesDocumentDidOpenCapabilities
      NesDocumentDidChangeCapabilities
      TextDocumentSyncKind
      NesDocumentDidCloseCapabilities
      NesDocumentDidSaveCapabilities
      NesDocumentDidFocusCapabilities
      NesContextCapabilities
      NesRecentFilesCapabilities
      NesRelatedSnippetsCapabilities
      NesEditHistoryCapabilities
      NesUserActionsCapabilities
      NesOpenFilesCapabilities
      NesDiagnosticsCapabilities
      PositionEncodingKind
      AuthMethod
      AuthMethodId
      AuthEnvVar
      AuthMethodEnvVar
      AuthMethodTerminal
      AuthMethodAgent
      Implementation
      AuthenticateResponse
      ListProvidersResponse
      ProviderInfo
      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
      StartNesResponse
      SuggestNesResponse
      NesSuggestion
      NesTextEdit
      Range
      Position
      NesEditSuggestion
      NesJumpSuggestion
      NesRenameSuggestion
      NesSearchAndReplaceSuggestion
      CloseNesResponse
      ExtResponse
      MessageMcpResponse
      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
      CompleteElicitationNotification
      MessageMcpNotification
      ExtNotification
      ClientRequest
      InitializeRequest
      ClientCapabilities
      FileSystemCapabilities
      PlanCapabilities
      AuthCapabilities
      ElicitationCapabilities
      ElicitationFormCapabilities
      ElicitationUrlCapabilities
      ClientNesCapabilities
      NesJumpCapabilities
      NesRenameCapabilities
      NesSearchAndReplaceCapabilities
      AuthenticateRequest
      ListProvidersRequest
      SetProviderRequest
      DisableProviderRequest
      LogoutRequest
      NewSessionRequest
      McpServer
      HttpHeader
      McpServerHttp
      McpServerSse
      McpServerAcp
      McpServerStdio
      LoadSessionRequest
      ListSessionsRequest
      DeleteSessionRequest
      ForkSessionRequest
      ResumeSessionRequest
      CloseSessionRequest
      SetSessionModeRequest
      SetSessionConfigOptionRequest
      PromptRequest
      StartNesRequest
      WorkspaceFolder
      NesRepository
      SuggestNesRequest
      NesTriggerKind
      NesSuggestContext
      NesRecentFile
      NesRelatedSnippet
      NesExcerpt
      NesEditHistoryEntry
      NesUserAction
      NesOpenFile
      NesDiagnostic
      NesDiagnosticSeverity
      CloseNesRequest
      ClientResponse
      WriteTextFileResponse
      ReadTextFileResponse
      RequestPermissionResponse
      RequestPermissionOutcome
      SelectedPermissionOutcome
      CreateTerminalResponse
      TerminalOutputResponse
      TerminalExitStatus
      ReleaseTerminalResponse
      WaitForTerminalExitResponse
      KillTerminalResponse
      CreateElicitationResponse
      ElicitationContentValue
      ElicitationAcceptAction
      ConnectMcpResponse
      DisconnectMcpResponse
      ClientNotification
      CancelNotification
      DidOpenDocumentNotification
      DidChangeDocumentNotification
      TextDocumentContentChangeEvent
      DidCloseDocumentNotification
      DidSaveDocumentNotification
      DidFocusDocumentNotification
      AcceptNesNotification
      RejectNesNotification
      NesRejectReason
      CancelRequestNotification
      Stream

      Variables

      methods
      AGENT_METHODS
      CLIENT_METHODS
      PROTOCOL_VERSION

      Functions

      agent
      client
      ndJsonStream

      Settings

      Member Visibility

      On This Page

      Classes
      Interfaces
      Type Aliases
      ActiveSessionMessageAppOptionsParamsParserAgentHandlerContextClientHandlerContextAgentRequestHandlerAgentNotificationHandlerClientRequestHandlerClientNotificationHandlerAgentRequestHandlersByMethodAgentRequestMethodAgentNotificationHandlersByMethodAgentNotificationMethodClientRequestHandlersByMethodClientRequestMethodClientNotificationHandlersByMethodClientNotificationMethodAgentRequestParamsByMethodAgentRequestResponsesByMethodAgentNotificationParamsByMethodClientRequestParamsByMethodClientRequestResponsesByMethodClientNotificationParamsByMethodAnyMessageAnyRequestAnyResponseAnyNotificationResultErrorResponseMaybePromiseAgentRequestRequestIdWriteTextFileRequestSessionIdReadTextFileRequestRequestPermissionRequestToolCallUpdateToolCallIdToolKindToolCallStatusToolCallContentContentBlockAnnotationsRoleTextContentImageContentAudioContentResourceLinkEmbeddedResourceResourceTextResourceContentsBlobResourceContentsEmbeddedResourceContentDiffTerminalIdTerminalToolCallLocationPermissionOptionPermissionOptionIdPermissionOptionKindCreateTerminalRequestEnvVariableTerminalOutputRequestReleaseTerminalRequestWaitForTerminalExitRequestKillTerminalRequestCreateElicitationRequestElicitationSessionScopeElicitationRequestScopeElicitationSchemaElicitationSchemaTypeElicitationPropertySchemaStringFormatEnumOptionStringPropertySchemaNumberPropertySchemaIntegerPropertySchemaBooleanPropertySchemaMultiSelectItemsUntitledMultiSelectItemsElicitationStringTypeTitledMultiSelectItemsMultiSelectPropertySchemaElicitationFormModeElicitationIdElicitationUrlModeConnectMcpRequestMcpServerAcpIdMessageMcpRequestMcpConnectionIdDisconnectMcpRequestExtRequestAgentResponseInitializeResponseProtocolVersionAgentCapabilitiesPromptCapabilitiesMcpCapabilitiesSessionCapabilitiesSessionListCapabilitiesSessionDeleteCapabilitiesSessionAdditionalDirectoriesCapabilitiesSessionForkCapabilitiesSessionResumeCapabilitiesSessionCloseCapabilitiesAgentAuthCapabilitiesLogoutCapabilitiesProvidersCapabilitiesNesCapabilitiesNesEventCapabilitiesNesDocumentEventCapabilitiesNesDocumentDidOpenCapabilitiesNesDocumentDidChangeCapabilitiesTextDocumentSyncKindNesDocumentDidCloseCapabilitiesNesDocumentDidSaveCapabilitiesNesDocumentDidFocusCapabilitiesNesContextCapabilitiesNesRecentFilesCapabilitiesNesRelatedSnippetsCapabilitiesNesEditHistoryCapabilitiesNesUserActionsCapabilitiesNesOpenFilesCapabilitiesNesDiagnosticsCapabilitiesPositionEncodingKindAuthMethodAuthMethodIdAuthEnvVarAuthMethodEnvVarAuthMethodTerminalAuthMethodAgentImplementationAuthenticateResponseListProvidersResponseProviderInfoLlmProtocolProviderCurrentConfigSetProviderResponseDisableProviderResponseLogoutResponseNewSessionResponseSessionModeStateSessionModeIdSessionModeSessionConfigOptionSessionConfigIdSessionConfigOptionCategorySessionConfigValueIdSessionConfigSelectOptionsSessionConfigSelectOptionSessionConfigSelectGroupSessionConfigGroupIdSessionConfigSelectSessionConfigBooleanLoadSessionResponseListSessionsResponseSessionInfoDeleteSessionResponseForkSessionResponseResumeSessionResponseCloseSessionResponseSetSessionModeResponseSetSessionConfigOptionResponsePromptResponseStopReasonUsageStartNesResponseSuggestNesResponseNesSuggestionNesTextEditRangePositionNesEditSuggestionNesJumpSuggestionNesRenameSuggestionNesSearchAndReplaceSuggestionCloseNesResponseExtResponseMessageMcpResponseErrorErrorCodeAgentNotificationSessionNotificationSessionUpdateMessageIdContentChunkToolCallPlanEntryPlanEntryPriorityPlanEntryStatusPlanPlanUpdateContentPlanIdPlanItemsPlanFilePlanMarkdownPlanUpdatePlanRemovedAvailableCommandAvailableCommandInputUnstructuredCommandInputAvailableCommandsUpdateCurrentModeUpdateConfigOptionUpdateSessionInfoUpdateCostUsageUpdateCompleteElicitationNotificationMessageMcpNotificationExtNotificationClientRequestInitializeRequestClientCapabilitiesFileSystemCapabilitiesPlanCapabilitiesAuthCapabilitiesElicitationCapabilitiesElicitationFormCapabilitiesElicitationUrlCapabilitiesClientNesCapabilitiesNesJumpCapabilitiesNesRenameCapabilitiesNesSearchAndReplaceCapabilitiesAuthenticateRequestListProvidersRequestSetProviderRequestDisableProviderRequestLogoutRequestNewSessionRequestMcpServerHttpHeaderMcpServerHttpMcpServerSseMcpServerAcpMcpServerStdioLoadSessionRequestListSessionsRequestDeleteSessionRequestForkSessionRequestResumeSessionRequestCloseSessionRequestSetSessionModeRequestSetSessionConfigOptionRequestPromptRequestStartNesRequestWorkspaceFolderNesRepositorySuggestNesRequestNesTriggerKindNesSuggestContextNesRecentFileNesRelatedSnippetNesExcerptNesEditHistoryEntryNesUserActionNesOpenFileNesDiagnosticNesDiagnosticSeverityCloseNesRequestClientResponseWriteTextFileResponseReadTextFileResponseRequestPermissionResponseRequestPermissionOutcomeSelectedPermissionOutcomeCreateTerminalResponseTerminalOutputResponseTerminalExitStatusReleaseTerminalResponseWaitForTerminalExitResponseKillTerminalResponseCreateElicitationResponseElicitationContentValueElicitationAcceptActionConnectMcpResponseDisconnectMcpResponseClientNotificationCancelNotificationDidOpenDocumentNotificationDidChangeDocumentNotificationTextDocumentContentChangeEventDidCloseDocumentNotificationDidSaveDocumentNotificationDidFocusDocumentNotificationAcceptNesNotificationRejectNesNotificationNesRejectReasonCancelRequestNotificationStream
      Variables
      Functions