← All toolsFiles & Documentsxlsx_handlerAll editions

READ_XLSX

Reads an Excel or CSV file. Returns columns, rows, summary, data types, and basic statistics.

Parameters

NameTypeRequiredDescription
pathstringyesAbsolute path to the .xlsx, .xls, or .csv file
sheet_namestringSheet name to read (default: first sheet)
preview_rowsintegerNumber of rows to return (default 100). Use -1 for all.

How to use it

You normally trigger this by describing what you want in chat — the agent selects READ_XLSX automatically. For example:

Try saying
“read my xlsx handler”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "xlsx_handler",
  "action": "READ_XLSX",
  "args": {
    "path": "/Users/me/Documents/file.txt",
    "sheet_name": "…",
    "preview_rows": 1
  },
  "depends_on": [],
  "outputs": []
}

Direct call

For scripting, call it directly via POST /execute_tool. Every tool returns { success, message, data }.

bash
curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"READ_XLSX","args":{"path":"/Users/me/Documents/file.txt","sheet_name":"…","preview_rows":1}}'

Part of the xlsx_handler plugin. Browse the full Plugin & Tool Catalog or the relevant feature guide.