MCP Tools Reference: sheetsmcp.googleapis.com

Tool: get_spreadsheet

Gibt den Inhalt der angegebenen Tabelle zurück. Gibt Titel, Tabellennamen, Rastereigenschaften und andere Metadaten für die angegebene Tabellen-ID zurück. Gibt auf Anfrage auch vollständige Rasterdaten zurück.

Entspricht „spreadsheets.get“ in der REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

Schema: - spreadsheet_id (String, erforderlich): Die ID der Tabelle, die angefordert werden soll. - include_grid_data (boolesch, optional): „True“, wenn Rasterdaten zurückgegeben werden sollen. Die Standardeinstellung ist "false". - fields (Array von Strings, optional): Feldmasken, die angeben, welche Attribute zurückgegeben werden sollen (z.B. ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (boolescher Wert, optional): Wenn „true“, werden Kommentare in die Antwort aufgenommen. Die Standardeinstellung ist "false". - ranges (Array von Strings, optional): Die A1- oder R1C1-Bereiche, die aus der Tabelle abgerufen werden sollen. Wenn nichts angegeben ist, wird die gesamte Tabelle zurückgegeben.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool get_spreadsheet aufrufen.

Curl-Anfrage 
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
}'

Eingabeschema

GetContentRequest

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

  "commentsIncluded": boolean
}
Felder
spreadsheetId

string

Erforderlich. Die ID der Tabelle, die angefordert werden soll.
includeGridData

boolean

„True“, wenn Rasterdaten zurückgegeben werden sollen.
fields[]

string

Optional. Eine Feldmaske, mit der angegeben wird, welche Eigenschaften der Spreadsheets API zurückgegeben werden sollen. Weitere Informationen zur Verwendung von Feldmasken finden Sie unter https://developers.google.com/workspace/sheets/api/guides/field-masks. WICHTIG: Verwenden Sie hierarchische Pfade, die auf der JSON-Antwortstruktur der Sheets API basieren. – Wenn Sie beispielsweise den Titel und die ID des Tabellenblatts abrufen möchten, verwenden Sie „sheets.properties.sheetId“ und „sheets.properties.title“ anstelle von „title,sheetId“. - Schließen Sie nur die Felder ein, die Sie benötigen. - To get tables, use: 'sheets.tables' or 'sheets.properties'. - To get sheet titles and IDs, use: 'sheets.properties.sheetId' and 'sheets.properties.title'.
ranges[]

string

Optional. Die A1-Notation oder R1C1-Notation der Bereiche, die aus der Tabelle abgerufen werden sollen. Wenn nichts angegeben ist, wird die gesamte Tabelle zurückgegeben.

Union-Feld _comments_included.

Für _comments_included ist nur einer der folgenden Werte zulässig:
commentsIncluded

boolean

Optional. Wenn „true“, werden Kommentare in die Antwort aufgenommen. Standardmäßig sind Kommentare nicht enthalten.

Ausgabeschema

GetContentResponse

JSON-Darstellung 
{
  "content": {
    object
  }
}
Felder
content

object (Struct format)

Die Tabelle im JSON-Format der Spreadsheet-Ressource der Sheets API.

Struct

JSON-Darstellung 
{
  "fields": {
    string: value,
    ...
  }
}
Felder
fields

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

Ungeordnete Zuordnung von dynamisch typisierten Werten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

JSON-Darstellung 
{
  "key": string,
  "value": value
}
Felder
key

string
value

value (Value format)

Wert

JSON-Darstellung 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Felder
Union-Feld kind. Die Art des Werts. Für kind ist nur einer der folgenden Werte zulässig:
nullValue

null

Stellt ein JSON-null dar.
numberValue

number

Stellt eine JSON-Zahl dar. Darf nicht NaN, Infinity oder -Infinity sein, da diese in JSON nicht unterstützt werden. Außerdem können damit keine großen Int64-Werte dargestellt werden, da das JSON-Format diese im Zahlentyp im Allgemeinen nicht unterstützt.
stringValue

string

Stellt einen JSON-String dar.
boolValue

boolean

Stellt einen booleschen JSON-Wert dar (true- oder false-Literal in JSON).
structValue

object (Struct format)

Stellt ein JSON-Objekt dar.
listValue

array (ListValue format)

Stellt ein JSON-Array dar.

ListValue

JSON-Darstellung 
{
  "values": [
    value
  ]
}
Felder
values[]

value (Value format)

Wiederkehrendes Feld mit dynamisch typisierten Werten.

NullValue

Stellt ein JSON-null dar.

NullValue ist ein Sentinel, der ein Enum mit nur einem Wert verwendet, um den Nullwert für die Typunion Value darzustellen.

Ein Feld vom Typ NullValue mit einem anderen Wert als 0 gilt als ungültig. Die meisten ProtoJSON-Serialisierer geben unabhängig vom Ganzzahlwert einen Value mit einem null_value aus, der als JSON-null festgelegt ist, und runden ihn auf einen 0-Wert.

Enums
NULL_VALUE Nullwert.

Tool-Annotationen

Tool-Anmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.

Zusätzlich zum Titelstring werden die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“, ändert das Tool seine Umgebung nicht. Standardeinstellung: false.
  • destructiveHint: Wenn „true“, kann das Tool destruktive Aktionen ausführen. Wenn „false“, kann das Tool nur additive Aktionen ausführen. Standardeinstellung: true.
  • idempotentHint: Wenn „true“, hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf die Umgebung. Standardeinstellung: false.
  • openWorldHint: Wenn „true“, kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“, kann das Tool nur mit internen Entitäten interagieren. Ein Tool für die Websuche wäre beispielsweise ein Open-World-Tool, ein Tool für gemerkte Informationen dagegen nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ✅ | Lesezugriff-Hinweis: ✅ | Open-World-Hinweis: ✅

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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