ExMCP.ACP.Protocol (ex_mcp v0.9.2)

View Source

ACP-specific message encoding.

Delegates JSON-RPC 2.0 framing to ExMCP.Internal.Protocol and adds ACP method-specific encoding on top.

ACP uses integer protocol versions (default: 1) rather than MCP's date-based strings.

Summary

Functions

Encodes an authenticate request.

Encodes a JSON-RPC error response.

Encodes a response to a fs/read_text_file request from the agent.

Encodes a response to a fs/write_text_file request from the agent.

Encodes a logout request. Stabilized in ACP spec May 21, 2026.

Encodes a response to a session/request_permission request from the agent.

Encodes a JSON-RPC success response.

Encodes a session/cancel notification (no id field).

Encodes a session/close request. Stabilized in ACP spec April 23, 2026.

Encodes a session/list request. Stabilized in ACP spec March 9, 2026.

Encodes a session/load request to load an existing session and replay history.

Encodes a session/prompt request.

Encodes a session/resume request. Stabilized in ACP spec April 22, 2026.

Encodes a session/set_config_option request.

Encodes a session/set_mode request.

Generates a unique request ID.

Parses a raw JSON-RPC message without validation.

Functions

encode_authenticate(method_id_or_params \\ %{})

@spec encode_authenticate(String.t() | map()) :: map()

Encodes an authenticate request.

ACP v1 authentication uses a "methodId" selected from the agent's authMethods initialize response. A map may still be passed for adapter compatibility.

Parameters

  • method_id_or_params — auth method ID string or full params map

encode_error(code, message, data \\ nil, id)

Encodes a JSON-RPC error response.

encode_file_read_response(id, content)

@spec encode_file_read_response(integer() | String.t(), String.t()) :: map()

Encodes a response to a fs/read_text_file request from the agent.

encode_file_write_response(id)

@spec encode_file_write_response(integer() | String.t()) :: map()

Encodes a response to a fs/write_text_file request from the agent.

encode_initialize(client_info, capabilities \\ nil, protocol_version \\ 1)

@spec encode_initialize(map(), map() | nil, pos_integer()) :: map()

Encodes an initialize request.

Parameters

  • client_info%{"name" => ..., "version" => ...}
  • capabilities — client capabilities map (optional)
  • protocol_version — integer (default: 1)

encode_logout()

@spec encode_logout() :: map()

Encodes a logout request. Stabilized in ACP spec May 21, 2026.

encode_permission_response(id, response)

@spec encode_permission_response(integer() | String.t(), map()) :: map()

Encodes a response to a session/request_permission request from the agent.

encode_response(result, id)

Encodes a JSON-RPC success response.

encode_session_cancel(session_id)

@spec encode_session_cancel(String.t()) :: map()

Encodes a session/cancel notification (no id field).

encode_session_close(session_id)

@spec encode_session_close(String.t()) :: map()

Encodes a session/close request. Stabilized in ACP spec April 23, 2026.

encode_session_list(opts \\ [])

@spec encode_session_list(keyword()) :: map()

Encodes a session/list request. Stabilized in ACP spec March 9, 2026.

encode_session_load(session_id, cwd \\ nil, mcp_servers \\ nil)

@spec encode_session_load(String.t(), String.t() | nil, [map()] | nil) :: map()

Encodes a session/load request to load an existing session and replay history.

encode_session_new(cwd \\ nil, mcp_servers \\ nil)

@spec encode_session_new(String.t() | nil, [map()] | nil) :: map()

Encodes a session/new request.

encode_session_prompt(session_id, content_blocks)

@spec encode_session_prompt(String.t(), [map()]) :: map()

Encodes a session/prompt request.

encode_session_resume(session_id, cwd \\ nil, mcp_servers \\ nil)

@spec encode_session_resume(String.t(), String.t() | nil, [map()] | nil) :: map()

Encodes a session/resume request. Stabilized in ACP spec April 22, 2026.

encode_session_set_config_option(session_id, config_id, value)

@spec encode_session_set_config_option(String.t(), String.t(), any()) :: map()

Encodes a session/set_config_option request.

encode_session_set_mode(session_id, mode_id)

@spec encode_session_set_mode(String.t(), String.t()) :: map()

Encodes a session/set_mode request.

generate_id()

Generates a unique request ID.

parse_message(data)

Parses a raw JSON-RPC message without validation.