工具: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 MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
输入架构
实例列表请求。
SqlInstancesListRequest
| JSON 表示法 |
|---|
{ "filter": string, "maxResults": integer, "pageToken": string, "project": string, "location": string } |
| 字段 | |
|---|---|
filter |
用于过滤响应中列出的资源的过滤表达式。表达式的格式为:值。例如,'instanceType:CLOUD_SQL_INSTANCE'. 字段可以根据需要按照其 JSON 表示法进行嵌套,例如“settings.userLabels.auto_start:true”。 多个过滤条件查询用空格分隔。例如:'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. 默认情况下,每个表达式都是一个 AND 表达式。但是,您可以明确包含 AND 和 OR 表达式。 |
maxResults |
要返回的实例数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 500 个实例。最大值为 1000;如果值大于 1000,则强制转换为 1000。 |
pageToken |
以前返回的页面令牌,表示要查看的较大结果集的一部分。 |
project |
要列出 Cloud SQL 实例的项目的项目 ID。 |
location |
可选。Cloud SQL 实例的区域。 |
输出架构
MCP 的实例列表响应。
SqlInstancesListMcpResponse
| JSON 表示法 |
|---|
{ "kind": string, "warnings": [ { object ( |
| 字段 | |
|---|---|
kind |
始终为 sql#instancesList。 |
warnings[] |
处理请求时发生的警告列表。 |
items[] |
MCP 实例资源列表。 |
nextPageToken |
用于对大型结果集进行分页的接续令牌。在后续请求中提供此值以返回下一页结果。 |
ApiWarning
| JSON 表示法 |
|---|
{
"code": enum ( |
| 字段 | |
|---|---|
code |
用于标识警告类型的唯一代码。 |
message |
警告消息。 |
region |
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 ( |
| 字段 | |
|---|---|
project |
必需。要列出 Cloud SQL 实例的项目的项目 ID。 |
name |
必需。Cloud SQL 实例的名称。不包括项目 ID。 |
databaseVersion |
|
region |
可选。Cloud SQL 实例的地理区域。例如, |
edition |
可选。实例的版本,可以是 ENTERPRISE 或 ENTERPRISE_PLUS。 |
tier |
可选。此实例的层级(或机器类型)。 |
dataDiskSizeGb |
可选。数据磁盘大小(以 GB 为单位)。默认值为 100。 |
availabilityType |
可选。可用性类型。可能的值:* |
tags |
可选。仅限输入。绑定到此实例的标记键和标记值。 包含一系列 |
state |
仅限输出。Cloud SQL 实例的状态。 |
Int64Value
| JSON 表示法 |
|---|
{ "value": string } |
| 字段 | |
|---|---|
value |
int64 值。 |
TagsEntry
| JSON 表示法 |
|---|
{ "key": string, "value": string } |
| 字段 | |
|---|---|
key |
|
value |
|
SqlApiWarningCode
| 枚举 | |
|---|---|
SQL_API_WARNING_CODE_UNSPECIFIED |
来自 Cloud SQL API 的未知或未设置警告类型。 |
REGION_UNREACHABLE |
一个或多个区域无法访问时发出警告。返回的结果集可能不完整。 |
MAX_RESULTS_EXCEEDS_LIMIT |
当用户提供的 maxResults 参数超出限制时发出警告。返回的结果集可能不完整。 |
COMPROMISED_CREDENTIALS |
当用户尝试使用之前因公开数据泄露而泄露的凭据创建/更新用户时发出警告。 |
INTERNAL_STATE_FAILURE |
当操作成功但某些非关键工作流状态失败时发出警告。 |
SqlInstanceState
数据库实例的当前服务状态。
| 枚举 | |
|---|---|
SQL_INSTANCE_STATE_UNSPECIFIED |
实例的状态未知。 |
RUNNABLE |
实例正在运行,或已被所有者停止。 |
SUSPENDED |
由于结算存在问题等原因,此实例不可用。 |
PENDING_DELETE |
正在删除此实例。 |
PENDING_CREATE |
正在创建此实例。 |
MAINTENANCE |
此实例因维护而关停。 |
FAILED |
实例创建失败,或者维护过程中发生严重错误。 |
ONLINE_MAINTENANCE |
已弃用 |
REPAIRING |
(仅适用于读取池节点。)读取池节点需要修复。数据库可能不可用。 |
工具注释
工具注释会发送给 MCP 客户端,用于描述给定工具的基本风险。大多数客户端会将这些提示视为不受信任,但它们可用于确定何时向用户发送确认提示。
除了标题字符串之外,以下布尔值提示的定义如下:
readOnlyHint:如果为 true,则该工具不会修改其环境。默认值:false。destructiveHint:如果为 true,则该工具可以执行破坏性操作。如果为 false,则该工具只能执行添加性操作。默认值:true。idempotentHint:如果为 true,则使用相同的参数重复调用该工具不会对其环境产生额外影响。默认值:false。openWorldHint:如果为 true,则该工具可以与外部实体的“开放世界”进行交互。如果为 false,则该工具只能与内部实体进行交互。例如,网页搜索工具属于开放世界,而记忆功能则不属于开放世界。
破坏性提示:❌ | 等幂性提示:❌ | 只读提示:✅ | 开放世界提示:❌