genai-toolbox/docs/en/resources/tools/cloudsql/cloudsqlgetinstances.md at 7d384dc28f8c37dddc2f6cefc0bbeb4c201e3167

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-13 08:35:15 -05:00

Files

prernakakkar-google 77919c7d8e feat(prebuilt/cloudsql): Add cloud-sql-get-instances tool (#1383 )

## Description

---
This pull request introduces the `cloud-sql-get-instances` tool, which
enables users to retrieve detailed information about a specified Cloud
SQL instance. This tool enhances the toolbox by providing a direct and
authenticated way to interact with the Google Cloud SQL Admin API.
Authentication is handled automatically by generating a bearer token
from the environment's Application Default Credentials with the
`https://www.googleapis.com/auth/sqlservice.admin` scope.


<img width="282" height="1064" alt="image"
src="https://github.com/user-attachments/assets/253d3939-7de2-4324-bc2b-8a2eb20eb133"
/>



####


## 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/genai-toolbox/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>

2025-09-12 15:02:57 +00:00

1.4 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
cloud-sql-get-instance	docs	10	Get a Cloud SQL instance resource.

The cloud-sql-get-instance tool retrieves a Cloud SQL instance resource using the Cloud SQL Admin API.

{{< notice info >}} This tool uses a source of kind cloud-sql-admin. The source automatically generates a bearer token on behalf of the user with the https://www.googleapis.com/auth/sqlservice.admin scope to authenticate requests. {{< /notice >}}

Example

tools:
  get-sql-instance:
    kind: cloud-sql-get-instance
    description: "Get a Cloud SQL instance resource."
    source: my-cloud-sql-source

Reference

field	type	required	description
kind	string	true	Must be "cloud-sql-get-instance".
description	string	true	A description of the tool.
source	string	true	The name of the `cloud-sql-admin` source to use.

1.4 KiB Raw Blame History

Example

Reference

1.4 KiB

Raw Blame History