Ragex.MCP.Protocol (Ragex v0.32.0)

View Source

Implements the Model Context Protocol (MCP) JSON-RPC 2.0 protocol.

Handles encoding/decoding of MCP messages and protocol-level validation.

Summary

Types

error_response()
id()
method()
notification()
params()
request()
response()

Functions

decode(json_string)

Decodes a JSON-RPC message from a string.

encode(message)

Encodes a response to JSON string.

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

Creates an error response message.

internal_error(message, id)
invalid_params(message, id)
invalid_request(id)
method_not_found(method, id)
notification(method, params \\ nil)

Creates a notification message.

notification?(message)

Validates if a message is a notification (no id).

parse_error(id)

Standard error codes and helpers.

request?(arg1)

Validates if a message is a request (has an id).

success_response(result, id)

Creates a successful response message.

Types

error_response()

@type error_response() :: %{
  jsonrpc: String.t(),
  error: %{code: integer(), message: String.t(), data: any()},
  id: id()
}

id()

@type id() :: String.t() | integer() | nil

method()

@type method() :: String.t()

notification()

@type notification() :: %{jsonrpc: String.t(), method: method(), params: params()}

params()

@type params() :: map() | list() | nil

request()

@type request() :: %{
  jsonrpc: String.t(),
  method: method(),
  params: params(),
  id: id()
}

response()

@type response() :: %{jsonrpc: String.t(), result: any(), id: id()}

Functions

decode(json_string)

@spec decode(String.t()) :: {:ok, request() | notification()} | {:error, term()}

Decodes a JSON-RPC message from a string.

encode(message)

@spec encode(response() | error_response() | notification()) ::
  {:ok, String.t()} | {:error, term()}

Encodes a response to JSON string.

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

@spec error_response(integer(), String.t(), any(), id()) :: error_response()

Creates an error response message.

internal_error(message, id)

@spec internal_error(String.t(), id()) :: error_response()

invalid_params(message, id)

@spec invalid_params(String.t(), id()) :: error_response()

invalid_request(id)

@spec invalid_request(id()) :: error_response()

method_not_found(method, id)

@spec method_not_found(method(), id()) :: error_response()

notification(method, params \\ nil)

@spec notification(method(), params()) :: notification()

Creates a notification message.

notification?(message)

@spec notification?(map()) :: boolean()

Validates if a message is a notification (no id).

parse_error(id)

@spec parse_error(id()) :: error_response()

Standard error codes and helpers.

request?(arg1)

@spec request?(map()) :: boolean()

Validates if a message is a request (has an id).

success_response(result, id)

@spec success_response(any(), id()) :: response()

Creates a successful response message.