Skip to main content
Glama

gws-mcp__sheets_get_metadata

Read-only

Describes the structure of a Google Sheets spreadsheet without reading any cell. Takes the spreadsheet ID. Returns the spreadsheet's title, locale, time zone and link, and one entry per tab in tab order: its title, its numeric sheetId, its position, its type, whether it is hidden, its grid size in rows and columns, and how many rows and columns are frozen. The title is what range arguments name a tab by; the sheetId is what sheets_batch_update requests address a tab by. Cell values, formulas and formatting are not part of the response at any spreadsheet size.

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": {
      "spreadsheet_id": "<spreadsheet_id>"
    },
    "name": "gws-mcp__sheets_get_metadata"
  }
}

Input Schema

NameRequiredDescriptionDefault
accountNoOptional email address of the connected account to use (e.g. 'user@gmail.com'). If omitted, the default account is used.
spreadsheet_idYesThe spreadsheet ID (from the URL)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, yet the description still adds real value: it enumerates the exact response surface, states that cell values, formulas and formatting are never returned, and asserts this holds 'at any spreadsheet size'. It does not discuss permissions or error behavior, but for a read-only metadata call that gap is minor.

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?

Four sentences, front-loaded with the what and the scope boundary, then the return inventory, then the practical title-vs-sheetId distinction. Dense and largely waste-free, though the closing negative statement partially repeats the opening 'without reading any cell' constraint.

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?

No output schema exists, so the description carries the full return-value burden and does so thoroughly, enumerating spreadsheet-level fields and the per-tab fields including frozen row/column counts. For a two-parameter read tool this leaves nothing an agent needs missing before calling it or interpreting the response.

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?

Parameter semantics are solid: 'Takes the spreadsheet ID' restates the required spreadsheet_id and the schema description ('from the URL') adds the sourcing hint. A 3 would be baseline-correct, but the description exceeds that by tying the returned title and sheetId to concrete downstream uses. The optional account parameter is left to its schema description, which is explicit about defaulting.

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 and resource ('Describes the structure of a Google Sheets spreadsheet') and immediately bounds the scope with 'without reading any cell', which cleanly separates it from gws-mcp__sheets_read and gws-mcp__sheets_query in the sibling set. An agent can distinguish it without opening any 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?

The 'without reading any cell' phrasing implies the when-to-use case (structure-only inspection) and the closing line about title vs sheetId tells the agent which returned field feeds which downstream sibling (range arguments vs sheets_batch_update). It never states an explicit alternative or exclusion, e.g. 'use this before sheets_batch_update to resolve tab names to sheetIds', so it stops short of a full 5.

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.