Class GanttWebMcpTool

Single tool entry. Use any of the following behaviors:

  • Disable a built-in (Enabled="false").
  • Override metadata (Name / Description).
  • Override the input schema for a built-in (InputSchema). The supplied JSON is parsed and used instead of the catalog default.
  • Register a fully custom tool (Command="Custom" + Name + Description + InputSchema). Custom tools are dispatched through GanttEvents.OnWebMcpExecute; the host sets args.Result in the event callback.
Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
GanttWebMcpTool
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.Gantt.dll
Syntax
public class GanttWebMcpTool : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

GanttWebMcpTool()

Declaration
public GanttWebMcpTool()

Properties

Command

Gets or sets the built-in operation this tool maps to, or Custom for a developer- authored tool. Required.

Declaration
[Parameter]
public GanttWebMcpToolCommand Command { get; set; }
Property Value
Type
GanttWebMcpToolCommand

Description

Gets or sets the natural-language description shown to the agent. Required for Custom; for built-ins it overrides the built-in default description.

Declaration
[Parameter]
public string? Description { get; set; }
Property Value
Type
string

Enabled

Gets or sets whether this tool is registered with the browser's WebMCP runtime. Defaults to false so the host must explicitly opt in. The per-instance settings merge in WebMcpAdapter.ResolveEffectiveTools applies the built-in default (true for every command except data/ document returning tools such as GetData) when the host does not supply an entry for the command.

Declaration
[Parameter]
public bool Enabled { get; set; }
Property Value
Type
bool

InputSchema

Gets or sets the JSON Schema describing this tool's input. Supplied as a raw JSON string. Required for Custom; optional for built-ins (overrides the catalog-supplied schema).

Declaration
[Parameter]
public string? InputSchema { get; set; }
Property Value
Type
string

Name

Gets or sets the tool identifier registered with the browser. Required when Command is Custom; optional for built-ins (overrides the auto-generated name).

Declaration
[Parameter]
public string? Name { get; set; }
Property Value
Type
string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing any asynchronous operation.
Overrides

Implements