Skip to main content
Glama
KitchenSink4AI

io.github.nometalalchemist/kitchensink4xl

read_range

Read-only

Fetch a cell or range from an Excel workbook using a location object (cell, range, R1C1, name, table, or search). Choose cached, formula, or both; absent labels identify uncalculated formula cells.

Instructions

Read a cell or range addressed by a location object (cell, range, r1c1, name, table, used_range, region, search, or a grid-view anchor; sheet picks the sheet when the location does not, default active). values controls the honest calc story: 'cached' returns the last calculated values, 'formula' the formula strings, 'both' pairs each value with a label (cached, absent, formula, value). A formula cell with no cached value is labelled 'absent', never passed off as blank. Read-only; page large ranges with query_range.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
sheetNo
valuesNocached
locationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "type": "object"
      -}New value: +null
  2. Changed1 schema field changedv1.1.0
    • addedInput schema / properties / location / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "object"
      +  }
      +]
  3. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the readOnlyHint annotation, the description explains how the values parameter shapes results (cached/formula/both), what labels are returned, and that formula cells without cached values are labelled 'absent' rather than blank. This is meaningful behavioral disclosure that the schema and annotations do not provide.

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?

The description is dense and front-loaded; the main verb and resource are first, followed by the most behaviorally significant parameter. The prose is compact given the number of location modes and values modes, though the phrase 'honest calc story' is a mild flourish.

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

Completeness4/5

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

For a no-output-schema read tool with a complex location input, it covers the main invocation semantics: addressing modes, sheet default, values modes, and the large-range alternative. It does not spell out the exact return shape for 'both' or the path parameter, but it is sufficient for calling the tool correctly in common cases.

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?

With 0% schema description coverage, the description compensates by explaining values in detail, enumerating location object kinds, and describing sheet resolution. The path parameter is left unexplained, and exact location object shapes are not specified, so it is not a full substitute for schema documentation.

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?

The description names a precise operation ('Read a cell or range') and scopes it via the location-object addressing modes. It also distinguishes itself by telling the agent to use query_range for large ranges, so it does not read as a generic read tool.

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 states when to use the tool (for any addressed cell/range read) and explicitly routes large ranges to query_range. It also clarifies sheet fallback behavior. It could be stronger by stating exclusions against get_cells or export_range, but the core selection context is present.

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