Skip to main content
Glama

read_workbook

Read inside one workbook held against a database — a report, importTemplate or setupSheet (use list_database_sheets to see what exists). Called without sheet it returns the workbook's shape: every sheet with its extent, and every defined name with its scope and target — for an Azquo workbook the az_ names ARE the model, so start here. Called WITH sheet it returns that sheet's cells, showing formulas in preference to computed values. It returns structure and text, NOT the file itself: workbooks run to megabytes, so use the admin's Download button if you want the actual file. Setup sheets and import templates are administrator/developer only; reports follow the caller's report permissions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYesWhich of the three kinds of workbook to read
nameYesFor a report, its report NAME or its filename; for an import template or setup sheet, the filename as returned by list_database_sheets
sheetNoOmit for the workbook's structure; give a sheet name to read its cells
fromRowNoFirst row to read, 0-based (default 0). Use with maxRows to page a large sheet.
maxColsNoColumns to return (default 40)
maxRowsNoRows to return (default 200)
databaseYesDatabase name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does so: it discloses formula-vs-computed-value preference, that it returns structure/text rather than the file (with the size reason), and the permission model (setup sheets and import templates are admin/developer only; reports follow the caller's report permissions).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and the sheet/no-sheet branching, and each sentence contributes distinct information (kinds, structure output, formula preference, non-file caveat, permissions). It runs a bit long but is dense rather than padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no annotations, the description compensates fully: it describes what each mode returns (sheet extents, defined names with scope/target, cell contents with formulas), the paging model via schema, and the access constraints.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents all seven parameters including the sheet dual-mode, paging (fromRow/maxRows/maxCols), and defaults. The description restates the sheet behavior rather than adding new semantics, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Read inside one workbook') and enumerates the three workbook kinds it covers. It distinguishes itself from siblings by naming list_database_sheets for discovery and contrasting its structural vs. cell-level modes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly explains the two invocation modes ('Called without sheet... Called WITH sheet') and routes discovery to list_database_sheets. It also states an exclusion — use the admin's Download button if you want the actual file — though it doesn't contrast against report-data siblings like get_report_data.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources