MCP Tools Reference: sheetsmcp.googleapis.com

Ferramenta: get_spreadsheet

Retorna o conteúdo da planilha. Retorna títulos, nomes de páginas, propriedades de grade e outros metadados para o ID da planilha. Também retorna dados completos da grade, se solicitado. Corresponde a spreadsheets.get na API REST: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

O exemplo a seguir demonstra como usar curl para invocar a ferramenta MCP get_spreadsheet.

Solicitação curl
curl --location 'https://sheetsmcp.googleapis.com/mcp' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_spreadsheet",
    "arguments": {
      // provide these details according to the tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

GetContentRequest

Representação JSON
{
  "spreadsheetId": string,
  "includeGridData": boolean
}
Campos
spreadsheetId

string

Obrigatório. O ID da planilha a ser solicitada.

includeGridData

boolean

Verdadeiro se os dados da grade precisarem ser retornados.

Esquema de saída

Representa um objeto JSON.

Um mapa de chave-valor não ordenado, com o objetivo de capturar perfeitamente a semântica de um objeto JSON. Isso permite analisar qualquer payload JSON arbitrário como um campo de mensagem no formato ProtoJSON.

Isso segue as diretrizes da RFC 8259 para JSON interoperável: esse tipo não pode representar valores Int64 grandes ou números NaN/Infinity, já que o formato JSON geralmente não oferece suporte a esses valores no tipo de número.

Se você não pretende analisar JSON arbitrário na sua mensagem, é preferível usar uma mensagem digitada personalizada em vez desse tipo.

Struct

Representação JSON
{
  "fields": {
    string: value,
    ...
  }
}
Campos
fields

map (key: string, value: value (Value format))

Mapa não ordenado de valores digitados dinamicamente.

Um objeto que contém uma lista de "key": value pares. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representação JSON
{
  "key": string,
  "value": value
}
Campos
key

string

value

value (Value format)

Valor

Representação JSON
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Campos
Campo de união kind. É o tipo de valor. kind pode ser apenas de um dos tipos a seguir:
nullValue

null

Representa um null JSON.

numberValue

number

Representa um número JSON. Não pode ser NaN, Infinity ou -Infinity, já que esses valores não são aceitos em JSON. Isso também não pode representar valores Int64 grandes, já que o formato JSON geralmente não oferece suporte a eles no tipo de número.

stringValue

string

Representa uma string JSON.

boolValue

boolean

Representa um booleano JSON (true ou false literal em JSON).

structValue

object (Struct format)

Representa um objeto JSON.

listValue

array (ListValue format)

Representa uma matriz JSON.

ListValue

Representação JSON
{
  "values": [
    value
  ]
}
Campos
values[]

value (Value format)

Campo repetido de valores digitados dinamicamente.

NullValue

Representa um null JSON.

NullValue é um sentinela que usa uma enumeração com apenas um valor para representar o valor nulo da união de tipo Value.

Um campo do tipo NullValue com qualquer valor diferente de 0 é considerado inválido. A maioria dos serializadores ProtoJSON vai emitir um Value com um null_value definido como um null JSON, independentemente do valor inteiro, e, portanto, vai fazer uma viagem de ida e volta para um valor 0.

Tipos enumerados
NULL_VALUE Valor nulo.

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ✅ | Dica somente leitura: ✅ | Dica de mundo aberto: ✅

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/spreadsheets.readonly
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets