sheets_read

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

Read data from a Google Sheet range. Specify sheet name and range (e.g., ‘A1:C10’). Returns rows as arrays of cell values.

Parameters

NameTypeRequiredDescription
spreadsheet_idstringyesSpreadsheet ID (from the URL)
rangestringyesA1 notation range (e.g., “Sheet1!A1:D10”)

Example call

Arguments

{
  "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk",
  "range": "Sheet1!A1:D10"
}

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_read","arguments":{"spreadsheet_id":"1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk","range":"Sheet1!A1:D10"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('sheets_read', {
  "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk",
  "range": "Sheet1!A1:D10"
});

More examples

{
  "spreadsheet_id": "1BxiMVs0XRA5nFMmqvzausWYMYq6nS8twLu0gKBvMZsk",
  "range": "Sales!A1:F100"
}

Response shape

FieldTypeDescription
rangestringA1 notation range of the data read
majorDimensionstringRow major dimension (ROWS or COLUMNS)
valuesarrayArray of rows, each row is an array of cell values
errorstringError code if connection required
messagestringError message if connection required
Full JSON Schema
{
  "type": "object",
  "properties": {
    "range": {
      "type": "string",
      "description": "A1 notation range of the data read"
    },
    "majorDimension": {
      "type": "string",
      "description": "Row major dimension (ROWS or COLUMNS)"
    },
    "values": {
      "type": "array",
      "description": "Array of rows, each row is an array of cell values",
      "items": {
        "type": "array",
        "items": {}
      }
    },
    "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.

Regenerated from source · build May 9, 2026