MCP Tools Reference: sheetsmcp.googleapis.com

الأداة: get_spreadsheet

تعرض هذه الدالة محتوى جدول البيانات المحدّد. تعرض هذه الطريقة العناوين وأسماء أوراق البيانات وخصائص الشبكة والبيانات الوصفية الأخرى لمعرّف جدول البيانات المحدّد. تعرض أيضًا بيانات الشبكة الكاملة إذا طُلب ذلك. يتوافق مع spreadsheets.get في واجهة REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

يوضّح المثال التالي كيفية استخدام curl لاستدعاء أداة get_spreadsheet MCP.

طلب 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
}'

مخطط الإدخال

GetContentRequest

تمثيل JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean
}
الحقول
spreadsheetId

string

الحقل مطلوب. رقم تعريف جدول البيانات المطلوب
includeGridData

boolean

تكون القيمة "صحيح" إذا كان من المفترض عرض بيانات الشبكة.

مخطط النتائج

تمثّل هذه السمة عنصر JSON.

خريطة غير مرتبة للقيمة والمفتاح، تهدف إلى التقاط دلالات عنصر JSON بشكل مثالي. يتيح ذلك تحليل أي حمولة JSON عشوائية كحقل رسالة بتنسيق ProtoJSON.

يتّبع هذا النوع إرشادات RFC 8259 بشأن JSON القابل للتشغيل التفاعلي: لا يمكن لهذا النوع تمثيل قيم Int64 كبيرة أو أرقام NaN/Infinity، لأنّ تنسيق JSON لا يتيح بشكل عام هذه القيم في نوع الأرقام.

إذا كنت لا تنوي تحليل JSON عشوائي في رسالتك، يجب استخدام رسالة مكتوبة مخصّصة بدلاً من هذا النوع.

بنية

تمثيل 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 هو عنصر فاصل، ويستخدم تعدادًا بقيمة واحدة فقط لتمثيل القيمة الفارغة لاتحاد النوع Value.

يُعدّ الحقل من النوع NullValue غير صالح إذا كانت قيمته أي قيمة أخرى غير 0. ستُصدر معظم أدوات التسلسل ProtoJSON Value مع ضبط null_value كـ null JSON بغض النظر عن قيمة العدد الصحيح، وبالتالي ستُجري رحلة ذهاب وعودة إلى قيمة 0.

عمليات التعداد
NULL_VALUE قيمة فارغة

التعليقات التوضيحية للأدوات

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

نطاقات التفويض

يجب توفير أحد نطاقات 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