Back to Genai Toolbox

cloud-sql-list-instances

docs/en/integrations/cloud-sql-admin/tools/cloudsqllistinstances.md

1.1.01.3 KB
Original Source

About

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

Compatible Sources

{{< compatible-sources >}}

Parameters

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

fieldtyperequireddescription
projectstringtrueThe Google Cloud project ID.

Example

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

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

Reference

fieldtyperequireddescription
typestringtrueMust 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.