genai-toolbox/docs/en/resources/tools/cloudsql/cloudsqllistdatabases.md at 5cbbf23b70f1321abfcbb0498cf1f5632db5ddca

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-03 19:55:31 -05:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

1.6 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
cloud-sql-list-databases	docs	1	List Cloud SQL databases in an instance.

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

{{< notice info >}} This tool uses the cloud-sql-admin source. {{< /notice >}}

Configuration

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

kind: sources
name: my-cloud-sql-admin-source
type: cloud-sql-admin
---
kind: tools
name: list_my_databases
type: cloud-sql-list-databases
source: my-cloud-sql-admin-source
description: Use this tool to list all Cloud SQL databases in an instance.

Parameters

The cloud-sql-list-databases tool has two required parameters:

field	type	required	description
project	string	true	The Google Cloud project ID.
instance	string	true	The Cloud SQL instance ID.

Reference

field	type	required	description
type	string	true	Must be "cloud-sql-list-databases".
source	string	true	The name of the `cloud-sql-admin` source to use for this tool.
description	string	false	Description of the tool that is passed to the agent.

1.6 KiB Raw Blame History

Configuration

Parameters

Reference

1.6 KiB

Raw Blame History