Skip to main content

McpError

Struct McpError 

Source
pub struct McpError {
    pub code: McpErrorCode,
    pub message: String,
    pub data: Option<Value>,
}
Expand description

An MCP error response.

This maps directly to the JSON-RPC error object and can be serialized for transport.

Fields§

§code: McpErrorCode

The error code.

§message: String

A short description of the error.

§data: Option<Value>

Additional error data (optional).

Implementations§

Source§

impl McpError

Source

pub fn new(code: McpErrorCode, message: impl Into<String>) -> Self

Creates a new MCP error.

Source

pub fn with_data( code: McpErrorCode, message: impl Into<String>, data: Value, ) -> Self

Creates a new MCP error with additional data.

Source

pub fn parse_error(message: impl Into<String>) -> Self

Creates a parse error.

Source

pub fn invalid_request(message: impl Into<String>) -> Self

Creates an invalid request error.

Source

pub fn method_not_found(method: &str) -> Self

Creates a method not found error.

Source

pub fn invalid_params(message: impl Into<String>) -> Self

Creates an invalid params error.

Source

pub fn internal_error(message: impl Into<String>) -> Self

Creates an internal error.

Source

pub fn tool_error(message: impl Into<String>) -> Self

Creates a tool execution error.

Source

pub fn resource_not_found(uri: &str) -> Self

Creates a resource not found error.

Source

pub fn request_cancelled() -> Self

Creates a request cancelled error.

Source

pub fn masked(&self, mask_enabled: bool) -> McpError

Returns a masked version of this error for client responses.

When masking is enabled, internal error details are hidden to prevent leaking sensitive information (file paths, stack traces, internal state).

§What gets masked
  • InternalError, ToolExecutionError, Custom codes: message replaced with “Internal server error” and data removed
§What’s preserved
  • Error code (for programmatic handling)
  • Client errors (ParseError, InvalidRequest, MethodNotFound, InvalidParams, ResourceNotFound, ResourceForbidden, PromptNotFound, RequestCancelled): preserved as-is since they don’t contain internal details
§Example
use fastmcp_core::{McpError, McpErrorCode};

let internal = McpError::internal_error("Connection failed at /etc/secrets/db.conf");
let masked = internal.masked(true);
assert_eq!(masked.message, "Internal server error");
assert!(masked.data.is_none());

// Client errors are preserved
let client = McpError::invalid_params("Missing field 'name'");
let masked_client = client.masked(true);
assert!(masked_client.message.contains("name"));
Source

pub fn is_internal(&self) -> bool

Returns whether this error contains internal details that should be masked.

Trait Implementations§

Source§

impl Clone for McpError

Source§

fn clone(&self) -> McpError

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for McpError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for McpError

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for McpError

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for McpError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for McpError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<CancelledError> for McpError

Source§

fn from(_: CancelledError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for McpError

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl<T> ResultExt<T, McpError> for Result<T, CancelledError>

Source§

fn into_outcome(self) -> Outcome<T, McpError>

Convert a Result to an Outcome.
Source§

impl Serialize for McpError

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,