MCP Tools Reference: cloud-sql

工具：list_instances

列出项目中的所有 Cloud SQL 实例。

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

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

输入架构

实例列表请求。

SqlInstancesListRequest

JSON 表示法 
{
  "filter": string,
  "maxResults": integer,
  "pageToken": string,
  "project": string
}
字段
filter

string

用于过滤响应中列出的资源的过滤条件表达式。表达式的格式为：值。例如，'instanceType:CLOUD_SQL_INSTANCE'. 字段可以根据需要按照其 JSON 表示法进行嵌套，例如“settings.userLabels.auto_start：true”。

多个过滤条件查询用空格分隔。例如：'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. 默认情况下，每个表达式都是一个 AND 表达式。但是，您可以明确包含 AND 和 OR 表达式。
maxResults

integer (uint32 format)

要返回的实例数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 500 个实例。最大值为 1,000；大于 1,000 的值会被强制转换为 1,000。
pageToken

string

以前返回的页面令牌，表示要查看的较大结果集的一部分。
project

string

要列出 Cloud SQL 实例的项目的项目 ID。

输出架构

MCP 的实例列表响应。

SqlInstancesListMcpResponse

JSON 表示法 
{
  "kind": string,
  "warnings": [
    {
      object (ApiWarning)
    }
  ],
  "items": [
    {
      object (McpDatabaseInstance)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

始终为 sql#instancesList。
warnings[]

object (ApiWarning)

处理请求时出现的警告列表。
items[]

object (McpDatabaseInstance)

mcp 实例资源列表。
nextPageToken

string

用于对大型结果集进行分页的接续令牌。在后续请求中提供此值以返回下一页结果。

ApiWarning

JSON 表示法 
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
字段
code

enum (SqlApiWarningCode)

用于标识警告类型的唯一代码。
message

string

警告消息。
region

string

REGION_UNREACHABLE 警告的区域名称。

McpDatabaseInstance

JSON 表示法 
{
  "project": string,
  "name": string,
  "databaseVersion": string,
  "region": string,
  "edition": string,
  "tier": string,
  "dataDiskSizeGb": string,
  "availabilityType": string,
  "tags": {
    string: string,
    ...
  },
  "state": enum (SqlInstanceState)
}
字段
project

string

必需。要列出 Cloud SQL 实例的项目的项目 ID。
name

string

必需。Cloud SQL 实例的名称。不包括项目 ID。
databaseVersion

string
region

string

可选。Cloud SQL 实例的地理区域。例如，us-central1、europe-west1、asia-east1。
edition

string

可选。实例的版本，可以是 ENTERPRISE 或 ENTERPRISE_PLUS。
tier

string

可选。相应实例的层级（或机器类型）。
dataDiskSizeGb

string (Int64Value format)

可选。数据磁盘大小（以 GB 为单位）。默认值为 100。
availabilityType

string

可选。可用性类型。可能的值：* ZONAL：实例仅从一个地区传送数据。该地区的服务中断会影响数据可访问性。此设置为默认值。 * REGIONAL：实例可以从区域中的多个可用区传送数据（高可用性）。
tags

map (key: string, value: string)

可选。仅限输入。绑定到此实例的标记键和标记值。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
state

enum (SqlInstanceState)

仅限输出。Cloud SQL 实例的状态。

Int64Value

JSON 表示法 
{
  "value": string
}
字段
value

string (int64 format)

int64 值。

TagsEntry

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string
value

string

工具注释

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