Skip to main content
Glama

sheets_get_full_sheet_snapshot

Read-onlyIdempotent

Fetches full structural and formatting metadata for a Google Sheet in one call, including merged cells, dimensions, and conditional formatting, for precise programmatic 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?

The annotations already declare readOnlyHint and idempotentHint, but the description goes far beyond by exposing defaults (compactMode OFF, includeConditionalFormatting true), output size implications of compactMode, and the locale normalization of CF formulas. This adds substantial behavioral context not available from annotations alone.

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?

The description is dense but well-structured: it starts with the overall purpose, lists return contents, then explains each option and its default. Every sentence contributes meaningful information without redundant filler, achieving high information density in a logical order.

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

Completeness5/5

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

Despite lacking an output schema, the description thoroughly enumerates what is returned (sheet properties, merged cells, widths, heights, banded ranges, optional formatting) and covers all major behaviors (compact mode, conditional formatting, field filtering, locale normalization). For a tool with 7 parameters and no output schema, this is highly complete.

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 description coverage is 100%, so baseline is 3. The description adds value by explaining the purpose of fields limit, the effect of compactMode on output size, and the conditional formatting default, which complements but does not merely repeat schema descriptions. It slightly exceeds the baseline by clarifying parameter interactions.

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 uses a specific verb ('reads') and resource ('all structural and formatting metadata for a sheet'), clearly distinguishing it from siblings like sheets_get_sheet_structure or sheets_get_sheet_formatting. It also explicitly frames it as a 'one-shot' comprehensive snapshot, which differentiates its scope from lighter getters.

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?

Provides clear context and a primary use case: 'Use this before programmatically recreating a sheet.' It also explains when to enable compactMode or includeConditionalFormatting, but does not explicitly name alternative lighter tools or state when not to use this tool, falling just short of a 5.

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