Class RichTextEditorWebMcpExecuteEventArgs

Provides host control over a WebMCP tool invocation.

Inheritance

object

RichTextEditorWebMcpExecuteEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.RichTextEditor

Assembly: Syncfusion.Blazor.RichTextEditor.dll

Syntax

public class RichTextEditorWebMcpExecuteEventArgs

Constructors

RichTextEditorWebMcpExecuteEventArgs()

Declaration

public RichTextEditorWebMcpExecuteEventArgs()

Properties

Arguments

Gets or sets the normalized arguments supplied for the tool invocation.

Declaration

public IReadOnlyDictionary<string, object?> Arguments { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>	A dictionary containing the tool argument names and values. The default value is an empty dictionary.

Cancel

Gets or sets a value indicating whether the host cancels the tool execution.

Declaration

public bool Cancel { get; set; }

Property Value

Type	Description
bool	true to cancel the invocation; otherwise, false.

CancellationResponse

Gets or sets the optional response to return when the invocation is canceled.

Declaration

public string? CancellationResponse { get; set; }

Property Value

Type	Description
string	The cancellation response, or null when no custom response is supplied.

Command

Gets the command associated with the tool execution request.

Declaration

public RichTextEditorWebMcpToolCommand Command { get; }

Property Value

Type	Description
RichTextEditorWebMcpToolCommand	The built-in command identifying the tool, or Custom for a custom tool.

Remarks

For renamed built-in tools, this remains the original built-in command. The editor sets this value; application code cannot change it.

Name

Gets the name of the tool being invoked.

Declaration

public string? Name { get; }

Property Value

Type	Description
string	The invoked tool's name, or null when no tool name is available.

Result

Gets or sets the custom response payload produced by the host's OnWebMcpExecute event handler, returned to the AI agent in place of the built-in handler's output.

Declaration

public string? Result { get; set; }

Property Value

Type	Description
string	An object representing the custom result data, or null when no custom response is supplied by the host. The default value is null.

Remarks

Assigning a value to this property suppresses the normal tool execution pipeline and returns the supplied value directly to the requesting agent.

This property is commonly used when implementing custom WebMCP tools through the OnWebMcpExecute event.

For built-in tools, setting this property overrides the result that would otherwise be produced by the editor's built-in tool handler.

If both Cancel and Result are set, Cancel takes precedence. The supplied result is ignored, and a cancellation response is returned to the requesting agent.

ShowConfirmationDialog

Gets or sets a value indicating whether to show a confirmation dialog before executing a write operation.

Declaration

public bool ShowConfirmationDialog { get; set; }

Property Value

Type	Description
bool	true to require confirmation before the write; otherwise, false.

Remarks

This property is optional and defaults to false. No confirmation dialog is displayed unless it is explicitly enabled.

This property applies only to built-in tool execution. For custom handlers, confirmation handling is not performed automatically and must be implemented explicitly by the application before the tool is executed.