alloydb-get-cluster

The “alloydb-get-cluster” tool retrieves details for a specific AlloyDB cluster.

About

The alloydb-get-cluster tool retrieves detailed information for a single, specified AlloyDB cluster. It is compatible with alloydb-admin source.

ParameterTypeDescriptionRequired
projectstringThe GCP project ID to get cluster for.Yes
locationstringThe location of the cluster (e.g., ‘us-central1’).Yes
clusterstringThe ID of the cluster to retrieve.Yes

Example

tools:
  get_specific_cluster:
    kind: alloydb-get-cluster
    source: my-alloydb-admin-source
    description: Use this tool to retrieve details for a specific AlloyDB cluster.

Reference

fieldtyperequireddescription
kindstringtrueMust be alloydb-get-cluster.
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)