MCP Tools Reference: vectorsearch.googleapis.com

工具:aggregate_data_objects

汇总集合中的数据对象(例如计数)。

以下代码示例展示了如何使用 curl 调用 aggregate_data_objects MCP 工具。

Curl 请求
curl --location 'https://vectorsearch.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "aggregate_data_objects",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

输入架构

DataObjectSearchService.AggregateDataObjects 的请求消息。

AggregateDataObjectsRequest

JSON 表示法
{
  "parent": string,
  "filter": {
    object
  },
  "aggregate": enum (AggregationMethod)
}
字段
parent

string

必需。要查询的集合的资源名称。格式:projects/{project}/locations/{location}/collections/{collection}

filter

object (Struct format)

可选。JSON 过滤表达式,例如 {"genre": {"$eq": "sci-fi"}},表示为 google.protobuf.Struct。

空过滤条件 ({}) 会匹配所有数据对象。否则,过滤条件中的每个 JSON 对象都必须恰好有一个键:映射到一个运算符 ({"price": {"$lt": 100}}) 的字段名称,或逻辑运算符:$and 或 $or(带有过滤条件列表),或 $not(带有一个过滤条件)。字段运算符及其值:$eq 和 $ne 接受字符串、数字或布尔值;$lt、$lte、$gt 和 $gte 接受数字;$in、$nin 和 $all 接受字符串列表;$exists 接受布尔值。一个对象中的多个键(隐式 AND)和隐式等式 ({"genre": "sci-fi"}) 会被拒绝;请改用 $and 和 $eq。

逻辑运算符最多可以嵌套 2 层,例如 {"$and": [{"$or": [{"a": {"$eq": 1}}, {"b": {"$eq": 2}}]}]}。更深层的过滤条件会被拒绝,并显示 INVALID_ARGUMENT。

aggregate

enum (AggregationMethod)

必需。要应用于查询的聚合方法。

结构体

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 表示法
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
字段
联合字段 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 数组。

ListValue

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

value (Value format)

动态类型值的重复字段。

NullValue

表示 JSON null。

NullValue 是一个哨兵,使用仅有一个值的枚举来表示 Value 类型联合的 null 值。

如果 NullValue 类型的字段具有 0 以外的任何值,则会被视为无效。大多数 ProtoJSON 序列化器都会发出一个 Value,其中 null_value 设置为 JSON null,而不管整数值如何,因此会往返于 0 值。

枚举
NULL_VALUE Null 值。

AggregationMethod

汇总方法。

枚举
AGGREGATION_METHOD_UNSPECIFIED 不应使用。
COUNT 统计与过滤条件匹配的数据对象数量。

输出架构

DataObjectSearchService.AggregateDataObjects 的响应消息。

AggregateDataObjectsResponse

JSON 表示法
{
  "aggregateResults": [
    {
      object
    }
  ]
}
字段
aggregateResults[]

object (Struct format)

仅限输出。查询的汇总结果。

结构体

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 表示法
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
字段
联合字段 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 数组。

ListValue

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

value (Value format)

动态类型值的重复字段。

NullValue

表示 JSON null。

NullValue 是一个哨兵,使用仅有一个值的枚举来表示 Value 类型联合的 null 值。

如果 NullValue 类型的字段具有 0 以外的任何值,则会被视为无效。大多数 ProtoJSON 序列化器都会发出一个 Value,其中 null_value 设置为 JSON null,而不管整数值如何,因此会往返于 0 值。

枚举
NULL_VALUE Null 值。

工具注释

工具注解会发送到 MCP 客户端,用于描述给定工具的基本风险。大多数客户端会将这些提示视为不可信,但它们可用于决定何时向用户发送确认提示。

除了标题字符串之外,还定义了以下布尔值提示:

  • readOnlyHint:如果为 true,则该工具不会修改其环境。默认值:false。
  • destructiveHint:如果为 true,则该工具可以执行破坏性操作。如果为 false,则该工具只能执行添加操作。默认值:true。
  • idempotentHint:如果为 true,则使用相同参数重复调用该工具不会对其环境产生额外影响。默认值:false。
  • openWorldHint:如果为 true,则该工具可以与外部实体的“开放世界”进行交互。如果为 false,则该工具只能与内部实体交互。例如,网页搜索工具是开放世界,而记忆工具不是开放世界。

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