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

    Interface Agent

    The Agent interface defines the interface that all ACP-compliant agents must implement.

    Agents are programs that use generative AI to autonomously modify code. They handle requests from clients and execute tasks using language models and tools.

    interface Agent {
        initialize(params: InitializeRequest): Promise<InitializeResponse>;
        newSession(params: NewSessionRequest): Promise<NewSessionResponse>;
        loadSession?(params: LoadSessionRequest): Promise<LoadSessionResponse>;
        setSessionMode?(
            params: SetSessionModeRequest,
        ): Promise<void | SetSessionModeResponse>;
        setSessionModel?(
            params: SetSessionModelRequest,
        ): Promise<void | SetSessionModelResponse>;
        authenticate(
            params: AuthenticateRequest,
        ): Promise<void | AuthenticateResponse>;
        prompt(params: PromptRequest): Promise<PromptResponse>;
        cancel(params: CancelNotification): Promise<void>;
        extMethod?(
            method: string,
            params: Record<string, unknown>,
        ): Promise<Record<string, unknown>>;
        extNotification?(
            method: string,
            params: Record<string, unknown>,
        ): Promise<void>;
    }

    Implemented by

    Index

    Methods

    • Establishes the connection with a client and negotiates protocol capabilities.

      This method is called once at the beginning of the connection to:

      • Negotiate the protocol version to use
      • Exchange capability information between client and agent
      • Determine available authentication methods

      The agent should respond with its supported protocol version and capabilities.

      See protocol docs: Initialization

      Parameters

      Returns Promise<InitializeResponse>

    • Creates a new conversation session with the agent.

      Sessions represent independent conversation contexts with their own history and state.

      The agent should:

      • Create a new session context
      • Connect to any specified MCP servers
      • Return a unique session ID for future requests

      May return an auth_required error if the agent requires authentication.

      See protocol docs: Session Setup

      Parameters

      Returns Promise<NewSessionResponse>

    • Loads an existing session to resume a previous conversation.

      This method is only available if the agent advertises the loadSession capability.

      The agent should:

      • Restore the session context and conversation history
      • Connect to the specified MCP servers
      • Stream the entire conversation history back to the client via notifications

      See protocol docs: Loading Sessions

      Parameters

      Returns Promise<LoadSessionResponse>

    • Sets the operational mode for a session.

      Allows switching between different agent modes (e.g., "ask", "architect", "code") that affect system prompts, tool availability, and permission behaviors.

      The mode must be one of the modes advertised in availableModes during session creation or loading. Agents may also change modes autonomously and notify the client via current_mode_update notifications.

      This method can be called at any time during a session, whether the Agent is idle or actively generating a turn.

      See protocol docs: Session Modes

      Parameters

      Returns Promise<void | SetSessionModeResponse>

    • Authenticates the client using the specified authentication method.

      Called when the agent requires authentication before allowing session creation. The client provides the authentication method ID that was advertised during initialization.

      After successful authentication, the client can proceed to create sessions with newSession without receiving an auth_required error.

      See protocol docs: Initialization

      Parameters

      Returns Promise<void | AuthenticateResponse>

    • Processes a user prompt within a session.

      This method handles the whole lifecycle of a prompt:

      • Receives user messages with optional context (files, images, etc.)
      • Processes the prompt using language models
      • Reports language model content and tool calls to the Clients
      • Requests permission to run tools
      • Executes any requested tool calls
      • Returns when the turn is complete with a stop reason

      See protocol docs: Prompt Turn

      Parameters

      Returns Promise<PromptResponse>

    • Cancels ongoing operations for a session.

      This is a notification sent by the client to cancel an ongoing prompt turn.

      Upon receiving this notification, the Agent SHOULD:

      • Stop all language model requests as soon as possible
      • Abort all tool call invocations in progress
      • Send any pending session/update notifications
      • Respond to the original session/prompt request with StopReason::Cancelled

      See protocol docs: Cancellation

      Parameters

      Returns Promise<void>

    • Extension method

      Allows the Client to send an arbitrary request that is not part of the ACP spec.

      To help avoid conflicts, it's a good practice to prefix extension methods with a unique identifier such as domain name.

      Parameters

      • method: string
      • params: Record<string, unknown>

      Returns Promise<Record<string, unknown>>

    • Extension notification

      Allows the Client to send an arbitrary notification that is not part of the ACP spec.

      Parameters

      • method: string
      • params: Record<string, unknown>

      Returns Promise<void>