Skip to main content
Glama

sheets_get_spreadsheet

Retrieve spreadsheet metadata, tab titles, IDs, dimensions, and named ranges; exclude cell data by default or include grid data for formatting with range limits.

Instructions

Get spreadsheet metadata, tab titles/IDs, dimensions, named ranges, and other properties. Cell grid data is excluded by default; enable it for formatting and restrict ranges for large spreadsheets. Discover spreadsheet IDs with drive_search_files using mimeType = 'application/vnd.google-apps.spreadsheet'.

Input Schema

NameRequiredDescriptionDefault
emailNoGoogle account email. May be omitted when exactly one account is configured; required when multiple accounts are configured.
rangesNo
include_grid_dataNoDefault false; true includes cell data and formatting
spreadsheet_id_or_urlYesGoogle Sheets spreadsheet ID or full docs.google.com/spreadsheets URL. The URL's gid does not select a tab; use a sheet-qualified range.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral burden and does disclose key traits: grid data is off by default, enabling it returns formatting, and range restriction mitigates large-spreadsheet cost. It stops short of stating auth requirements or account-resolution behavior (which the schema covers for email).

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?

Three tight sentences, front-loaded with what the tool returns, followed by default-behavior and discovery guidance. No filler; every sentence carries actionable 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?

There is no output schema and no annotations, so the description is the main source of truth, and it covers return contents, the grid-data default, and ID discovery adequately. Auth/permission behavior is the only notable gap, which the email parameter description partially offsets.

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%, so the schema already documents each parameter thoroughly (including the URL/gid caveat and email rules). The description adds only a light performance rationale for 'ranges' and the formatting motive for grid data, so it sits at the high-coverage baseline of 3.

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 ('Get') and resource ('spreadsheet') and enumerates exactly what is returned: metadata, tab titles/IDs, dimensions, named ranges. The scope note that cell grid data is excluded implicitly separates it from sheets_read_values, so an agent can distinguish it from siblings 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 Guidelines4/5

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

Gives clear operational guidance: enable grid data only for formatting needs, restrict ranges for large spreadsheets, and discover IDs via drive_search_files with the specific mimeType filter. It lacks an explicit 'use sheets_read_values instead when you need cell values' exclusion, but context for when to reach for this tool is solid.

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