Tools on MCP Toolbox for Databases

cloud-sql-list-databases

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

About

The cloud-sql-list-databases tool lists all Cloud SQL databases in a specified Google Cloud project and instance.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

The cloud-sql-list-databases tool has two required parameters:

field	type	required	description
project	string	true	The Google Cloud project ID.
instance	string	true	The Cloud SQL instance ID.

Example

Here is an example of how to configure the cloud-sql-list-databases tool in your tools.yaml file:

cloud-sql-list-instances

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

About

The cloud-sql-list-instances tool lists all Cloud SQL instances in a specified Google Cloud project.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

The cloud-sql-list-instances tool has one required parameter:

field	type	required	description
project	string	true	The Google Cloud project ID.

Example

Here is an example of how to configure the cloud-sql-list-instances tool in your tools.yaml file:

kind: source
name: my-cloud-sql-admin-source
type: cloud-sql-admin
---
kind: tool
name: list_my_instances
type: cloud-sql-list-instances
source: my-cloud-sql-admin-source
description: Use this tool to list all Cloud SQL instances in a project.

Reference

field	type	required	description
type	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.

cloud-sql-mysql-create-instance

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

About

The cloud-sql-mysql-create-instance tool creates a new Cloud SQL for MySQL instance in a specified Google Cloud project.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

The cloud-sql-mysql-create-instance tool has the following parameters:

field	type	required	description
project	string	true	The Google Cloud project ID.
name	string	true	The name of the instance to create.
databaseVersion	string	false	The database version for MySQL. If not specified, defaults to the latest available version (e.g., `MYSQL_8_4`).
rootPassword	string	true	The root password for the instance.
editionPreset	string	false	The edition of the instance. Can be `Production` or `Development`. Defaults to `Development`.

Example

Here is an example of how to configure the cloud-sql-mysql-create-instance tool in your tools.yaml file:

cloud-sql-clone-instance

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

About

The cloud-sql-clone-instance tool clones a Cloud SQL instance using the Cloud SQL Admin API.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

Basic clone (current state)

kind: tool
name: clone-instance-basic
type: cloud-sql-clone-instance
source: cloud-sql-admin-source
description: "Creates an exact copy of a Cloud SQL instance. Supports configuring instance zones and high-availability setup through zone preferences."

Point-in-time recovery (PITR) clone

kind: tool
name: clone-instance-pitr
type: cloud-sql-clone-instance
source: cloud-sql-admin-source
description: "Creates an exact copy of a Cloud SQL instance at a specific point in time (PITR). Supports configuring instance zones and high-availability setup through zone preferences"

Reference

Tool Configuration

field	type	required	description
type	string	true	Must be “cloud-sql-clone-instance”.
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

Tool Inputs

parameter	type	required	description
project	string	true	The project ID.
sourceInstanceName	string	true	The name of the source instance to clone.
destinationInstanceName	string	true	The name of the new (cloned) instance.
pointInTime	string	false	(Optional) The point in time for a PITR (Point-In-Time Recovery) clone.
preferredZone	string	false	(Optional) The preferred zone for the cloned instance. If not specified, defaults to the source instance’s zone.
preferredSecondaryZone	string	false	(Optional) The preferred secondary zone for the cloned instance (for HA).

Advanced Usage

The tool supports both basic clone and point-in-time recovery (PITR) clone operations.
For PITR, specify the pointInTime parameter in RFC3339 format (e.g., 2024-01-01T00:00:00Z).
The source must be a valid Cloud SQL Admin API source.
You can optionally specify the zone parameter to set the zone for the cloned instance. If omitted, the zone of the source instance will be used.
You can optionally specify the preferredZone and preferredSecondaryZone (only in REGIONAL instances) to set the preferred zones for the cloned instance. These are useful for high availability (HA) configurations. If omitted, defaults will be used based on the source instance.

Additional Resources

cloud-sql-create-backup

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

About

The cloud-sql-create-backup tool creates an on-demand backup on a Cloud SQL instance using the Cloud SQL Admin API.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

parameter	type	required	description
project	string	true	The project ID.
instance	string	true	The name of the instance to take a backup on. Does not include the project ID.
location	string	false	(Optional) Location of the backup run.
backup_description	string	false	(Optional) The description of this backup run.

Example

Basic backup creation (current state)

cloud-sql-create-database

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

About

The cloud-sql-create-database tool creates a new database in a specified Cloud SQL instance.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

parameter	type	required	description
project	string	true	The project ID.
instance	string	true	The ID of the instance where the database will be created.
name	string	true	The name for the new database. Must be unique within the instance.

Example

kind: tool
name: create-cloud-sql-database
type: cloud-sql-create-database
source: my-cloud-sql-admin-source
description: "Creates a new database in a Cloud SQL instance."

Reference

field	type	required	description
type	string	true	Must be “cloud-sql-create-database”.
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

cloud-sql-create-users

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

About

The cloud-sql-create-users tool creates a new user in a specified Cloud SQL instance. It can create both built-in and IAM users.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: create-cloud-sql-user
type: cloud-sql-create-users
source: my-cloud-sql-admin-source
description: "Creates a new user in a Cloud SQL instance. Both built-in and IAM users are supported. IAM users require an email account as the user name. IAM is the more secure and recommended way to manage users. The agent should always ask the user what type of user they want to create. For more information, see https://cloud.google.com/sql/docs/postgres/add-manage-iam-users"

Reference

field	type	required	description
type	string	true	Must be “cloud-sql-create-users”.
description	string	false	A description of the tool.
source	string	true	The name of the `cloud-sql-admin` source to use.

cloud-sql-get-instance

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

About

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

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: get-sql-instance
type: cloud-sql-get-instance
source: my-cloud-sql-admin-source
description: "Gets a particular cloud sql instance."

Reference

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

cloud-sql-mssql-create-instance

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

About

The cloud-sql-mssql-create-instance tool creates a Cloud SQL for SQL Server instance using the Cloud SQL Admin API.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: create-sql-instance
type: cloud-sql-mssql-create-instance
source: cloud-sql-admin-source
description: "Creates a SQL Server instance using `Production` and `Development` presets. For the `Development` template, it chooses a 2 vCPU, 8 GiB RAM (`db-custom-2-8192`) configuration with Non-HA/zonal availability. For the `Production` template, it chooses a 4 vCPU, 26 GiB RAM (`db-custom-4-26624`) configuration with HA/regional availability. The Enterprise edition is used in both cases. The default database version is `SQLSERVER_2022_STANDARD`. The agent should ask the user if they want to use a different version."

Reference

Tool Configuration

field	type	required	description
type	string	true	Must be “cloud-sql-mssql-create-instance”.
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

Tool Inputs

parameter	type	required	description
project	string	true	The project ID.
name	string	true	The name of the instance.
databaseVersion	string	false	The database version for SQL Server. If not specified, defaults to the latest available version (e.g., SQLSERVER_2022_STANDARD).
rootPassword	string	true	The root password for the instance.
editionPreset	string	false	The edition of the instance. Can be `Production` or `Development`. This determines the default machine type and availability. Defaults to `Development`.

cloud-sql-postgres-create-instance

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

About

The cloud-sql-postgres-create-instance tool creates a Cloud SQL for PostgreSQL instance using the Cloud SQL Admin API.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: create-sql-instance
type: cloud-sql-postgres-create-instance
source: cloud-sql-admin-source
description: "Creates a Postgres instance using `Production` and `Development` presets. For the `Development` template, it chooses a 2 vCPU, 16 GiB RAM, 100 GiB SSD configuration with Non-HA/zonal availability. For the `Production` template, it chooses an 8 vCPU, 64 GiB RAM, 250 GiB SSD configuration with HA/regional availability. The Enterprise Plus edition is used in both cases. The default database version is `POSTGRES_17`. The agent should ask the user if they want to use a different version."

Reference

Tool Configuration

field	type	required	description
type	string	true	Must be “cloud-sql-postgres-create-instance”.
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

Tool Inputs

parameter	type	required	description
project	string	true	The project ID.
name	string	true	The name of the instance.
databaseVersion	string	false	The database version for Postgres. If not specified, defaults to the latest available version (e.g., POSTGRES_17).
rootPassword	string	true	The root password for the instance.
editionPreset	string	false	The edition of the instance. Can be `Production` or `Development`. This determines the default machine type and availability. Defaults to `Development`.

cloud-sql-restore-backup

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

About

The cloud-sql-restore-backup tool restores a backup on a Cloud SQL instance using the Cloud SQL Admin API.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Parameters

parameter	type	required	description
target_project	string	true	The project ID of the instance to restore the backup onto.
target_instance	string	true	The instance to restore the backup onto. Does not include the project ID.
backup_id	string	true	The identifier of the backup being restored.
source_project	string	false	(Optional) The project ID of the instance that the backup belongs to.
source_instance	string	false	(Optional) Cloud SQL instance ID of the instance that the backup belongs to.

Example

Basic backup restore

cloud-sql-wait-for-operation

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

About

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

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: cloudsql-operations-get
type: cloud-sql-wait-for-operation
source: my-cloud-sql-source
description: "This will poll on operations API until the operation is done. For checking operation status we need projectId and operationId. Once instance is created give follow up steps on how to use the variables to bring data plane MCP server up in local and remote setup."
delay: 1s
maxDelay: 4m
multiplier: 2
maxRetries: 10

Reference

field	type	required	description
type	string	true	Must be “cloud-sql-wait-for-operation”.
source	string	true	The name of a `cloud-sql-admin` source to use for authentication.
description	string	false	A description of the tool.
delay	duration	false	The initial delay between polling requests (e.g., `3s`). Defaults to 3 seconds.
maxDelay	duration	false	The maximum delay between polling requests (e.g., `4m`). Defaults to 4 minutes.
multiplier	float	false	The multiplier for the polling delay. The delay is multiplied by this value after each request. Defaults to 2.0.
maxRetries	int	false	The maximum number of polling attempts before giving up. Defaults to 10.

postgres-upgrade-precheck

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

About

The postgres-upgrade-precheck tool initiates a pre-check on a Cloud SQL for PostgreSQL instance to assess its readiness for a major version upgrade using the Cloud SQL Admin API. It helps identify potential incompatibilities or issues before starting the actual upgrade process.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Cloud SQL Admin

Example

kind: tool
name: postgres-upgrade-precheck
type: postgres-upgrade-precheck
source: cloud-sql-admin-source
description: "Checks if a Cloud SQL PostgreSQL instance is ready for a major version upgrade to the specified target version."

Reference

field	type	required	description
type	string	true	Must be “postgres-upgrade-precheck”.
source	string	true	The name of the `cloud-sql-admin` source to use.
description	string	false	A description of the tool.

parameter	type	required	description
project	string	true	The project ID containing the instance.
instance	string	true	The name of the Cloud SQL instance to check.
targetDatabaseVersion	string	false	The target PostgreSQL major version for the upgrade (e.g., `POSTGRES_18`). If not specified, defaults to the PostgreSQL 18.