MCP Tools Reference: sheetsmcp.googleapis.com

Narzędzie: get_spreadsheet

Zwraca zawartość podanego arkusza kalkulacyjnego. Zwraca tytuły, nazwy arkuszy, właściwości siatki i inne metadane dla danego identyfikatora arkusza kalkulacyjnego. Zwraca też pełne dane siatki, jeśli jest to wymagane.

Odpowiada metodzie spreadsheets.get w interfejsie REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

Schemat: - spreadsheet_id (ciąg znaków, wymagany): identyfikator arkusza kalkulacyjnego, którego dotyczy żądanie. - include_grid_data (wartość logiczna, opcjonalna): True, jeśli mają być zwracane dane siatki. Wartość domyślna to fałsz. - fields (tablica ciągów znaków, opcjonalna): maski pól określające, które właściwości mają zostać zwrócone (np. ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (wartość logiczna, opcjonalna): jeśli ma wartość „true”, komentarze zostaną uwzględnione w odpowiedzi. Wartość domyślna to fałsz. - ranges (tablica ciągów znaków, opcjonalna): zakresy A1 lub R1C1 do pobrania z arkusza kalkulacyjnego. Jeśli nie zostanie określony, zwracany jest cały arkusz kalkulacyjny.

Poniższy przykładowy kod pokazuje, jak używać curl do wywoływania narzędzia MCP get_spreadsheet.

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

Schemat wejściowy

GetContentRequest

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

  "commentsIncluded": boolean
}
Pola
spreadsheetId

string

Wymagane. Identyfikator arkusza kalkulacyjnego, którego dotyczy żądanie.
includeGridData

boolean

Wartość „true”, jeśli mają zostać zwrócone dane siatki.
fields[]

string

Opcjonalnie: Maska pola określająca, które właściwości interfejsu Spreadsheets API mają zostać zwrócone. Więcej informacji o używaniu masek pól znajdziesz na stronie https://developers.google.com/workspace/sheets/api/guides/field-masks. WAŻNE: używaj ścieżek hierarchicznych opartych na strukturze odpowiedzi JSON interfejsu Sheets API. – Aby na przykład uzyskać tytuł i identyfikator arkusza, użyj „sheets.properties.sheetId” i „sheets.properties.title” zamiast „title,sheetId”. – Uwzględnij tylko te pola, których potrzebujesz. – Aby uzyskać tabele, użyj: „sheets.tables” lub „sheets.properties”. – Aby uzyskać tytuły i identyfikatory arkuszy, użyj: „sheets.properties.sheetId” i „sheets.properties.title”.
ranges[]

string

Opcjonalnie: Notacja A1 lub R1C1 zakresów do pobrania z arkusza kalkulacyjnego. Jeśli nie zostanie określony, zwracany jest cały arkusz kalkulacyjny.

Pole zbiorcze _comments_included.

Pole _comments_included może mieć tylko jedną z tych wartości:
commentsIncluded

boolean

Opcjonalnie: Jeśli ma wartość „true”, komentarze zostaną uwzględnione w odpowiedzi. Domyślnie komentarze nie są uwzględniane.

Schemat wyjściowy

GetContentResponse

Zapis JSON 
{
  "content": {
    object
  }
}
Pola
content

object (Struct format)

Arkusz kalkulacyjny w formacie JSON zasobu interfejsu Sheets API Spreadsheet.

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 obiekt JSON null.
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 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)

Pole powtarzane wartości wpisywanych dynamicznie.

NullValue

Reprezentuje obiekt JSON null.

NullValue to wartownik, który używa typu wyliczeniowego z tylko jedną wartością do reprezentowania wartości null dla unii typu Value.

Pole typu NullValue z dowolną wartością inną niż 0 jest uznawane za nieprawidłowe. Większość serializatorów ProtoJSON będzie emitować Value z ustawionym null_value jako JSON null niezależnie od wartości liczby całkowitej, więc będzie to wartość 0.

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

Adnotacje dotyczące narzędzi

Adnotacje narzędzi są wysyłane do klientów MCP, aby opisać podstawowe ryzyko związane z danym narzędziem. Większość klientów traktuje te wskazówki jako niezaufane, ale można ich użyć do określenia, kiedy wysłać użytkownikowi prośbę o potwierdzenie.

Oprócz ciągu tytułu zdefiniowane są te wskazówki logiczne:

  • readOnlyHint: jeśli ma wartość „true”, narzędzie nie modyfikuje swojego środowiska. Wartość domyślna: false.
  • destructiveHint: jeśli ma wartość „true”, narzędzie może wykonywać działania destrukcyjne. Jeśli ma wartość false, narzędzie może wykonywać tylko działania dodawania. Wartość domyślna: true.
  • idempotentHint: jeśli ma wartość „true”, wielokrotne wywoływanie narzędzia z tymi samymi argumentami nie będzie miało dodatkowego wpływu na jego środowisko. Wartość domyślna: false.
  • openWorldHint: jeśli ma wartość true, narzędzie może wchodzić w interakcje z „otwartym światem” elementów zewnętrznych. Jeśli ma wartość false, narzędzie może wchodzić w interakcje tylko z elementami wewnętrznymi. Na przykład narzędzie do wyszukiwania w internecie jest narzędziem typu Otwarty świat, ale narzędzie do zapamiętywania już nie.

Wskazówka dotycząca niszczenia: ❌ | Wskazówka dotycząca idempotencji: ✅ | Wskazówka dotycząca tylko do odczytu: ✅ | Wskazówka dotycząca otwartego świata: ✅

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