ExMCP.ACP.Envelope (ex_mcp v1.0.0-rc.0)

View Source

Pure JSON-RPC 2.0 envelope builders for ACP messages.

Method-specific modules should own their payload shapes. This module owns only the repeated JSON-RPC frame so request builders can stay pipe-friendly:

Envelope.request("session/new")
|> Envelope.with_params(params)
|> Envelope.with_id(id)

Summary

Functions

error(id, error)

Builds a JSON-RPC error response from an error map.

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

Builds a JSON-RPC error response from code, message, and optional data.

notification(method, params \\ %{})

Builds a JSON-RPC notification envelope.

request(method)

Builds a JSON-RPC request envelope without params.

request(method, params)

Builds a JSON-RPC request envelope with params.

request(method, params, id)

Builds a JSON-RPC request envelope with params and id.

response(id, result)

Builds a JSON-RPC success response envelope.

with_id(envelope, id)

Adds an id to an existing JSON-RPC envelope.

with_params(envelope, params)

Adds params to an existing JSON-RPC envelope.

Functions

error(id, error)

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

Builds a JSON-RPC error response from an error map.

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

@spec error(integer() | String.t() | nil, integer(), String.t(), any()) :: map()

Builds a JSON-RPC error response from code, message, and optional data.

notification(method, params \\ %{})

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

Builds a JSON-RPC notification envelope.

request(method)

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

Builds a JSON-RPC request envelope without params.

request(method, params)

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

Builds a JSON-RPC request envelope with params.

request(method, params, id)

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

Builds a JSON-RPC request envelope with params and id.

response(id, result)

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

Builds a JSON-RPC success response envelope.

with_id(envelope, id)

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

Adds an id to an existing JSON-RPC envelope.

with_params(envelope, params)

@spec with_params(map(), map()) :: map()

Adds params to an existing JSON-RPC envelope.