Class SpreadsheetReadTool

Namespace: LMKit.Agents.Tools.BuiltIn.Data

Assembly: LM-Kit.NET.dll

A built-in tool for reading cells, ranges, sheet info, and converting data from Excel (.xlsx) files to structured formats.

Supports reading specific ranges, listing sheets, and outputting data as rows, CSV, or JSON. The file is always opened in read-only mode.

public sealed class SpreadsheetReadTool : IBuiltInTool, ITool, IToolMetadata

Inheritance: object

SpreadsheetReadTool

Implements: IBuiltInTool

ITool

IToolMetadata

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var readTool = new SpreadsheetReadTool();
var result = await readTool.InvokeAsync(@"{""path"":""report.xlsx"",""range"":""A1:D10"",""format"":""json""}");

Constructors

SpreadsheetReadTool(): Initializes a new instance with default options.

SpreadsheetReadTool(SpreadsheetToolOptions): Initializes a new instance with the specified options.

Properties

Description: Gets a concise description of what the tool does.

InputSchema: Gets the JSON Schema defining the expected input arguments.

Name: Gets the stable, unique identifier for this tool.

Methods

InvokeAsync(string, CancellationToken): Executes the tool with the specified JSON arguments.