Interface ISpreadsheetWebMcpTool

Represents the metadata for a WebMCP tool exposed by a SfSpreadsheet instance.

Namespace: Syncfusion.Blazor.Spreadsheet

Assembly: Syncfusion.Blazor.Spreadsheet.dll

Syntax

public interface ISpreadsheetWebMcpTool

Remarks

The spreadsheet returns these definitions from GetWebMcpToolsAsync(IEnumerable<string>?) so an application can inspect the effective catalog. Definitions contain the metadata used when tools are registered with the browser's document.modelContext API.

Definitions can describe built-in tools or custom tools configured through SpreadsheetWebMcpSettings. The effective name and metadata reflect that configuration. The browser-side registration prefix is applied separately and is not part of Name.

This interface is intended for inspecting returned tool definitions; the Spreadsheet component supplies the implementation.

Properties

Description

Gets the description provided to browser-side AI agents for this tool.

Declaration

string Description { get; }

Property Value

Type	Description
string	A string describing the purpose and usage of the tool.

InputSchema

Gets the JSON Schema that describes the arguments accepted by the tool.

Declaration

string? InputSchema { get; }

Property Value

Type	Description
string	A JSON string representing the input schema, or null when no input schema is defined.

Name

Gets the effective name of the tool in the spreadsheet's WebMCP catalog.

Declaration

string Name { get; }

Property Value

Type	Description
string	A string containing the catalog name or configured alias, without the browser-side instance prefix.