MCP Tools Reference: sheetsmcp.googleapis.com

כלי: get_spreadsheet

הפונקציה מחזירה את התוכן של הגיליון האלקטרוני שצוין. הפונקציה מחזירה כותרות, שמות של גיליונות, מאפייני רשת ומטא-נתונים אחרים של מזהה הגיליון האלקטרוני שצוין. היא גם מחזירה את נתוני הרשת המלאים אם מבקשים אותם.

תואם ל-spreadsheets.get ב-API בארכיטקטורת REST‏: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

סכימה: - spreadsheet_id (מחרוזת, חובה): המזהה של הגיליון האלקטרוני שרוצים לבקש. ‫- include_grid_data (ערך בוליאני, אופציונלי): True אם צריך להחזיר נתוני רשת. ברירת המחדל היא False. ‫- fields (מערך של מחרוזות, אופציונלי): מסכות שדות שמציינות אילו מאפיינים להחזיר (למשל ["sheets.properties.sheetId", "sheets.properties.title"]). - comments_included (בוליאני, אופציונלי): אם הערך הוא true, התגובות ייכללו בתשובה. ברירת המחדל היא False. ‫- ranges (מערך של מחרוזות, אופציונלי): הטווחים בפורמט A1 או R1C1 שצריך לאחזר מהגיליון האלקטרוני. אם לא מציינים טווח, הפונקציה מחזירה את כל הגיליון האלקטרוני.

בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP‏ get_spreadsheet.

בקשת 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
}'

סכימת הקלט

GetContentRequest

ייצוג ב-JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean,
  "fields": [
    string
  ],
  "ranges": [
    string
  ],

  "commentsIncluded": boolean
}
שדות
spreadsheetId

string

חובה. המזהה של הגיליון האלקטרוני שרוצים לבקש.
includeGridData

boolean

הערך True אם צריך להחזיר נתוני רשת.
fields[]

string

אופציונלי. מסכת שדות כדי לציין אילו מאפיינים להחזיר מ-Spreadsheets API. בכתובת https://developers.google.com/workspace/sheets/api/guides/field-masks מוסבר איך להשתמש במסכות השדות. חשוב: צריך להשתמש בנתיבים היררכיים שמבוססים על מבנה ה-JSON של התגובה של Sheets API. - לדוגמה, כדי לקבל את שם הגיליון והמזהה, צריך להשתמש ב-"sheets.properties.sheetId" וב-"sheets.properties.title" במקום ב-"title,sheetId". - לכלול רק את השדות שצריך. - כדי לקבל טבלאות, צריך להשתמש ב-"sheets.tables" או ב-"sheets.properties". - כדי לקבל את השמות והמזהים של הגיליונות, משתמשים ב-'sheets.properties.sheetId' וב-'sheets.properties.title'.
ranges[]

string

אופציונלי. סימון A1 או סימון R1C1 של הטווחים שרוצים לאחזר מהגיליון האלקטרוני. אם לא מציינים טווח, הפונקציה מחזירה את כל הגיליון האלקטרוני.

שדה של איחוד _comments_included.

הערך _comments_included יכול להיות רק אחד מהבאים:
commentsIncluded

boolean

אופציונלי. אם הערך הוא true, התגובות ייכללו בתשובה. כברירת מחדל, התגובות לא נכללות.

סכימת הפלט

GetContentResponse

ייצוג ב-JSON 
{
  "content": {
    object
  }
}
שדות
content

object (Struct format)

הגיליון האלקטרוני, בפורמט JSON של המשאב Spreadsheet ב-Sheets API.

Struct

ייצוג ב-JSON 
{
  "fields": {
    string: value,
    ...
  }
}
שדות
fields

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

מפה לא מסודרת של ערכים שהוקלדו באופן דינמי.

אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

ייצוג ב-JSON 
{
  "key": string,
  "value": value
}
שדות
key

string
value

value (Value format)

ערך

ייצוג ב-JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
שדות
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים:
nullValue

null

מייצג null ב-JSON.
numberValue

number

מייצג מספר ב-JSON. הערך לא יכול להיות NaN,‏ Infinity או -Infinity, כי אין להם תמיכה ב-JSON. הוא גם לא יכול לייצג ערכי Int64 גדולים, כי בדרך כלל פורמט JSON לא תומך בהם בסוג המספר שלו.
stringValue

string

מייצג מחרוזת JSON.
boolValue

boolean

מייצג ערך בוליאני של JSON (ליטרל true או false ב-JSON).
structValue

object (Struct format)

מייצג אובייקט JSON.
listValue

array (ListValue format)

מייצג מערך JSON.

ListValue

ייצוג ב-JSON 
{
  "values": [
    value
  ]
}
שדות
values[]

value (Value format)

שדה חוזר של ערכים שהוקלדו באופן דינמי.

NullValue

מייצג null ב-JSON.

‫NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.

שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יחזרו לערך 0.

טיפוסים בני מנייה (enum)
NULL_VALUE ערך Null.

הערות לגבי הכלים

הערות הכלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כלא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשה לאישור.

בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:

  • ‫readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true.
  • ‫idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false.
  • ‫openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.

רמז לפעולה הרסנית: ❌ | רמז לפעולה אידמפוטנטית: ✅ | רמז לפעולה לקריאה בלבד: ✅ | רמז לפעולה בעולם פתוח: ✅

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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