MCP Tools Reference: sheetsmcp.googleapis.com

Outil : get_spreadsheet

Renvoie le contenu de la feuille de calcul donnée. Renvoie les titres, les noms des feuilles, les propriétés de la grille et d'autres métadonnées pour l'ID de feuille de calcul donné. Renvoie également les données de grille complètes si elles sont demandées.

Correspond à spreadsheets.get dans l'API REST : https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

Schéma : - spreadsheet_id (chaîne, obligatoire) : ID de la feuille de calcul à demander. - include_grid_data (booléen, facultatif) : "true" si les données de la grille doivent être renvoyées. Valeur par défaut : "false". - fields (tableau de chaînes, facultatif) : masques de champ spécifiant les propriétés à renvoyer (par exemple, ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (booléen, facultatif) : si la valeur est "true", les commentaires seront inclus dans la réponse. Valeur par défaut : "false". - ranges (tableau de chaînes, facultatif) : plages A1 ou R1C1 à récupérer dans la feuille de calcul. Si ce paramètre n'est pas spécifié, l'intégralité de la feuille de calcul est renvoyée.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP get_spreadsheet.

Requête 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
}'

Schéma d'entrée

GetContentRequest

Représentation JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean,
  "fields": [
    string
  ],
  "ranges": [
    string
  ],

  "commentsIncluded": boolean
}
Champs
spreadsheetId

string

Obligatoire. ID de la feuille de calcul à demander.
includeGridData

boolean

"True" si les données de la grille doivent être renvoyées.
fields[]

string

Facultatif. Masque de champ permettant de spécifier les propriétés à renvoyer de l'API Spreadsheets. Pour en savoir plus sur l'utilisation des masques de champ, consultez https://developers.google.com/workspace/sheets/api/guides/field-masks. IMPORTANT : Utilisez des chemins hiérarchiques basés sur la structure de réponse JSON de l'API Sheets. - Par exemple, pour obtenir le titre et l'ID de la feuille, utilisez "sheets.properties.sheetId" et "sheets.properties.title" au lieu de "title,sheetId". - N'incluez que les champs dont vous avez besoin. - Pour obtenir des tableaux, utilisez "sheets.tables" ou "sheets.properties". - Pour obtenir les titres et les ID des feuilles, utilisez "sheets.properties.sheetId" et "sheets.properties.title".
ranges[]

string

Facultatif. Notation A1 ou R1C1 des plages à récupérer à partir de la feuille de calcul. Si ce paramètre n'est pas spécifié, l'intégralité de la feuille de calcul est renvoyée.

Champ d'union _comments_included.

_comments_included ne peut être qu'un des éléments suivants :
commentsIncluded

boolean

Facultatif. Si la valeur est "true", les commentaires seront inclus dans la réponse. Par défaut, les commentaires ne sont pas inclus.

Schéma de sortie

GetContentResponse

Représentation JSON 
{
  "content": {
    object
  }
}
Champs
content

object (Struct format)

Feuille de calcul, au format JSON de la ressource Spreadsheet de l'API Sheets.

Struct

Représentation JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Champs
fields

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

Mappage non ordonné de valeurs saisies de manière dynamique.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Représentation JSON 
{
  "key": string,
  "value": value
}
Champs
key

string
value

value (Value format)

Valeur

Représentation JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Champs
Champ d'union kind. Type de valeur. kind ne peut être qu'un des éléments suivants :
nullValue

null

Représente un null JSON.
numberValue

number

Représente un nombre JSON. Ne doit pas être NaN, Infinity ni -Infinity, car ces valeurs ne sont pas acceptées en JSON. Il ne peut pas non plus représenter de grandes valeurs Int64, car le format JSON ne les accepte généralement pas dans son type de nombre.
stringValue

string

Représente une chaîne JSON.
boolValue

boolean

Représente une valeur booléenne JSON (littéral true ou false en JSON).
structValue

object (Struct format)

Représente un objet JSON.
listValue

array (ListValue format)

Représente un tableau JSON.

ListValue

Représentation JSON 
{
  "values": [
    value
  ]
}
Champs
values[]

value (Value format)

Champ répété de valeurs saisies de manière dynamique.

NullValue

Représente un null JSON.

NullValue est une sentinelle qui utilise une énumération avec une seule valeur pour représenter la valeur nulle pour l'union de types Value.

Un champ de type NullValue avec une valeur autre que 0 est considéré comme non valide. La plupart des sérialiseurs ProtoJSON émettent un Value avec un null_value défini comme un null JSON, quelle que soit la valeur entière, et effectuent donc un aller-retour vers une valeur 0.

Enums
NULL_VALUE Valeur nulle.

Annotations d'outils

Les annotations d'outil sont envoyées aux clients MCP pour décrire le risque de base d'un outil donné. La plupart des clients considèrent ces indications comme non fiables, mais elles peuvent être utilisées pour décider quand envoyer une invite de confirmation à un utilisateur.

En plus de la chaîne de titre, les indices booléens suivants sont définis comme suit :

  • readOnlyHint : si la valeur est "true", l'outil ne modifie pas son environnement. Valeur par défaut : "false".
  • destructiveHint : si la valeur est "true", l'outil peut effectuer des actions destructrices. Si la valeur est "false", l'outil ne peut effectuer que des actions d'ajout. Valeur par défaut : "true".
  • idempotentHint : si la valeur est "true", l'appel répété de l'outil avec les mêmes arguments n'aura aucun effet supplémentaire sur son environnement. Valeur par défaut : "false".
  • openWorldHint : si la valeur est "true", l'outil peut interagir avec un "monde ouvert" d'entités externes. Si la valeur est "false", l'outil ne peut interagir qu'avec des entités internes. Par exemple, un outil de recherche sur le Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indication de destruction : ❌ | Indication d'idempotence : ✅ | Indication de lecture seule : ✅ | Indication de monde ouvert : ✅

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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