Skip to main content
Glama
Sign In

Google_sheets

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Sheets Get Spreadsheet

sheets_get_spreadsheet
Read-onlyIdempotent

Explore a spreadsheet's structure. Returns title, sheet/tab names, and properties. Use before reading or writing data.

Input Schema

NameRequiredDescriptionDefault
spreadsheet_idYesSpreadsheet ID

Output Schema

NameRequiredDescriptionDefault
errorNoError code if connection required
sheetsNoList of sheets/tabs in the spreadsheet
messageNoError message if connection required
propertiesNoSpreadsheet properties
spreadsheetIdNoSpreadsheet ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "error": {
+      "description": "Error code if connection required",
+      "type": "string"
+    },
+    "message": {
+      "description": "Error message if connection required",
+      "type": "string"
+    },
+    "properties": {
+      "description": "Spreadsheet properties",
+      "properties": {
+        "title": {
+          "description": "Spreadsheet title",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "sheets": {
+      "description": "List of sheets/tabs in the spreadsheet",
+      "items": {
+        "properties": {
+          "properties": {
+            "description": "Sheet properties",
+            "properties": {
+              "gridProperties": {
+                "description": "Grid dimensions and properties",
+                "type": "object"
+              },
+              "index": {
+                "description": "Sheet index",
+                "type": "integer"
+              },
+              "sheetId": {
+                "description": "Sheet ID",
+                "type": "integer"
+              },
+              "sheetType": {
+                "description": "Sheet type",
+                "type": "string"
+              },
+              "title": {
+                "description": "Sheet name",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "spreadsheetId": {
+      "description": "Spreadsheet ID",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk"
+  }
+]
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already specify readOnlyHint, openWorldHint, idempotentHint, and destructiveHint, covering safety and idempotency. The description adds that it returns title, sheet/tab names, and properties, which is consistent but does not introduce new behavioral traits beyond what annotations imply.

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?

Two concise sentences: first states function, second gives usage advice. No redundant or unnecessary information, each sentence earns its place.

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?

The tool is simple with one parameter and an output schema (not shown). Description mentions key return items (title, names, properties), which is sufficient. Could be slightly more specific about 'properties,' but overall complete given context.

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 coverage is 100% and the only parameter 'spreadsheet_id' is described as 'Spreadsheet ID' with an example. The description does not add additional meaning or formatting requirements beyond the schema.

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?

Description explicitly states the tool explores spreadsheet structure and lists return items (title, sheet/tab names, properties). It also suggests a use case before reading/writing, clearly distinguishing it from sibling tools like sheets_read, sheets_write, sheets_append.

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?

Description explicitly states 'Use before reading or writing data,' providing clear context for when to use. While it does not mention alternatives, the usage guidance is direct and helpful.

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

All Google_sheets toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources