Struct RpcError

Source

pub struct RpcError {
    pub code: i64,
    pub data: Option<Value>,
    pub message: String,
}

Expand description

RpcError

JSON schema

{
 "type": "object",
 "required": [
   "code",
   "message"
 ],
 "properties": {
   "code": {
     "description": "The error type that occurred.",
     "type": "integer"
   },
   "data": {
     "description": "Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.)."
   },
   "message": {
     "description": "A short description of the error. The message SHOULD be limited to a concise single sentence.",
     "type": "string"
   }
 }
}

Fields§

§code: i64

The error type that occurred.

§data: Option<Value>

Additional information about the error. The value of this member is defined by the sender (e.g. detailed error information, nested errors etc.).

§message: String

A short description of the error. The message SHOULD be limited to a concise single sentence.

Implementations§

Source §

impl RpcError

Source

pub fn new( error_code: RpcErrorCodes, message: String, data: Option<Value>, ) -> Self

Constructs a new RpcError with the provided arguments.

§Arguments

error_code - The JSON-RPC error code.
message - A descriptive error message.
data - Optional additional data.

§Example

use serde_json::json;
use rust_mcp_schema::{RpcError, schema_utils::RpcErrorCodes};

let error = RpcError::new(RpcErrorCodes::INVALID_PARAMS, "Invalid params!".to_string(), Some(json!({"details": "Missing method field"})));
assert_eq!(error.code, -32602);
assert_eq!(error.message, "Invalid params!".to_string());

Source

pub fn method_not_found() -> Self

Creates a new RpcError for “Method not found”.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::method_not_found();
assert_eq!(error.code, -32601);
assert_eq!(error.message, "Method not found");

Source

pub fn invalid_params() -> Self

Creates a new RpcError for “Invalid parameters”.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::invalid_params();
assert_eq!(error.code, -32602);

Source

pub fn invalid_request() -> Self

Creates a new RpcError for “Invalid request”.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::invalid_request();
assert_eq!(error.code, -32600);

Source

pub fn internal_error() -> Self

Creates a new RpcError for “Internal error”.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::internal_error();
assert_eq!(error.code, -32603);

Source

pub fn parse_error() -> Self

Creates a new RpcError for “Parse error”.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::parse_error();
assert_eq!(error.code, -32700);

Source

pub fn with_message(self, message: String) -> Self

Sets a custom error message.

§Example

use rust_mcp_schema::RpcError;

let error = RpcError::invalid_request().with_message("Request format is invalid".to_string());
assert_eq!(error.message, "Request format is invalid".to_string());

Source

pub fn with_data(self, data: Option<Value>) -> Self

Attaches optional data to the error.

§Example

use serde_json::json;
use rust_mcp_schema::RpcError;

let error = RpcError::invalid_request().with_data(Some(json!({"reason": "Missing ID"})));
assert!(error.data.is_some());