Class RichTextEditorWebMcpTool

One WebMCP tool customization entry. Nest inside RichTextEditorWebMcpTools to disable, rename, or replace a built-in tool, or to register a fully custom tool with Custom.

Inheritance
object
ComponentBase
RichTextEditorWebMcpTool
Implements
Inherited Members
Namespace: Syncfusion.Blazor.RichTextEditor
Assembly: Syncfusion.Blazor.RichTextEditor.dll
Syntax
public class RichTextEditorWebMcpTool : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

RichTextEditorWebMcpTool()

Declaration
public RichTextEditorWebMcpTool()

Properties

Command

Gets or sets the tool command that this entry represents.

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

A built-in RichTextEditorWebMcpToolCommand value, or Custom for a custom tool. The default value is None.
Remarks

This property is required. When set to Custom, the Name and InputSchema properties must also be provided.

Description

Gets or sets the human-readable description of the tool.

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

A string that describes the tool's purpose for AI agents.
Remarks

This text is exposed to the AI agent and should clearly describe what the tool does.

Enabled

Gets or sets a value indicating whether the tool is enabled.

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

true if the tool is enabled; otherwise, false. The default value is true.
Remarks

This property applies to both built-in and custom tools. A disabled tool is not registered with the browser.

InputSchema

Gets or sets the input schema for the tool.

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

A schema object that describes the tool input structure.
Remarks

This property is required when Command is Custom. It is ignored for built-in tools.

Name

Gets or sets the configured, unprefixed name of the tool.

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

The tool name used by this component. For built-in tools, if no name is specified, the default name is used. For custom tools, this property specifies the tool's unique name.
Remarks

For built-in tools, this property overrides the default name. Renaming a built-in tool changes its name, not its implementation or execution behavior.

For custom tools, this property is required and identifies the tool. Browser registration may use a prefixed name, but the tool execution event argument contains this configured, unprefixed name.

Tool names should be unique among tools registered on the page.

Methods

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

Implements