mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
01712284b4
## Description --- This change introduces a new tool, `cloudsqllistinstance`, to the `cloudsql` toolset. This tool allows users to list all Cloud SQL instances within a specified GCP project. The implementation includes: - The `cloudsqllistinstance` tool definition and logic, which makes an authenticated GET request to the `sqladmin.googleapis.com` API. - The tool takes a single required parameter: `project`. <img width="654" height="1406" alt="image" src="https://github.com/user-attachments/assets/7c129a54-acb7-4695-9a0b-215914a6a273" /> ## PR Checklist --- > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/langchain-google-alloydb-pg-python/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - tracked internally - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here>
1.7 KiB
1.7 KiB
title, type, weight, description
| title | type | weight | description |
|---|---|---|---|
| Cloud SQL List Instances | docs | 1 | List Cloud SQL instances in a project. |
The cloud-sql-list-instances tool lists all Cloud SQL instances in a specified
Google Cloud project.
{{< notice info >}}
This tool uses the cloud-sql-admin source, which automatically handles authentication on behalf of the user.
{{< /notice >}}
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:
| field | type | required | description |
|---|---|---|---|
| project | string | true | The Google Cloud project ID. |
Reference
| field | type | required | description |
|---|---|---|---|
| kind | string | true | Must be "cloud-sql-list-instances". |
| description | string | false | Description of the tool that is passed to the agent. |
| source | string | true | The name of the cloud-sql-admin source to use for this tool. |