Class ScheduleWebMcpExecuteEventArgs

Single execution payload for the component-level OnWebMcpExecute event. Hosts can audit, cancel, request confirmation, or short-circuit the built-in handler by setting properties on this instance. No separate before-execute event exists; all execution control flows through this single contract.

Inheritance
object
EventArgs
ScheduleWebMcpExecuteEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.Schedule
Assembly: Syncfusion.Blazor.Schedule.dll
Syntax
public class ScheduleWebMcpExecuteEventArgs : EventArgs
Remarks

Dispatcher flow on OnWebMcpExecute invocation:

  1. Host sets Cancel → terminal [USER_CANCELLED] response (or CancellationResponse when supplied).
  2. Host sets ShowConfirmationDialog → dispatcher requests a user-confirmation prompt after the event returns. Read-only tools skip this gate.
  3. Host sets Result → dispatcher returns CreateSuccessResponse(result) and skips the built-in handler.
For Command="Custom" tools the host's OnWebMcpExecute is the only execution path: a null Result produces a terminal ExecutionFailed error.

Constructors

ScheduleWebMcpExecuteEventArgs()

Declaration
public ScheduleWebMcpExecuteEventArgs()

Properties

Arguments

Native CLR argument dictionary supplied by the agent. Values are always CLR-typed (string, long, double, bool, null, nested Dictionary<TKey, TValue>, or List<T>) — never JsonElement. The dispatcher normalizes arguments through WebMcpAdapter.NormalizeArgsForEvent before this property is exposed to host code.

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

Cancel

Gets or sets whether the host cancels the execution. When true the dispatcher returns the [USER_CANCELLED] sentinel (or CancellationResponse when supplied) without invoking the built-in handler.

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

CancellationResponse

Optional override for the terminal cancellation message. When unset, the default [USER_CANCELLED] sentinel is used.

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

Command

The discriminator for this tool invocation. Use ScheduleWebMcpToolCommand.X in handler logic.

Declaration
public ScheduleWebMcpToolCommand Command { get; set; }
Property Value
Type
ScheduleWebMcpToolCommand

Name

The effective unprefixed agent-facing tool name after any per-entry Name override. The dispatcher has already stripped the per-instance registration prefix added at browser registration time. A renamed built-in (e.g. Name="goToDate" on NavigateDate) reports its overridden name here.

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

Result

Result returned by the host. When non-null the dispatcher returns CreateSuccessResponse(result) and skips the built-in handler. For Command="Custom" tools, this is the only way to fulfil the contract — a null result produces a terminal ExecutionFailed error.

Declaration
public string Result { get; set; }
Property Value
Type
string

ShowConfirmationDialog

Set by the host to request a user-confirmation prompt before the built-in tool executes. Read tools skip this gate by design.

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

This flag is honored ONLY for dispatcher-owned built-in tools (createEvent, updateEvent, deleteEvent, changeView, navigateDate). It is not applied when Command is Custom: by the time OnWebMcpExecute returns, the host's custom side effect may already have occurred, so a genuine pre-execution confirmation would require a separate pre-execute or deferred-execute architecture (out of scope). Custom-tool authors own any approval flow required before the custom side effect.