MCP Tools Reference: cloud-sql

Herramienta: list_instances

Enumera todas las instancias de Cloud SQL en el proyecto.

En la siguiente muestra de código, se indica cómo usar curl para llamar a la herramienta de MCP list_instances.

Solicitud de 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
}'

Esquema de entrada

Es la solicitud de lista de instancias.

SqlInstancesListRequest

Representación JSON
{
  "filter": string,
  "maxResults": integer,
  "pageToken": string,
  "project": string,
  "location": string
}
Campos
filter

string

Es una expresión de filtro que filtra los recursos enumerados en la respuesta. La expresión tiene el formato campo:valor. Por ejemplo, "instanceType:CLOUD_SQL_INSTANCE". Los campos se pueden anidar según sea necesario, de acuerdo con su representación JSON, como "settings.userLabels.auto_start:true".

Las consultas de filtro múltiples se separan con espacios. Por ejemplo: 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. De forma predeterminada, cada expresión es una expresión AND. Sin embargo, puedes incluir expresiones AND y OR de forma explícita.

maxResults

integer (uint32 format)

Es la cantidad máxima de instancias que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devuelven, como máximo, 500 instancias. El valor máximo permitido es 1,000; cualquier cifra mayor a ese valor se limitará automáticamente a 1,000.

pageToken

string

Un token de página que se mostró antes y que representa parte del conjunto más grande de resultados para ver.

project

string

El ID del proyecto para el que se enumeran las instancias de Cloud SQL.

location

string

Es opcional. Es la región de la instancia de Cloud SQL.

Esquema de salida

Es la respuesta de la lista de instancias para MCP.

SqlInstancesListMcpResponse

Representación JSON
{
  "kind": string,
  "warnings": [
    {
      object (ApiWarning)
    }
  ],
  "items": [
    {
      object (McpDatabaseInstance)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

Siempre es sql#instancesList.

warnings[]

object (ApiWarning)

Es la lista de advertencias que se produjeron mientras se controlaba la solicitud.

items[]

object (McpDatabaseInstance)

Es la lista de recursos de instancias de mcp.

nextPageToken

string

Es el token de continuación, que se usa para desplazarse por grandes conjuntos de resultados. Proporciona este valor en una solicitud posterior para mostrar la página siguiente de resultados.

ApiWarning

Representación JSON
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
Campos
code

enum (SqlApiWarningCode)

Es el código para identificar de forma inequívoca el tipo de advertencia.

message

string

Es el mensaje de advertencia.

region

string

Es el nombre de la región para la advertencia REGION_UNREACHABLE.

McpDatabaseInstance

Representación JSON
{
  "project": string,
  "name": string,
  "databaseVersion": string,
  "region": string,
  "edition": string,
  "tier": string,
  "dataDiskSizeGb": string,
  "availabilityType": string,
  "tags": {
    string: string,
    ...
  },
  "state": enum (SqlInstanceState)
}
Campos
project

string

Obligatorio. El ID del proyecto para el que se enumeran las instancias de Cloud SQL.

name

string

Obligatorio. Es el nombre de la instancia de Cloud SQL. Esto no incluye el ID del proyecto.

databaseVersion

string

region

string

Es opcional. Es la región geográfica de la instancia de Cloud SQL. Por ejemplo, us-central1, europe-west1 y asia-east1.

edition

string

Es opcional. Es la edición de la instancia, que puede ser ENTERPRISE o ENTERPRISE_PLUS.

tier

string

Es opcional. Es el nivel (o tipo de máquina) de esta instancia.

dataDiskSizeGb

string (Int64Value format)

Es opcional. Es el tamaño del disco de datos en GB. El valor predeterminado es 100.

availabilityType

string

Es opcional. Es el tipo de disponibilidad. Valores posibles: * ZONAL: La instancia entrega datos de una sola zona. Las interrupciones en esa zona afectan la accesibilidad de los datos. Este es el valor predeterminado. * REGIONAL: La instancia puede entregar datos desde más de una zona en una región (tiene alta disponibilidad).

tags

map (key: string, value: string)

Es opcional. Solo entrada. Son las claves y los valores de las etiquetas que están vinculados a esta instancia.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (SqlInstanceState)

Solo salida. Es el estado de la instancia de Cloud SQL.

Int64Value

Representación JSON
{
  "value": string
}
Campos
value

string (int64 format)

Es el valor int64.

TagsEntry

Representación JSON
{
  "key": string,
  "value": string
}
Campos
key

string

value

string

SqlApiWarningCode

Enums
SQL_API_WARNING_CODE_UNSPECIFIED Un tipo de advertencia desconocido o no establecido de la API de Cloud SQL.
REGION_UNREACHABLE Advertencia cuando no se puede acceder a una o más regiones. Es posible que el conjunto de resultados que se devuelva esté incompleto.
MAX_RESULTS_EXCEEDS_LIMIT Advertencia cuando el parámetro maxResults proporcionado por el usuario supera el límite. Es posible que el conjunto de resultados que se devuelva esté incompleto.
COMPROMISED_CREDENTIALS Advertencia cuando el usuario intenta crear o actualizar un usuario con credenciales que se vieron comprometidas anteriormente por una violación de la seguridad de los datos públicos.
INTERNAL_STATE_FAILURE Advertencia cuando la operación se realiza correctamente, pero falla algún estado del flujo de trabajo no crítico.

SqlInstanceState

Es el estado de publicación actual de la instancia de la base de datos.

Enums
SQL_INSTANCE_STATE_UNSPECIFIED Se desconoce el estado de la instancia.
RUNNABLE La instancia se está ejecutando o el propietario la detuvo.
SUSPENDED La instancia no está disponible; por ejemplo, debido a problemas de facturación.
PENDING_DELETE Se borró la instancia.
PENDING_CREATE Se está creando la instancia.
MAINTENANCE La instancia no está disponible porque se encuentra en mantenimiento.
FAILED No se pudo crear la instancia o se produjo un error grave durante el mantenimiento.
ONLINE_MAINTENANCE Obsoleto
REPAIRING (Solo se aplica a los nodos de grupo de lectura). Se debe reparar el nodo del grupo de lectura. Es posible que la base de datos no esté disponible.

Anotaciones de herramientas

Las anotaciones de herramientas se envían a los clientes de MCP para describir el riesgo básico de una herramienta determinada. La mayoría de los clientes tratan estas sugerencias como no confiables, pero se pueden usar para decidir cuándo se puede enviar un mensaje de confirmación a un usuario.

Junto con la cadena de título, las siguientes sugerencias booleanas se definen de la siguiente manera:

  • readOnlyHint: Si es verdadero, la herramienta no modifica su entorno. Valor predeterminado: false.
  • destructiveHint: Si es verdadero, la herramienta puede realizar acciones destructivas. Si es falso, la herramienta solo puede realizar acciones aditivas. Valor predeterminado: true.
  • idempotentHint: Si es verdadero, llamar a la herramienta varias veces con los mismos argumentos no tendrá ningún efecto adicional en su entorno. Valor predeterminado: false.
  • openWorldHint: Si es verdadero, la herramienta puede interactuar con un "mundo abierto" de entidades externas. Si es falso, la herramienta solo puede interactuar con entidades internas. Por ejemplo, una herramienta de búsqueda web sería de mundo abierto, mientras que una herramienta de memoria no lo sería.

Sugerencia destructiva: ❌ | Sugerencia idempotente: ❌ | Sugerencia de solo lectura: ✅ | Sugerencia de mundo abierto: ❌