MCP.Protocol (MCP Elixir SDK v1.1.0)

JSON-RPC 2.0 encoding/decoding for MCP messages.

Summary

Functions

decode(json)

Decodes a JSON string into a classified message struct.

decode_message(map)

Classifies a decoded JSON map into the appropriate message struct.

encode(message)

Encodes a message struct to a JSON string.

encode!(message)

Encodes a message struct to a JSON string, raising on error.

jsonrpc_version()

Returns the JSON-RPC version.

protocol_version()

Returns the MCP protocol version this library targets.

Functions

decode(json)

@spec decode(String.t()) ::
  {:ok,
   MCP.Protocol.Messages.Request.t()
   | MCP.Protocol.Messages.Response.t()
   | MCP.Protocol.Messages.Notification.t()}
  | {:error, MCP.Protocol.Error.t()}

Decodes a JSON string into a classified message struct.

decode_message(map)

@spec decode_message(map()) ::
  {:ok,
   MCP.Protocol.Messages.Request.t()
   | MCP.Protocol.Messages.Response.t()
   | MCP.Protocol.Messages.Notification.t()}
  | {:error, MCP.Protocol.Error.t()}

Classifies a decoded JSON map into the appropriate message struct.

encode(message)

@spec encode(
  MCP.Protocol.Messages.Request.t()
  | MCP.Protocol.Messages.Response.t()
  | MCP.Protocol.Messages.Notification.t()
) :: {:ok, String.t()} | {:error, term()}

Encodes a message struct to a JSON string.

encode!(message)

@spec encode!(
  MCP.Protocol.Messages.Request.t()
  | MCP.Protocol.Messages.Response.t()
  | MCP.Protocol.Messages.Notification.t()
) :: String.t()

Encodes a message struct to a JSON string, raising on error.

jsonrpc_version()

@spec jsonrpc_version() :: String.t()

Returns the JSON-RPC version.

protocol_version()

@spec protocol_version() :: String.t()

Returns the MCP protocol version this library targets.