MCP Tools Reference: sheetsmcp.googleapis.com

工具:get_values

返回电子表格中的某个值范围。对应于 REST API 中的 spreadsheets.values.get:https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values/get

以下示例演示了如何使用 curl 调用 get_values MCP 工具。

Curl 请求
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_values",
    "arguments": {
      // provide these details according to the tool MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

输入架构

GetValuesRequest

JSON 表示法
{
  "spreadsheetId": string,
  "range": string
}
字段
spreadsheetId

string

必需。要从中检索数据的电子表格的 ID。

range

string

必需。要从中检索值的范围的 A1 表示法或 R1C1 表示法

输出架构

电子表格中某个范围内的数据。https://developers.google.com/workspace/sheets/api/reference/rest/v4/spreadsheets.values

ValueRange

JSON 表示法
{
  "range": string,
  "values": [
    array
  ]
}
字段
range

string

值的覆盖范围,采用 A1 表示法

values[]

array (ListValue format)

读取的数据。这是一个由数组组成的数组,外部数组表示所有数据,每个内部数组表示一行数据。内部数组中的每个项都对应一个单元格。系统不会包含尾随的空行和空列。

ListValue

JSON 表示法
{
  "values": [
    value
  ]
}
字段
values[]

value (Value format)

动态类型值的重复字段。

JSON 表示法
{

  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
}
字段
联合字段 kind。值的类型。kind 只能是下列其中一项:
nullValue

null

表示 JSON null

numberValue

number

表示 JSON 数字。不得为 NaNInfinity-Infinity,因为 JSON 不支持这些值。此类型也无法表示较大的 Int64 值,因为 JSON 格式通常不支持在其数字类型中使用这些值。

stringValue

string

表示 JSON 字符串。

boolValue

boolean

表示 JSON 布尔值(JSON 中的 truefalse 字面量)。

structValue

object (Struct format)

表示 JSON 对象。

listValue

array (ListValue format)

表示 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)

NullValue

表示 JSON null

NullValue 是一个标记,使用仅包含一个值的枚举来表示 Value 类型联合的 null 值。

如果类型为 NullValue 的字段的值不是 0,则视为无效。大多数 ProtoJSON 序列化程序都会发出一个 Value,并将 null_value 设置为 JSON null,无论整数值是多少,因此都会往返于 0 值。

枚举
NULL_VALUE Null 值。

工具注释

破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:✅