MCP Tools Reference: sheetsmcp.googleapis.com

Alat: get_spreadsheet

Menampilkan konten spreadsheet untuk spreadsheet yang diberikan. Menampilkan judul, nama sheet, properti petak, dan metadata lainnya untuk ID spreadsheet yang diberikan. Juga menampilkan data petak lengkap jika diminta.

Sesuai dengan spreadsheets.get di REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

: - spreadsheet_id (string, wajib): ID spreadsheet yang akan diminta. include_grid_data (boolean, opsional): True jika data petak harus ditampilkan. Nilai defaultnya adalah false (salah). - fields (array string, opsional): Masker kolom yang menentukan properti yang akan ditampilkan (misalnya, ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (boolean, opsional): Jika benar, komentar akan disertakan dalam respons. Nilai defaultnya adalah false (salah). - ranges (array string, opsional): Rentang A1 atau R1C1 yang akan diambil dari spreadsheet. Jika tidak ditentukan, seluruh spreadsheet akan ditampilkan.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_spreadsheet.

Permintaan 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
}'

Skema Input

GetContentRequest

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

  "commentsIncluded": boolean
}
Kolom
spreadsheetId

string

Wajib. ID spreadsheet yang akan diminta.
includeGridData

boolean

Benar jika data petak harus ditampilkan.
fields[]

string

Opsional. Mask kolom untuk menentukan properti mana yang akan ditampilkan dari Spreadsheets API, lihat https://developers.google.com/workspace/sheets/api/guides/field-masks untuk mengetahui informasi selengkapnya tentang cara menggunakan mask kolom. PENTING: Gunakan jalur hierarkis berdasarkan struktur JSON respons Sheets API. - Misalnya, untuk mendapatkan judul dan ID sheet, gunakan 'sheets.properties.sheetId' dan 'sheets.properties.title', bukan 'title,sheetId'. - Hanya sertakan kolom yang Anda perlukan. - Untuk mendapatkan tabel, gunakan: 'sheets.tables' atau 'sheets.properties'. - Untuk mendapatkan judul dan ID sheet, gunakan: 'sheets.properties.sheetId' dan 'sheets.properties.title'.
ranges[]

string

Opsional. Notasi A1 atau notasi R1C1 dari rentang yang akan diambil dari spreadsheet. Jika tidak ditentukan, seluruh spreadsheet akan ditampilkan.

Kolom union _comments_included.

_comments_included hanya dapat berupa salah satu dari hal berikut:
commentsIncluded

boolean

Opsional. Jika benar, komentar akan disertakan dalam respons. Secara default, komentar tidak disertakan.

Skema Output

GetContentResponse

Representasi JSON 
{
  "content": {
    object
  }
}
Kolom
content

object (Struct format)

Spreadsheet, dalam format JSON dari resource Spreadsheet Sheets API.

Struct

Representasi JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Kolom
fields

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

Peta nilai yang diketik secara dinamis dan tidak diurutkan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representasi JSON 
{
  "key": string,
  "value": value
}
Kolom
key

string
value

value (Value format)

Nilai

Representasi JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Kolom
Kolom union kind. Jenis nilai. kind hanya dapat berupa salah satu dari berikut:
nullValue

null

Merepresentasikan null JSON.
numberValue

number

Merepresentasikan angka JSON. Tidak boleh NaN, Infinity, atau -Infinity, karena tidak didukung di JSON. Hal ini juga tidak dapat merepresentasikan nilai Int64 yang besar, karena format JSON umumnya tidak mendukungnya dalam jenis angkanya.
stringValue

string

Mewakili string JSON.
boolValue

boolean

Merepresentasikan boolean JSON (literal true atau false dalam JSON).
structValue

object (Struct format)

Mewakili objek JSON.
listValue

array (ListValue format)

Mewakili array JSON.

ListValue

Representasi JSON 
{
  "values": [
    value
  ]
}
Kolom
values[]

value (Value format)

Kolom berulang dari nilai yang diketik secara dinamis.

NullValue

Merepresentasikan null JSON.

NullValue adalah sentinel, yang menggunakan enum dengan hanya satu nilai untuk merepresentasikan nilai null untuk gabungan jenis Value.

Kolom jenis NullValue dengan nilai selain 0 dianggap tidak valid. Sebagian besar serializer ProtoJSON akan memunculkan Value dengan null_value yang ditetapkan sebagai null JSON, terlepas dari nilai bilangan bulatnya, sehingga akan melakukan perjalanan pulang pergi ke nilai 0.

Enum
NULL_VALUE Nilai null.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk tersebut dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim kepada pengguna.

Bersama dengan string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah (false), alat hanya dapat melakukan tindakan aditif. Default: true.
  • idempotentHint: Jika benar, memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'open world' entitas eksternal. Jika salah, alat hanya dapat berinteraksi dengan entity internal. Misalnya, alat penelusuran web akan bersifat open world, sedangkan alat memori tidak akan bersifat open world.

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

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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