Skip to main content
Glama
KitchenSink4AI

io.github.nometalalchemist/kitchensink4xl

by KitchenSink4AI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

Read Range

read_range
Read-only

Read a cell or range from Excel, choosing cached values, formulas, or paired labels; handles various address formats.

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.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces this with 'Read-only'. It adds significant behavioral nuance by explaining the 'honest calc story' — that formula cells with no cached value are labelled 'absent' rather than blank — and mentions the performance hint about large ranges. This goes beyond the annotation without contradicting it.

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 a single dense paragraph that front-loads the core purpose and then layers in parameter details. It is efficient with no fluff, though it is slightly long. The structure is logical: purpose, location options, values behavior, and a final note on read-only and pagination. It earns a high score for being information-dense without redundancy.

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?

With four parameters, no output schema, and no parameter descriptions in the schema, the description covers most critical aspects: location types, sheet selection, values semantics, and the large-range pagination hint. It does not explicitly describe the return format or error behavior, but for a read operation with readOnlyHint, these are secondary. Overall it is adequately complete for an agent to call the tool correctly.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate. It thoroughly explains the 'location' parameter by listing all accepted object types, explains the 'sheet' default behavior, and details the three 'values' modes ('cached', 'formula', 'both') with their exact meanings. The 'path' parameter is not explicitly explained, but its role is inferable as a workbook path. The description adds substantial semantic value beyond the bare schema.

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 states a specific verb ('Read') and resource ('cell or range'), and enumerates the accepted location object types (cell, range, r1c1, name, table, etc.), which clearly distinguishes it from sibling write tools and query_range. The phrase 'page large ranges with query_range' further differentiates it from that sibling.

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?

The description gives explicit guidance on when to use query_range for large ranges, and implicitly indicates read_range for normal reads. However, it does not explicitly mention alternatives like get_cells or set_cell, or provide conditions for choosing read_range over them. It still gives clear context on when to use the tool.

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

Deploy Server

Other Tools