MCP Tools Reference: sheetsmcp.googleapis.com

Strumento: get_spreadsheet

Restituisce i contenuti del foglio di lavoro specificato. Restituisce titoli, nomi dei fogli, proprietà della griglia e altri metadati per l'ID foglio di lavoro specificato. Restituisce anche i dati completi della griglia, se richiesti.

Corrisponde a spreadsheets.get nell'API REST: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

Schema: - spreadsheet_id (stringa, obbligatorio): l'ID del foglio di lavoro da richiedere. - include_grid_data (booleano, facoltativo): True se devono essere restituiti i dati della griglia. Il valore predefinito è false. - fields (array di stringhe, facoltativo): maschere di campo che specificano le proprietà da restituire (ad es. ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (booleano, facoltativo): se true, i commenti verranno inclusi nella risposta. Il valore predefinito è false. - ranges (array di stringhe, facoltativo): gli intervalli A1 o R1C1 da recuperare dal foglio di lavoro. Se non viene specificato, viene restituito l'intero foglio di lavoro.

Il seguente esempio di codice mostra come utilizzare curl per chiamare lo strumento MCP get_spreadsheet.

Richiesta curl 
curl --location 'https://sheetsmcp.googleapis.com/mcp/v1' \
--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 MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schema di input

GetContentRequest

Rappresentazione JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean,
  "fields": [
    string
  ],
  "ranges": [
    string
  ],

  "commentsIncluded": boolean
}
Campi
spreadsheetId

string

Obbligatorio. L'ID del foglio di lavoro da richiedere.
includeGridData

boolean

True se devono essere restituiti i dati della griglia.
fields[]

string

Facoltativo. Una maschera di campo per specificare le proprietà da restituire dell'API Spreadsheets. Per saperne di più su come utilizzare le maschere di campo, consulta https://developers.google.com/workspace/sheets/api/guides/field-masks. IMPORTANTE: utilizza percorsi gerarchici basati sulla struttura JSON della risposta dell'API Sheets. - Ad esempio, per ottenere il titolo e l'ID del foglio, utilizza "sheets.properties.sheetId" e "sheets.properties.title" anziché "title,sheetId". - Includi solo i campi necessari. - Per ottenere le tabelle, utilizza: "sheets.tables" o "sheets.properties". - Per ottenere i titoli e gli ID dei fogli, utilizza: "sheets.properties.sheetId" e "sheets.properties.title".
ranges[]

string

Facoltativo. La notazione A1 o R1C1 degli intervalli da recuperare dal foglio di lavoro. Se non viene specificato, viene restituito l'intero foglio di lavoro.

Campo unione _comments_included.

_comments_included può essere solo uno dei seguenti tipi:
commentsIncluded

boolean

Facoltativo. Se impostato su true, i commenti verranno inclusi nella risposta. Per impostazione predefinita, i commenti non sono inclusi.

Schema di output

GetContentResponse

Rappresentazione JSON 
{
  "content": {
    object
  }
}
Campi
content

object (Struct format)

Il foglio di lavoro, nel formato JSON della risorsa Spreadsheet dell'API Sheets.

Struct

Rappresentazione JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Campi
fields

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

Mappa non ordinata di valori con tipo dinamico.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Rappresentazione JSON 
{
  "key": string,
  "value": value
}
Campi
key

string
value

value (Value format)

Valore

Rappresentazione JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Campi
Campo unione kind. Il tipo di valore. kind può essere solo uno dei seguenti tipi:
nullValue

null

Rappresenta un null JSON.
numberValue

number

Rappresenta un numero JSON. Non deve essere NaN, Infinity o -Infinity, poiché non sono supportati in JSON. Inoltre, non può rappresentare valori Int64 di grandi dimensioni, poiché il formato JSON in genere non li supporta nel tipo di numero.
stringValue

string

Rappresenta una stringa JSON.
boolValue

boolean

Rappresentazione di un valore booleano JSON (valore letterale true o false in JSON).
structValue

object (Struct format)

Rappresenta un oggetto JSON.
listValue

array (ListValue format)

Rappresenta un array JSON.

ListValue

Rappresentazione JSON 
{
  "values": [
    value
  ]
}
Campi
values[]

value (Value format)

Campo ripetuto di valori con tipo dinamico.

NullValue

Rappresenta un null JSON.

NullValue è un sentinel che utilizza un enum con un solo valore per rappresentare il valore null per l'unione di tipi Value.

Un campo di tipo NullValue con un valore diverso da 0 è considerato non valido. La maggior parte dei serializzatori ProtoJSON emetterà un Value con un null_value impostato come null JSON indipendentemente dal valore intero, quindi eseguirà un round trip a un valore 0.

Enum
NULL_VALUE Valore null.

Annotazioni dello strumento

Le annotazioni degli strumenti vengono inviate ai client MCP per descrivere il rischio di base di un determinato strumento. La maggior parte dei client considera questi suggerimenti non attendibili, ma possono essere utilizzati per decidere quando inviare un prompt di conferma a un utente.

Oltre alla stringa del titolo, i seguenti suggerimenti booleani sono definiti come segue:

  • readOnlyHint: se true, lo strumento non modifica il suo ambiente. Valore predefinito: false.
  • destructiveHint: se true, lo strumento può eseguire azioni distruttive. Se false, lo strumento può eseguire solo azioni additive. Valore predefinito: true.
  • idempotentHint: se true, la chiamata ripetuta dello strumento con gli stessi argomenti non avrà alcun effetto aggiuntivo sul suo ambiente. Valore predefinito: false.
  • openWorldHint: se true, lo strumento può interagire con un "open world" di entità esterne. Se è false, lo strumento può interagire solo con entità interne. Ad esempio, uno strumento di ricerca web sarebbe open world, mentre uno strumento di memoria non lo sarebbe.

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ✅

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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