Enum SpreadsheetWebMcpToolCommand

Specifies the built-in WebMCP tools that can be exposed by a SfSpreadsheet instance.

Namespace: Syncfusion.Blazor.Spreadsheet

Assembly: Syncfusion.Blazor.Spreadsheet.dll

Syntax

[JsonConverter(typeof(WebMcpToolCommandJsonConverter))]
public enum SpreadsheetWebMcpToolCommand

Remarks

Use these values with Command to customize or disable built-in tools.

Each member identifies a built-in operation whose name and metadata can be customized through SpreadsheetWebMcpTool without changing its built-in behavior. The associated EnumMember value supplies the canonical tool name used by the WebMCP catalog and dispatcher.

The enum includes read tools for retrieving spreadsheet state and data, write tools for modifying workbook contents or state, and the Custom value for application-defined tools. The None value is a placeholder and is not valid for a tool entry. GetRangeData is opt-in and must be explicitly enabled through Enabled.

When the enum is serialized to JSON (for example when the tool catalog is passed to the browser), each member is emitted as the EnumMember value declared on the field (getActiveSheet, updateCell, and so on). The deserializer accepts the same canonical names. The custom Syncfusion.Blazor.Spreadsheet.WebMcpToolCommandJsonConverter is required because JsonStringEnumConverter on .NET 8 and earlier ignores EnumMember and would emit PascalCase identifiers.

Fields

Name	Description
AddConditionalFormat	Adds a conditional formatting rule.
AddDataValidation	Adds data validation to a range.
AddDefinedName	Adds a defined name for a range.
AddHyperlink	Adds a hyperlink to a cell.
Autofill	Fills a destination range using source cell data.
Calculate	Recalculates workbook formulas.
ClearAllFilters	Clears all active filters.
ClearConditionalFormats	Removes conditional formatting from a range.
ClearFilter	Clears a filter from a field.
ClearRange	Clears contents or formatting from a range.
Custom	Custom tool. Requires Name and InputSchema. Execution is supplied by the host inside OnWebMcpExecute by setting SpreadsheetWebMcpExecuteEventArgs.Result; if the host does not set Result, the dispatcher returns UnknownTool for the custom name.
DeleteChart	Deletes a chart.
DeleteSheet	Deletes a worksheet.
DuplicateSheet	Duplicates a worksheet.
FilterByCellValue	Filters data by a cell value.
Find	Finds a matching value in the workbook.
FindAll	Finds all matching values in the workbook.
GetActiveSheet	Gets information about the active worksheet.
GetCellValue	Gets the value and formula of a cell.
GetRangeData	Gets tabular data from a cell range.
GetSelection	Gets the current spreadsheet selection.
GetWorkbookInfo	Gets summary information about the workbook.
InsertChart	Inserts a chart based on a cell range.
InsertColumn	Inserts one or more columns.
InsertRow	Inserts one or more rows.
InsertSheet	Inserts one or more worksheets.
ListCharts	Lists the charts in the workbook.
MergeCells	Merges cells in a range.
MoveSheet	Moves a worksheet to another position.
None	No command set — validation will throw.
ProtectSheet	Protects a worksheet.
ReapplyFilters	Reapplies the configured filters.
Redo	Repeats the most recently undone operation.
Refresh	Refreshes the spreadsheet view.
RemoveDataValidation	Removes data validation from a range.
RemoveDefinedName	Removes a defined name.
RemoveHyperlink	Removes a hyperlink from a cell.
Replace	Replaces matching text in the workbook.
Save	Saves or exports the workbook.
SelectRange	Selects a cell or range.
SetBorders	Sets borders for a cell range.
SetCellFormat	Applies formatting to cells.
SetColumnWidth	Sets the width of a column.
SetNumberFormat	Sets the number format for cells.
SetRowHeight	Sets the height of a row.
SortRange	Sorts a cell range.
Undo	Reverses the most recent spreadsheet operation.
UnmergeCells	Unmerges cells in a range.
UnprotectSheet	Removes protection from a worksheet.
UpdateCell	Updates the value of a single cell.
UpdateCells	Updates values in multiple cells.