Class DocumentEditorWebMcpTool

Describes one WebMCP tool: a customization of a built-in command or a host-defined custom tool.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
DocumentEditorWebMcpTool
Implements
Inherited Members
Namespace: Syncfusion.Blazor.DocumentEditor
Assembly: Syncfusion.Blazor.DocumentEditor.dll
Syntax
public class DocumentEditorWebMcpTool : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

DocumentEditorWebMcpTool()

Declaration
public DocumentEditorWebMcpTool()

Properties

Command

Gets or sets the built-in command this entry targets, or Custom for a host-defined tool.

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

Description

Gets or sets the agent-facing description. When empty, the built-in description is used.

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

Enabled

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

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

true to register the tool; false to omit it. The default is true.

InputSchema

Gets or sets the JSON Schema, as a JSON string, describing the tool's input. Required for Custom and not allowed for built-in commands.

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

Name

Gets or sets the agent-facing tool name. Required for Custom; for built-in commands it renames the tool, and when empty the built-in name is used.

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.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSet()

Declaration
protected override void OnParametersSet()
Overrides

Implements