Cloud SQL List Instances

List Cloud SQL instances in a project.

The cloud-sql-list-instances tool lists all Cloud SQL instances in a specified Google Cloud project.

Info

This tool uses the cloud-sql-admin source, which automatically handles authentication on behalf of the user.

Configuration

Here is an example of how to configure the cloud-sql-list-instances tool in your tools.yaml file:

sources:
  my-cloud-sql-admin-source:
    kind: cloud-sql-admin

tools:
  list_my_instances:
    kind: cloud-sql-list-instances
    source: my-cloud-sql-admin-source
    description: Use this tool to list all Cloud SQL instances in a project.

Parameters

The cloud-sql-list-instances tool has one required parameter:

fieldtyperequireddescription
projectstringtrueThe Google Cloud project ID.

Reference

fieldtyperequireddescription
kindstringtrueMust be “cloud-sql-list-instances”.
descriptionstringfalseDescription of the tool that is passed to the agent.
sourcestringtrueThe name of the cloud-sql-admin source to use for this tool.