MCP Tools Reference: sheetsmcp.googleapis.com

เครื่องมือ: get_spreadsheet

แสดงผลเนื้อหาสเปรดชีตสำหรับสเปรดชีตที่ระบุ แสดงผลชื่อ ชื่อชีต พร็อพเพอร์ตี้ตารางกริด และข้อมูลเมตาอื่นๆ สำหรับรหัสสเปรดชีตที่ระบุ นอกจากนี้ยังแสดงข้อมูลตารางกริดแบบเต็มหากมีการขอด้วย

สอดคล้องกับ spreadsheets.get ใน REST API: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

สคีมา: - spreadsheet_id (สตริง, ต้องระบุ): รหัสของสเปรดชีตที่จะขอ - include_grid_data (บูลีน, ไม่บังคับ): True หากควรแสดงผลข้อมูลตารางกริด ค่าเริ่มต้นคือ "เท็จ" - fields (อาร์เรย์ของสตริง, ไม่บังคับ): มาสก์ฟิลด์ที่ระบุพร็อพเพอร์ตี้ที่จะแสดงผล (เช่น ["sheets.properties.sheetId", "sheets.properties.title"]) - comments_included (บูลีน, ไม่บังคับ): หากเป็นจริง ความคิดเห็นจะรวมอยู่ในการตอบกลับ ค่าเริ่มต้นคือ "เท็จ" - 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 ของช่วงที่จะดึงข้อมูลจากสเปรดชีต หากไม่ระบุ ระบบจะแสดงผลสเปรดชีตทั้งหมด

ฟิลด์ Union _comments_included

_comments_included ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
commentsIncluded

boolean

ไม่บังคับ หากเป็น "จริง" ระบบจะรวมความคิดเห็นไว้ในการตอบกลับ โดยค่าเริ่มต้น ระบบจะไม่รวมความคิดเห็น

สคีมาเอาต์พุต

GetContentResponse

การแสดง JSON 
{
  "content": {
    object
  }
}
ช่อง
content

object (Struct format)

สเปรดชีตในรูปแบบ JSON ของทรัพยากร Spreadsheet ของ Sheets API

โครงสร้าง

การแสดง 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
}
ช่อง
ฟิลด์ Union 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 ไม่ถูกต้อง โปรแกรมจัดลำดับ ProtoJSON ส่วนใหญ่จะส่ง Value ที่มี null_value ตั้งค่าเป็น JSON null โดยไม่คำนึงถึงค่าจำนวนเต็ม และจะไป-กลับเป็นค่า 0

Enum
NULL_VALUE ค่า Null

คำอธิบายประกอบเครื่องมือ

ระบบจะส่งคำอธิบายประกอบเครื่องมือไปยังไคลเอ็นต์ MCP เพื่ออธิบายความเสี่ยงพื้นฐานของเครื่องมือหนึ่งๆ ไคลเอ็นต์ส่วนใหญ่จะถือว่าคำแนะนำเหล่านี้ไม่น่าเชื่อถือ แต่สามารถใช้เพื่อตัดสินใจว่าจะส่งข้อความแจ้งยืนยันไปยังผู้ใช้เมื่อใด

นอกจากสตริงชื่อแล้ว ยังมีการกำหนดคำแนะนำบูลีนต่อไปนี้ด้วย

  • readOnlyHint: หากเป็นจริง เครื่องมือจะไม่แก้ไขสภาพแวดล้อมของตนเอง ค่าเริ่มต้น: false
  • destructiveHint: หากเป็น "จริง" เครื่องมือจะดำเนินการที่ทำลายล้างได้ หากเป็นเท็จ เครื่องมือจะดำเนินการได้เฉพาะการดำเนินการแบบเพิ่มเท่านั้น ค่าเริ่มต้น: true
  • idempotentHint: หากเป็นจริง การเรียกใช้เครื่องมือซ้ำๆ ด้วยอาร์กิวเมนต์เดียวกันจะไม่มีผลเพิ่มเติมต่อสภาพแวดล้อม ค่าเริ่มต้น: false
  • openWorldHint: หากเป็นจริง เครื่องมือจะโต้ตอบกับ "โอเพนเวิลด์" ของเอนทิตีภายนอกได้ หากเป็นเท็จ เครื่องมือจะโต้ตอบได้เฉพาะกับเอนทิตีภายในเท่านั้น ตัวอย่างเช่น เครื่องมือค้นเว็บจะเป็นแบบโอเพนเวิลด์ ส่วนเครื่องมือความทรงจำจะไม่ใช่แบบโอเพนเวิลด์

คำแนะนำเกี่ยวกับ Destructive: ❌ | คำแนะนำเกี่ยวกับ Idempotent: ✅ | คำแนะนำเกี่ยวกับ Read Only: ✅ | คำแนะนำเกี่ยวกับ โอเพนเวิลด์: ✅

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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