Tools on MCP Toolbox for Databases

alloydb-create-cluster

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-create-cluster tool creates a new AlloyDB for PostgreSQL cluster in a specified project and location.

This tool provisions a cluster with a private IP address within the specified VPC network.

Permissions & APIs Required: Before using, ensure the following on your GCP project:

The AlloyDB API is enabled.
The user or service account executing the tool has one of the following IAM roles:
- roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
- roles/owner (the Owner basic IAM role)
- roles/editor (the Editor basic IAM role)

The tool takes the following input parameters:

alloydb-create-instance

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-create-instance tool creates a new AlloyDB instance (PRIMARY or READ_POOL) within a specified cluster. This tool provisions a new instance with a public IP address.

Permissions & APIs Required: Before using, ensure the following on your GCP project:

The AlloyDB API is enabled.
The user or service account executing the tool has one of the following IAM roles:
- roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
- roles/owner (the Owner basic IAM role)
- roles/editor (the Editor basic IAM role)

The tool takes the following input parameters:

alloydb-get-cluster

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-get-cluster tool retrieves detailed information for a single, specified AlloyDB cluster.

Parameter	Type	Description	Required
`project`	string	The GCP project ID to get cluster for.	Yes
`location`	string	The location of the cluster (e.g., ‘us-central1’).	Yes
`cluster`	string	The ID of the cluster to retrieve.	Yes

Compatible Sources

This tool can be used with the following database sources:

Source Name
AlloyDB Admin

Example

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

Reference

field	type	required	description
type	string	true	Must be alloydb-get-cluster.
source	string	true	The name of an `alloydb-admin` source.
description	string	false	Description of the tool that is passed to the agent.

alloydb-get-instance

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-get-instance tool retrieves detailed information for a single, specified AlloyDB instance.

Parameter	Type	Description	Required
`project`	string	The GCP project ID to get instance for.	Yes
`location`	string	The location of the instance (e.g., ‘us-central1’).	Yes
`cluster`	string	The ID of the cluster.	Yes
`instance`	string	The ID of the instance to retrieve.	Yes

Compatible Sources

This tool can be used with the following database sources:

Source Name
AlloyDB Admin

Example

kind: tool
name: get_specific_instance
type: alloydb-get-instance
source: my-alloydb-admin-source
description: Use this tool to retrieve details for a specific AlloyDB instance.

Reference

field	type	required	description
type	string	true	Must be alloydb-get-instance.
source	string	true	The name of an `alloydb-admin` source.
description	string	false	Description of the tool that is passed to the agent.

alloydb-get-user

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-get-user tool retrieves detailed information for a single, specified AlloyDB user.

Parameter	Type	Description	Required
`project`	string	The GCP project ID to get user for.	Yes
`location`	string	The location of the cluster (e.g., ‘us-central1’).	Yes
`cluster`	string	The ID of the cluster to retrieve the user from.	Yes
`user`	string	The ID of the user to retrieve.	Yes

Compatible Sources

This tool can be used with the following database sources:

alloydb-list-clusters

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-list-clusters tool retrieves AlloyDB cluster information for all or specified locations in a given project.

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:

Parameter	Type	Description	Required
`project`	string	The GCP project ID to list clusters for.	Yes
`location`	string	The location to list clusters in (e.g., ‘us-central1’). Use `-` for all locations. Default: `-`.	No

Compatible Sources

This tool can be used with the following database sources:

alloydb-list-instances

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-list-instances tool retrieves AlloyDB instance information for all or specified clusters and locations in a given project.

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

Parameter	Type	Description	Required
`project`	string	The GCP project ID to list instances for.	Yes
`cluster`	string	The ID of the cluster to list instances from. Use ‘-’ to get results for all clusters. Default: `-`.	No
`location`	string	The location of the cluster (e.g., ‘us-central1’). Use ‘-’ to get results for all locations. Default: `-`.	No

Compatible Sources

This tool can be used with the following database sources:

alloydb-list-users

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-list-users tool lists all database users within an AlloyDB cluster.

The tool takes the following input parameters:

Parameter	Type	Description	Required
`project`	string	The GCP project ID to list users for.	Yes
`cluster`	string	The ID of the cluster to list users from.	Yes
`location`	string	The location of the cluster (e.g., ‘us-central1’).	Yes

Compatible Sources

This tool can be used with the following database sources:

Source Name
AlloyDB Admin

Example

kind: tool
name: list_users
type: alloydb-list-users
source: alloydb-admin-source
description: Use this tool to list all database users within an AlloyDB cluster

Reference

field	type	required	description
type	string	true	Must be alloydb-list-users.
source	string	true	The name of an `alloydb-admin` source.
description	string	false	Description of the tool that is passed to the agent.

alloydb-create-user

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-create-user tool creates a new database user (ALLOYDB_BUILT_IN or ALLOYDB_IAM_USER) within a specified cluster.

Permissions & APIs Required: Before using, ensure the following on your GCP project:

The AlloyDB API is enabled.
The user or service account executing the tool has one of the following IAM roles:
- roles/alloydb.admin (the AlloyDB Admin predefined IAM role)
- roles/owner (the Owner basic IAM role)
- roles/editor (the Editor basic IAM role)

The tool takes the following input parameters:

alloydb-wait-for-operation

Mon, 01 Jan 0001 00:00:00 +0000

About

The alloydb-wait-for-operation tool is a utility tool that waits for a long-running AlloyDB operation to complete. It does this by polling the AlloyDB Admin API operation status endpoint until the operation is finished, using exponential backoff.

Parameter	Type	Description	Required
`project`	string	The GCP project ID.	Yes
`location`	string	The location of the operation (e.g., ‘us-central1’).	Yes
`operation`	string	The ID of the operation to wait for.	Yes

Info