Skip to main content
Glama

r7_sheet_read

Read spreadsheet values, formulas, and formatting from a worksheet or range in an XLSX file to inspect or extract data for validation.

Instructions

Read spreadsheet values, formulas and formatting from a worksheet or range (e.g. A1:D10).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rangeNoRange reference (e.g. A1:C10).
filePathYesPath to XLSX file.
sheetNameNoSheet name (takes precedence over sheetIndex).
sheetIndexNo0-based sheet index.
includeStylesNoAlso return normalized formatting for every cell (font, fill, border, alignment, numberFormat) plus merged ranges, row heights and column widths.
includeFormulasNoAlso return the formulas matrix. Use it to verify a formula was written: a formula cell has no cached value until a spreadsheet engine recalculates the workbook.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It implies values, formulas and formatting are all returned, yet the schema shows formulas and styles are opt-in via includeFormulas/includeStyles flags — a potentially misleading impression — and it says nothing about failure modes for a missing file or sheet.

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

Conciseness5/5

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

A single front-loaded sentence that names the verb, the resource and the scope with no filler or redundancy. Nothing could be removed without losing information.

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

Completeness3/5

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

For a six-parameter read tool with no output schema and no annotations, the description sketches the return content but does not explain the optional flags that materially change the response, nor error behavior. It is minimally adequate but leaves gaps the structured fields do not fill.

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 every parameter including the range example and the sheetName/sheetIndex precedence is already documented in the schema. The description's range example (A1:D10) merely repeats the schema and adds no extra semantics, making the baseline 3 appropriate.

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

Purpose4/5

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

States a specific verb (Read) and resource (spreadsheet values, formulas, formatting) scoped to a worksheet or range, which clearly separates it from r7_sheet_write and the generic r7_read. It stops short of naming which sibling to use for related tasks, so it is clear but not sibling-differentiating.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance and no mention of alternatives such as r7_read or r7_inspect, even though the sibling list contains several read-oriented tools. The agent must infer that this is the spreadsheet-specific reader.

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