Skip to main content
Glama

sheets_get_full_sheet_snapshot

Fetches full sheet snapshot in a single API call: frozen rows, merged cells, column widths, row heights, banded ranges, conditional formatting, and optional cell formatting. Use for programmatic sheet recreation.

Instructions

One-shot tool: reads all structural and formatting metadata for a sheet in a single API call. Returns: sheet properties (frozen rows/cols, dimensions, tab color), merged cells, column widths, row heights, banded ranges, and optionally cell-level formatting for a specified range (includeFormattingRange). compactMode is OFF by default — full per-cell detail is returned unless compactMode:true is provided. When compactMode is ON, adjacent cells with identical formatting are collapsed into range descriptors (90%+ smaller output). Conditional formatting rules are included by default (includeConditionalFormatting:true); set to false to exclude them. CF formulas are normalized to English locale (commas). Use fields to limit which format properties are returned. Use this before programmatically recreating a sheet.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoOptional list of format field names to include, e.g. ["backgroundColor", "textFormat", "borders"]. Reduces response size by excluding unused format properties. All fields returned if omitted.
sheetNameYesName of the sheet (tab) to snapshot
compactModeNoDefault: false. Full per-cell formatting is returned unless compactMode:true is set. When true, adjacent cells with identical formatting are collapsed into range descriptors (run-length encoded), reducing output by 90%+ for typical formatted sheets. Only applies when includeFormattingRange is set.
spreadsheetIdYesThe ID of the spreadsheet (found in the URL after /d/)
useEffectiveFormatNoIf includeFormattingRange is set: use effectiveFormat (true) or userEnteredFormat (false, default).
includeFormattingRangeNoOptional range WITHOUT sheet prefix (e.g. "A1:Z85") to include cell-level formatting. If omitted, only structural metadata is returned.
includeConditionalFormattingNoDefault: true. Include conditional formatting rules and banded ranges in the snapshot. CF formulas are normalized to English locale (semicolons → commas). Set to false to reduce output size when CF rules are not needed.
Behavior5/5

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

With no annotations, the description fully discloses behavior: it is a read operation (no side effects), defaults for compactMode and includeConditionalFormatting, effect of compactMode (collapsing cells), and locale normalization of CF formulas. It clearly sets expectations for output size and customization.

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 but well-structured: purpose first, then items returned, then parameter details, then use case. It could be slightly more concise but front-loads key information and earns each sentence.

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?

Given 7 parameters, no output schema, and no annotations, the description covers purpose, behavior, parameter customization, and a clear use case. It explains what is returned but lacks detail on output format or how to parse the snapshot, which is acceptable for a complex tool.

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?

Schema coverage is 100%, so baseline is 3. The description adds value by providing usage context (e.g., 'Use fields to limit which format properties are returned' and 'CF formulas are normalized to English locale') that enhances understanding beyond the schema descriptions.

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 clearly states it is a 'one-shot tool: reads all structural and formatting metadata for a sheet'. It lists what it returns (sheet properties, merged cells, widths, heights, banded ranges, optional cell formatting) and distinguishes from siblings like sheets_get_sheet_structure or sheets_get_sheet_formatting by emphasizing 'full sheet snapshot' and one-shot nature.

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 recommends using the tool 'before programmatically recreating a sheet' and explains when to use compactMode and includeConditionalFormatting to reduce output. However, it does not explicitly state when not to use it or name alternative tools for more specific needs, leaving some ambiguity.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/freema/mcp-gsheets'

If you have feedback or need assistance with the MCP directory API, please join our Discord server