Class DocumentEditorWebMcpToolExecuteEventArgs

Provides data for the OnWebMcpExecute event.

Inheritance
object
EventArgs
DocumentEditorWebMcpToolExecuteEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class DocumentEditorWebMcpToolExecuteEventArgs : EventArgs

Constructors

DocumentEditorWebMcpToolExecuteEventArgs()

Declaration
public DocumentEditorWebMcpToolExecuteEventArgs()

Properties

Arguments

Gets or sets the input arguments supplied with the tool execution request.

Declaration
public IReadOnlyDictionary<string, object>? Arguments { get; set; }
Property Value
Type Description
IReadOnlyDictionary<string, object>

An IReadOnlyDictionary<TKey, TValue> containing the argument names and values provided for the current tool invocation, or null if the tool does not receive any input arguments.
Remarks

The arguments correspond to the values supplied by the requesting agent and are based on the tool's registered input schema.

The collection is exposed as an IReadOnlyDictionary<TKey, TValue> and is intended for reading request data. Assigning a new value does not modify the arguments used by the document editor's built-in tool execution logic.

Cancel

Gets or sets a value indicating whether the tool execution should be cancelled.

Declaration
public bool Cancel { get; set; }
Property Value
Type Description
bool

true cancels the operation; otherwise, false. The default value is false.
Remarks

When execution is cancelled, the dispatcher returns a cancellation response to the requesting agent instead of invoking the associated tool handler. If both Cancel and Result are set, Cancel takes precedence.

CancellationResponse

Gets or sets the optional response message returned when execution is cancelled.

Declaration
public string? CancellationResponse { get; set; }
Property Value
Type Description
string

A custom cancellation message, or null to use the default cancellation response.
Remarks

This value is used when Cancel is true. The default response includes the [USER_CANCELLED] sentinel.

Command

Gets the command associated with the tool execution request.

Declaration
public DocumentEditorWebMcpToolCommand Command { get; }
Property Value
Type Description
DocumentEditorWebMcpToolCommand

A DocumentEditorWebMcpToolCommand identifying the built-in command being executed.
Remarks

This value is the exact enum member associated with the command, such as InsertText. It is set by the document editor and cannot be changed by application code.

Name

Gets the name of the tool being executed.

Declaration
public string Name { get; }
Property Value
Type Description
string

A string representing the tool associated with the current WebMCP execution request.
Remarks

This value corresponds to the effective tool name exposed to the agent after any customization applied through DocumentEditorWebMcpTool.

Applications can use this property within the OnWebMcpExecute event handler to identify the requested tool and provide an appropriate response.

Result

Gets or sets the custom response payload 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

A string (typically JSON) 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.

ShowConfirmationDialog

Gets or sets a value indicating whether a write tool requires host confirmation.

Declaration
public bool ShowConfirmationDialog { get; set; }
Property Value
Type Description
bool

true to request confirmation before a write tool runs; otherwise, false. The default value is false.
Remarks

Read-only tools ignore this property. For write tools, setting it to true asks the host to confirm the operation before the handler runs.