@spec application_error?(integer()) :: boolean()

Checks if the code is an ExMCP-local application error.

@spec code_for(atom(), :legacy | :modern | String.t()) ::
  integer() | {:error, :retired_error_code}

Returns an error code using the negotiated version for era-sensitive errors.

Consent denied: User denied consent for the operation

Consent required: User consent is required for the operation.

This is an ExMCP-local application error, not an MCP protocol error.

@spec error_message(integer() | atom()) :: String.t()

Returns a human-readable error message for the given error code or atom.

Examples

iex> ExMCP.Protocol.ErrorCodes.error_message(-32602)
"Invalid params"

iex> ExMCP.Protocol.ErrorCodes.error_message(:invalid_params)
"Invalid params"

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

Creates an error response map with the given code and message.

Examples

iex> ExMCP.Protocol.ErrorCodes.error_response(:invalid_params, "Missing required field: name")
%{code: -32602, message: "Invalid params: Missing required field: name"}

@spec error_response_for_version(
  atom(),
  :legacy | :modern | String.t(),
  String.t() | nil
) ::
  map() | {:error, :retired_error_code}

Builds a version-aware error response for era-sensitive MCP errors.

Header mismatch between negotiated protocol state and the request

Internal error: Internal JSON-RPC error

Invalid params: Invalid method parameter(s)

Invalid Request: The JSON sent is not a valid Request object

@spec is_mcp_error?(integer()) :: boolean()

Checks if the given error code is an MCP-specific error.

Examples

iex> ExMCP.Protocol.ErrorCodes.is_mcp_error?(-32001)
true

iex> ExMCP.Protocol.ErrorCodes.is_mcp_error?(-32602)
false

@spec is_protocol_error?(integer()) :: boolean()

Checks if the given error code is a standard JSON-RPC protocol error.

Examples

iex> ExMCP.Protocol.ErrorCodes.is_protocol_error?(-32602)
true

iex> ExMCP.Protocol.ErrorCodes.is_protocol_error?(-32001)
false

Legacy ExMCP consent-required code retained only for decoding old local errors.

Method not found: The method does not exist or is not available

A required client capability was not declared

Parse error: Invalid JSON was received by the server

ExMCP-local prompt processing error

Request cancelled: The request was cancelled by the client

Legacy resource-not-found code used by MCP 2025-11-25 and earlier.

New code should call resource_not_found/1 with the negotiated version or protocol era.

@spec resource_not_found(:legacy | :modern | String.t()) :: integer()

Returns the resource-not-found code appropriate for a protocol era or version.

@spec resource_not_found_code?(integer(), :legacy | :modern | :unknown | String.t()) ::
  boolean()

Returns whether a code represents resource-not-found for the given era.

:unknown accepts both encodings for clients that have not established the peer's protocol era yet.

Generic server error: Catch-all for server-side errors

The requested protocol version is not supported

Legacy URL-elicitation-required code from MCP 2025-11-25.

@spec url_elicitation_required(:legacy | :modern | String.t()) ::
  integer() | {:error, :retired_error_code}

Returns the URL-elicitation code for legacy peers and rejects modern emission.