Struct ToolError 

pub struct ToolError {
    pub schema_version: u8,
    pub kind: ServiceErrorKind,
    pub code: String,
    pub message: String,
    pub retryable: bool,
    pub remediation: String,
    pub field: Option<String>,
    pub bad_value: Option<String>,
    pub expected_pattern: Option<String>,
    pub reason_kind: Option<String>,
    pub available_actions: Vec<&'static str>,
}

Structured error DTO shared by REST and MCP rendering surfaces.

Fields

schema_version: u8

Version of the error payload schema.

kind: ServiceErrorKind

High-level failure category.

code: String

Stable machine-readable error code.

message: String

Human-readable error message.

retryable: bool

Whether the caller may retry the operation.

remediation: String

Actionable guidance for resolving the error.

field: Option<String>

Offending input field, when the error is field-specific.

bad_value: Option<String>

The rejected value, when a specific value caused the failure.

expected_pattern: Option<String>

Expected pattern the input should have matched.

reason_kind: Option<String>

Sub-classification of an execution failure (the underlying kind).

available_actions: Vec<&'static str>

Valid action names to suggest to the caller.

Implementations

impl ToolError

pub fn validation( code: impl Into<String>, message: impl Into<String>, remediation: impl Into<String>, ) -> Self

Builds a Validation-kind error from a code, message, and remediation.

pub fn from_action_validation(error: &ActionValidationError) -> Self

Builds a validation error from an ActionValidationError, using the full set of known action names as suggestions.

pub fn from_action_validation_with_actions( error: &ActionValidationError, available_actions: Vec<&'static str>, ) -> Self

Builds a validation error from an ActionValidationError with an explicit list of available action names.

pub fn execution(error: &Error) -> Self

Builds an execution error, classifying the underlying anyhow error into a ServiceErrorKind and setting retryability accordingly.

pub fn with_field(self, field: impl Into<String>) -> Self

Sets the offending input field and returns self.

pub fn with_bad_value(self, bad_value: impl Into<String>) -> Self

Sets the rejected value and returns self.

pub fn with_expected_pattern(self, expected_pattern: impl Into<String>) -> Self

Sets the expected input pattern and returns self.

pub fn with_available_actions( self, available_actions: Vec<&'static str>, ) -> Self

Sets the list of suggested action names and returns self.

pub fn http_status_code(&self) -> u16

Returns the HTTP status code for this error’s kind.

pub fn to_rest_payload(&self) -> Value

Renders this error as a REST response JSON payload.

pub fn to_mcp_payload(&self, tool: &str, action: Option<&str>) -> Value

Renders this error as an MCP tool-error JSON payload, tagged with the originating tool and optional action.

Trait Implementations

impl Clone for ToolError

fn clone(&self) -> ToolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolError

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

Formats the value using the given formatter.

impl PartialEq for ToolError

fn eq(&self, other: &ToolError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ToolError

impl StructuralPartialEq for ToolError