MCP Tools Reference: sheetsmcp.googleapis.com

Narzędzie: get_spreadsheet

Zwraca zawartość arkusza kalkulacyjnego dla danego arkusza. Zwraca tytuły, nazwy arkuszy, właściwości siatki i inne metadane dla podanego identyfikatora arkusza kalkulacyjnego. W razie potrzeby zwraca też pełne dane siatki. Odpowiada metodzie spreadsheets.get w interfejsie REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

Poniższy przykład pokazuje, jak za pomocą curl wywołać narzędzie get_spreadsheet MCP.

Żądanie 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
}'

Schemat danych wejściowych

GetContentRequest

Zapis JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean
}
Pola
spreadsheetId

string

Wymagane. Identyfikator arkusza kalkulacyjnego, o który chcesz poprosić.
includeGridData

boolean

Wartość „prawda”, jeśli mają zostać zwrócone dane siatki.

Schemat wyjściowy

Reprezentuje obiekt JSON.

Nieuporządkowana mapa klucz-wartość, która ma w pełni odzwierciedlać semantykę obiektu JSON. Umożliwia to analizowanie dowolnego ładunku JSON jako pola wiadomości w formacie ProtoJSON.

Jest to zgodne z wytycznymi RFC 8259 dotyczącymi interoperacyjnego formatu JSON: ten typ nie może reprezentować dużych wartości Int64 ani liczb NaN/Infinity, ponieważ format JSON nie obsługuje tych wartości w swoim typie liczbowym.

Jeśli nie zamierzasz analizować dowolnego kodu JSON w wiadomości, zamiast tego typu wiadomości lepiej użyć niestandardowej wiadomości z określonym typem.

Struct

Zapis JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Pola
fields

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

Nieuporządkowana mapa wartości o typie dynamicznym.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

FieldsEntry

Zapis JSON 
{
  "key": string,
  "value": value
}
Pola
key

string
value

value (Value format)

Wartość

Zapis JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Pola
Pole zbiorcze kind. Rodzaj wartości. kind może mieć tylko jedną z tych wartości:
nullValue

null

Reprezentuje null JSON.
numberValue

number

Reprezentuje liczbę JSON. Nie może to być NaN, Infinity ani -Infinity, ponieważ te wartości nie są obsługiwane w formacie JSON. Nie może też reprezentować dużych wartości Int64, ponieważ format JSON zwykle nie obsługuje ich w swoim typie liczbowym.
stringValue

string

Reprezentuje ciąg JSON.
boolValue

boolean

Reprezentuje wartość logiczną JSON (literał true lub false w formacie JSON).
structValue

object (Struct format)

Reprezentuje obiekt JSON.
listValue

array (ListValue format)

Reprezentuje tablicę JSON.

ListValue

Zapis JSON 
{
  "values": [
    value
  ]
}
Pola
values[]

value (Value format)

Powtórzone pole wartości o dynamicznym typie.

NullValue

Reprezentuje null JSON.

NullValue to wartość strażnicza, która za pomocą wyliczenia z tylko jedną wartością reprezentuje wartość null dla unii typów Value.

Pole typu NullValue z wartością inną niż 0 jest uznawane za nieprawidłowe. Większość serializatorów ProtoJSON wygeneruje wartość Value z wartością null_value ustawioną jako null JSON niezależnie od wartości całkowitej, a więc będzie zaokrąglać do wartości 0.

Wartości w polu enum
NULL_VALUE Wartość null.

Adnotacje narzędzi

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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