MCP Tools Reference: sheetsmcp.googleapis.com

Công cụ: get_spreadsheet

Trả về nội dung bảng tính cho bảng tính đã cho. Trả về tiêu đề, tên trang tính, thuộc tính lưới và siêu dữ liệu khác cho mã nhận dạng bảng tính đã cho. Cũng trả về dữ liệu lưới đầy đủ nếu được yêu cầu.

Tương ứng với spreadsheets.get trong API REST: https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets/get

<br>Giản đồ: – spreadsheet_id (chuỗi, bắt buộc): Mã của bảng tính cần yêu cầu. – include_grid_data (boolean, không bắt buộc): True nếu dữ liệu lưới cần được trả về. Giá trị mặc định là false. – fields (mảng chuỗi, không bắt buộc): Mặt nạ trường chỉ định thuộc tính nào cần trả về (ví dụ: ["sheets.properties.sheetId", "sheets.properties.title"]). – comments_included (boolean, không bắt buộc): Nếu đúng, các nhận xét sẽ được đưa vào phản hồi. Giá trị mặc định là false. – ranges (mảng chuỗi, không bắt buộc): Các dải ô A1 hoặc R1C1 cần truy xuất từ bảng tính. Nếu bạn không chỉ định, toàn bộ bảng tính sẽ được trả về.

Mã mẫu sau đây cho biết cách sử dụng curl để gọi công cụ MCP get_spreadsheet.

Yêu cầu 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
}'

Giản đồ đầu vào

GetContentRequest

Biểu diễn dưới dạng JSON 
{
  "spreadsheetId": string,
  "includeGridData": boolean,
  "fields": [
    string
  ],
  "ranges": [
    string
  ],

  "commentsIncluded": boolean
}
Trường
spreadsheetId

string

Bắt buộc. Mã nhận dạng của bảng tính cần yêu cầu.
includeGridData

boolean

True nếu dữ liệu lưới được trả về.
fields[]

string

Không bắt buộc. Mặt nạ trường để chỉ định thuộc tính nào sẽ trả về của API Bảng tính, hãy xem https://developers.google.com/workspace/sheets/api/guides/field-masks để biết thêm về cách sử dụng mặt nạ trường. QUAN TRỌNG: Sử dụng đường dẫn phân cấp dựa trên cấu trúc JSON phản hồi của API Trang tính. – Ví dụ: để lấy tiêu đề và mã nhận dạng trang tính, hãy sử dụng "sheets.properties.sheetId" và "sheets.properties.title" thay vì "title,sheetId". – Chỉ bao gồm các trường bạn cần. – Để lấy bảng, hãy sử dụng: "sheets.tables" hoặc "sheets.properties". – Để lấy tiêu đề và mã nhận dạng của trang tính, hãy sử dụng: "sheets.properties.sheetId" và "sheets.properties.title".
ranges[]

string

Không bắt buộc. Ký hiệu A1 hoặc ký hiệu R1C1 của các dải ô cần truy xuất từ bảng tính. Nếu không được chỉ định, toàn bộ bảng tính sẽ được trả về.

Trường nhóm _comments_included.

_comments_included chỉ có thể là một trong những trạng thái sau:
commentsIncluded

boolean

Không bắt buộc. Nếu đúng, các nhận xét sẽ được đưa vào phản hồi. Theo mặc định, nhận xét sẽ không được đưa vào.

Giản đồ đầu ra

GetContentResponse

Biểu diễn dưới dạng JSON 
{
  "content": {
    object
  }
}
Trường
content

object (Struct format)

Bảng tính, ở định dạng JSON của tài nguyên Spreadsheet của API Trang tính.

Cấu trúc

Biểu diễn dưới dạng JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Trường
fields

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

Bản đồ không theo thứ tự của các giá trị được nhập động.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Biểu diễn dưới dạng JSON 
{
  "key": string,
  "value": value
}
Trường
key

string
value

value (Value format)

Giá trị

Biểu diễn dưới dạng JSON 
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
Trường
Trường nhóm kind. Loại giá trị. kind chỉ có thể là một trong những trạng thái sau:
nullValue

null

Đại diện cho một null JSON.
numberValue

number

Biểu thị một số JSON. Không được là NaN, Infinity hoặc -Infinity vì JSON không hỗ trợ các giá trị này. Điều này cũng không thể biểu thị các giá trị Int64 lớn, vì định dạng JSON thường không hỗ trợ các giá trị này trong kiểu số.
stringValue

string

Biểu thị một chuỗi JSON.
boolValue

boolean

Biểu thị một boolean JSON (true hoặc false giá trị cố định trong JSON).
structValue

object (Struct format)

Đại diện cho một đối tượng JSON.
listValue

array (ListValue format)

Biểu thị một mảng JSON.

ListValue

Biểu diễn dưới dạng JSON 
{
  "values": [
    value
  ]
}
Trường
values[]

value (Value format)

Trường lặp lại của các giá trị được nhập động.

NullValue

Đại diện cho một null JSON.

NullValue là một sentinel, sử dụng enum chỉ có một giá trị để biểu thị giá trị rỗng cho hợp kiểu Value.

Trường thuộc loại NullValue có giá trị khác với 0 được coi là không hợp lệ. Hầu hết các trình chuyển đổi tuần tự ProtoJSON sẽ phát ra một Value có null_value được đặt làm JSON null bất kể giá trị số nguyên, và do đó sẽ khứ hồi thành giá trị 0.

Enum
NULL_VALUE Giá trị rỗng.

Chú thích về công cụ

Chú thích về công cụ được gửi đến ứng dụng MCP để mô tả rủi ro cơ bản của một công cụ nhất định. Hầu hết ứng dụng đều coi những gợi ý này là không đáng tin cậy, nhưng có thể dùng chúng để quyết định thời điểm gửi lời nhắc xác nhận cho người dùng.

Cùng với chuỗi tiêu đề, các gợi ý boolean sau đây được xác định như sau:

  • readOnlyHint: Nếu đúng, công cụ sẽ không sửa đổi môi trường của nó. Mặc định: false.
  • destructiveHint: Nếu đúng, thì công cụ có thể thực hiện các hành động có tính huỷ diệt. Nếu là false, thì công cụ chỉ có thể thực hiện các hành động bổ sung. Mặc định: true.
  • idempotentHint: Nếu đúng, thì việc gọi công cụ nhiều lần với cùng một đối số sẽ không có thêm hiệu ứng nào đối với môi trường của công cụ. Mặc định: false.
  • openWorldHint: Nếu đúng, thì công cụ có thể tương tác với "thế giới mở" của các thực thể bên ngoài. Nếu là false, thì công cụ chỉ có thể tương tác với các thực thể nội bộ. Ví dụ: công cụ tìm kiếm trên web sẽ là công cụ thế giới mở, còn công cụ ghi nhớ sẽ không phải là công cụ thế giới mở.

Gợi ý về hành động huỷ diệt: ❌ | Gợi ý về hành động luỹ đẳng: ✅ | Gợi ý về hành động chỉ đọc: ✅ | Gợi ý về hành động trong thế giới mở: ✅

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • 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