alloydb-list-clusters

The “alloydb-list-clusters” tool lists the AlloyDB clusters in a given project and location.

About

The alloydb-list-clusters tool retrieves AlloyDB cluster information for all or specified locations in a given project. It is compatible with alloydb-admin source.

alloydb-list-clusters tool lists the detailed information of AlloyDB cluster(cluster name, state, configuration, etc) for a given project and location. The tool takes the following input parameters:

ParameterTypeDescriptionRequired
projectstringThe GCP project ID to list clusters for.Yes
locationstringThe location to list clusters in (e.g., ‘us-central1’). Use - for all locations. Default: -.No

Example

tools:
  list_clusters:
    kind: alloydb-list-clusters
    source: alloydb-admin-source
    description: Use this tool to list all AlloyDB clusters in a given project and location.

Reference

fieldtyperequireddescription
kindstringtrueMust be alloydb-list-clusters.
sourcestringtrueThe name of an alloydb-admin source.
descriptionstringfalseDescription of the tool that is passed to the agent.
Last modified September 18, 2025: docs: fix docs linting (#1520) (3d8a041782)