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 --location 'https://sheetsmcp.googleapis.com/mcp' \
--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
}'
                

طرحواره ورودی

درخواست دریافت محتوا

نمایش 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" } .

فیلدهاورود

نمایش JSON
{
  "key": string,
  "value": value
}
فیلدها
key

string

value

value ( Value format)

ارزش

نمایش JSON
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
فیلدها
فیلد Union kind . نوع مقدار. kind فقط می‌تواند یکی از موارد زیر باشد:
nullValue

null

نشان دهنده یک JSON null .

numberValue

number

نشان دهنده یک عدد JSON است. نباید NaN ، Infinity یا -Infinity باشد، زیرا این موارد در JSON پشتیبانی نمی‌شوند. این همچنین نمی‌تواند مقادیر بزرگ Int64 را نشان دهد، زیرا فرمت JSON معمولاً از آنها در نوع عدد خود پشتیبانی نمی‌کند.

stringValue

string

نشان دهنده یک رشته JSON است.

boolValue

boolean

نشان دهنده یک مقدار بولی JSON (در JSON، مقدار حقیقی یا مجازی true یا false ) است.

structValue

object ( Struct format)

نشان دهنده یک شیء JSON است.

listValue

array ( ListValue format)

نشان دهنده یک آرایه JSON است.

مقدار لیست

نمایش JSON
{
  "values": [
    value
  ]
}
فیلدها
values[]

value ( Value format)

فیلد تکراری با مقادیر تایپ‌شده‌ی پویا.

مقدار تهی

نشان دهنده یک JSON null .

NullValue یک نگهبان است که از یک enum با تنها یک مقدار برای نمایش مقدار null برای نوع Value استفاده می‌کند.

فیلدی از نوع NullValue با هر مقداری غیر از 0 نامعتبر در نظر گرفته می‌شود. اکثر سریالایزرهای ProtoJSON صرف نظر از مقدار صحیح، Value با null_value که به عنوان JSON null تنظیم شده است، منتشر می‌کنند و بنابراین به صورت رفت و برگشتی به مقدار 0 می‌رسند.

انوم‌ها
NULL_VALUE مقدار تهی.

حاشیه‌نویسی ابزار

راهنمایی مخرب: ❌ | راهنمایی بی‌اثر: ✅ | راهنمایی فقط خواندنی: ✅ | راهنمایی جهان باز: ✅