Class ChartWebMcpTool

One tool entry inside ChartWebMcpSettings. The four supported capabilities are:

  • Disable a built-in (Enabled="false").
  • Override metadata (Name/Description/InputSchema).
  • Replace the built-in handler (any non-custom Command present as a child — the host-level ChartEvents.OnWebMcpExecute event is invoked instead of the built-in handler).
  • Register a fully custom tool (Command="Custom" + Name + InputSchema; the host event supplies the result).
Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
ChartWebMcpTool
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.Charts.dll
Syntax
public class ChartWebMcpTool : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

Per-tool OnExecute handlers were removed in favour of a single component-level ChartEvents.OnWebMcpExecute event. The host wires that event once and the dispatcher routes both custom tools and built-in overrides through it.

Constructors

ChartWebMcpTool()

Declaration
public ChartWebMcpTool()

Properties

Command

Gets or sets the built-in operation this tool maps to, or Custom.

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

Description

Gets or sets the natural-language description shown to the AI agent.

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

Enabled

Gets or sets whether this tool is registered with the browser.

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

InputSchema

Gets or sets the JSON Schema for the tool's input, as a JSON-encoded string. Required when Command is Custom. The parameter type is string, not a CLR object. Pass a schema document such as {"type":"object","properties":{}}. Invalid JSON is not accepted as a schema object; registration warns and falls back to an empty object schema.

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

Name

Gets or sets the tool identifier registered with the browser.

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

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
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

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A Task representing any asynchronous operation.
Overrides

Implements