ec4c732632Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
52 lines
2.4 KiB
C#
52 lines
2.4 KiB
C#
using ModelContextProtocol.Protocol;
|
|
|
|
namespace ModelContextProtocol;
|
|
|
|
/// <summary>
|
|
/// Represents an exception that is thrown when an Model Context Protocol (MCP) error occurs.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// The <see cref="Exception.Message"/> from a <see cref="McpException"/> might be propagated to the remote
|
|
/// endpoint; sensitive information should not be included. If sensitive details need to be included,
|
|
/// a different exception type should be used.
|
|
///
|
|
/// This exception type can be thrown by MCP tools or tool call filters to propagate detailed error messages
|
|
/// from <see cref="Exception.Message"/> when a tool execution fails via a <see cref="CallToolResult"/>.
|
|
/// This includes input validation errors, business logic errors, or any other failure that the model should
|
|
/// be informed about. For example, if a required field is missing or a value is out of range, throwing an
|
|
/// <see cref="McpException"/> with a descriptive message allows the model to understand the issue and
|
|
/// potentially self-correct in a subsequent request.
|
|
///
|
|
/// For non-tool calls, this exception controls the message propagated via a <see cref="JsonRpcError"/>.
|
|
///
|
|
/// <see cref="McpProtocolException"/> is a derived type that can be used to also specify the
|
|
/// <see cref="McpErrorCode"/> that should be used for the resulting <see cref="JsonRpcError"/>.
|
|
/// </remarks>
|
|
public class McpException : Exception
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="McpException"/> class.
|
|
/// </summary>
|
|
public McpException()
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="McpException"/> class with a specified error message.
|
|
/// </summary>
|
|
/// <param name="message">The message that describes the error.</param>
|
|
public McpException(string message) : base(message)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="McpException"/> class with a specified error message and
|
|
/// a reference to the inner exception that is the cause of this exception.
|
|
/// </summary>
|
|
/// <param name="message">The message that describes the error.</param>
|
|
/// <param name="innerException">The exception that is the cause of the current exception, or a null
|
|
/// reference if no inner exception is specified.</param>
|
|
public McpException(string message, Exception? innerException) : base(message, innerException)
|
|
{
|
|
}
|
|
}
|