MCP Tools Reference: sheetsmcp.googleapis.com

Ferramenta: insert_dimension

Insere linhas ou colunas em uma planilha em um índice específico. Corresponde a um InsertDimensionRequest na API REST spreadsheets.batchUpdate: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/request

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

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": "insert_dimension",
    "arguments": {
      // provide these details according to the tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

InsertDimensionRequest

Representação JSON
{
  "spreadsheetId": string,
  "sheetId": integer,
  "dimension": enum (Dimension),
  "startIndex": integer,
  "endIndex": integer,
  "inheritFromBefore": boolean
}
Campos
spreadsheetId

string

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

sheetId

integer

Obrigatório. O ID da planilha em que será feita a inserção.

dimension

enum (Dimension)

Obrigatório. A dimensão a ser inserida.

startIndex

integer

Obrigatório. O índice inicial da inserção baseado em zero (inclusive).

endIndex

integer

Obrigatório. O índice final da inserção (exclusivo) com base em zero.

inheritFromBefore

boolean

Se as propriedades de dimensão devem ser estendidas das dimensões antes ou depois das dimensões recém-inseridas. Verdadeiro para herdar das dimensões anteriores (nesse caso, o índice inicial precisa ser maior que 0) e falso para herdar das dimensões posteriores.

Dimensão

Indica a dimensão a que uma operação deve ser aplicada.

Tipos enumerados
DIMENSION_UNSPECIFIED O valor padrão. Não use.
COLUMNS Opera nas colunas de uma planilha.
ROWS Opera nas linhas de uma planilha.

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. Principalmente, esse tipo não pode representar valores Int64 grandes ou números NaN/Infinity, já que o formato JSON geralmente não aceita esses valores no tipo de número.

Se você não pretende analisar JSON arbitrário na sua mensagem, é melhor usar uma mensagem tipada 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 com tipagem dinâmica.

Um objeto com uma lista de pares "key": value. 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, porque esses valores não são compatíveis com JSON. Isso também não pode representar valores Int64 grandes, já que o formato JSON geralmente não os aceita no tipo de número.

stringValue

string

Representa uma string JSON.

boolValue

boolean

Representa um booleano JSON (literal true ou false 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 tipos 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, independente do valor inteiro, e, portanto, fará 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
  • https://www.googleapis.com/auth/spreadsheets