`sheets_get_spreadsheet`

Pack: google_sheets · Endpoint: https://gateway.pipeworx.io/google_sheets/mcp

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

Parameters

Name	Type	Required	Description
`spreadsheet_id`	string	yes	Spreadsheet ID

Example call

Arguments

{
  "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk"
}

curl

curl -X POST https://gateway.pipeworx.io/google_sheets/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"sheets_get_spreadsheet","arguments":{"spreadsheet_id":"1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('sheets_get_spreadsheet', {
  "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk"
});

Response shape

Field	Type	Description
`spreadsheetId`	string	Spreadsheet ID
`properties`	object	Spreadsheet properties
`sheets`	array	List of sheets/tabs in the spreadsheet
`error`	string	Error code if connection required
`message`	string	Error message if connection required

Full JSON Schema

{
  "type": "object",
  "properties": {
    "spreadsheetId": {
      "type": "string",
      "description": "Spreadsheet ID"
    },
    "properties": {
      "type": "object",
      "description": "Spreadsheet properties",
      "properties": {
        "title": {
          "type": "string",
          "description": "Spreadsheet title"
        }
      }
    },
    "sheets": {
      "type": "array",
      "description": "List of sheets/tabs in the spreadsheet",
      "items": {
        "type": "object",
        "properties": {
          "properties": {
            "type": "object",
            "description": "Sheet properties",
            "properties": {
              "sheetId": {
                "type": "integer",
                "description": "Sheet ID"
              },
              "title": {
                "type": "string",
                "description": "Sheet name"
              },
              "index": {
                "type": "integer",
                "description": "Sheet index"
              },
              "sheetType": {
                "type": "string",
                "description": "Sheet type"
              },
              "gridProperties": {
                "type": "object",
                "description": "Grid dimensions and properties"
              }
            }
          }
        }
      }
    },
    "error": {
      "type": "string",
      "description": "Error code if connection required"
    },
    "message": {
      "type": "string",
      "description": "Error message if connection required"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "google_sheets": {
      "url": "https://gateway.pipeworx.io/google_sheets/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

sheets_get_spreadsheet