Skip to main content
Glama

Read workbook

read_workbook
Read-only

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

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)
businessNoOptional. The business this call is for, by name, e.g. "azquo" - it then runs there whatever business the session is in. Worth giving on writes when you work in more than one business: a new MCP session starts in the login's own business. list_businesses shows the names.
databaseYesDatabase name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / business
      Added value: +{
      +  "description": "Optional. The business this call is for, by name, e.g. \"azquo\" - it then runs there whatever business the session is in. Worth giving on writes when you work in more than one business: a new MCP session starts in the login's own business. list_businesses shows the names.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, but the description adds genuinely new behavioral context: formulas are shown in preference to computed values, it returns structure/text and never the file, and permissions differ (setup sheets/import templates are admin/developer only; reports follow caller report permissions). These are non-obvious traits the annotations do not carry.

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 verb+resource, then the two modes, then the return/permission caveats. Dense but essentially every clause carries decision-relevant information; only minor trimming is possible.

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, the description carries the burden and does so well: it describes both return shapes (sheets + defined names with scope/target; or a sheet's cells with formulas). Combined with stated permissions and the read-only annotation, an agent has everything needed to invoke correctly.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds real meaning beyond it: the semantics of omitting `sheet` (returns shape) vs providing it (returns cells), and the note that az_ defined names ARE the model. It clarifies routing more than the schema fields alone.

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 ('Read inside one workbook') and an enumerated resource ('report', 'importTemplate', 'setupSheet'), and even distinguishes the two modes (with vs without `sheet`). An agent can tell it apart from sibling readers like read_document or get_report_data without opening a schema.

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

Usage Guidelines5/5

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

Explicitly routes the agent: 'use list_database_sheets to see what exists', 'start here' for the no-sheet mode, and 'use the admin's Download button if you want the actual file' as an out-of-band alternative. When-to-use for each mode is spelled out.

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