Skip to main content
Glama

Coline

Read a sheet

read_sheet
Read-onlyIdempotent

Reads a sheet's tables, columns and rows (cells keyed by column name), with row ids to update them.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace": "<workspace>",
      "sheetId": "<sheetId>"
    },
    "name": "read_sheet"
  }
}

Input Schema

NameRequiredDescriptionDefault
sheetIdYesSheet id from search, fetch or create_sheet.
tableIdNoA table in the sheet; default: the one it opens on.
rowLimitNo
workspaceYesWorkspace slug from workspaces.list, e.g. "acme".

Output Schema

NameRequiredDescriptionDefault
urlYes
titleYes
tablesYes
sheetIdYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the returned data shape and the reason row ids matter ('to update them'), but says nothing about the rowLimit behavior, default result size, or whether large sheets are truncated.

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 with no filler; the parenthetical about cell keying and the trailing clause about row ids both carry real information. Nothing could be removed without losing content.

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?

An output schema exists, so return values need not be explained, and the description covers the essential shape of the read plus its downstream purpose. The remaining gap is pagination/limits (rowLimit has no description anywhere), which matters for a tool that can return up to 2000 rows.

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 description coverage is 75%, with sheetId, tableId (including its default) and workspace already documented in the schema. The description adds no parameter-level meaning, and rowLimit has no description in either place, leaving its default and effect undocumented.

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 and resource ('Reads a sheet') and enumerates what is returned: tables, columns, rows, cells keyed by column name, plus row ids. This clearly separates it from mutation siblings like apply_sheet_operations or add_sheet_columns, though it does not explicitly distinguish it from list_sheet_rows.

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

Usage Guidelines3/5

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

Usage is implied by the content of the read (full sheet structure plus rows, with ids so you can update them), which hints at the read-then-update workflow. However, there is no explicit when-to-use or when-not-to-use guidance and no named alternative such as list_sheet_rows for row-only access.

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