Files
genai-toolbox/docs/CLOUDSQLMYSQL_README.md
2025-11-24 09:59:01 -08:00

4.7 KiB

Cloud SQL for MySQL MCP Server

The Cloud SQL for MySQL Model Context Protocol (MCP) Server gives AI-powered development tools the ability to work with your Google Cloud SQL for MySQL databases. It supports connecting to instances, exploring schemas, and running queries.

Features

An editor configured to use the Cloud SQL for MySQL MCP server can use its AI capabilities to help you:

  • Query Data - Execute SQL queries and analyze query plans
  • Explore Schema - List tables and view schema details
  • Database Maintenance - Check for fragmentation and missing indexes
  • Monitor Performance - View active queries

Installation and Setup

Prerequisites

  • Download and install MCP Toolbox:

    1. Download the Toolbox binary: Download the latest binary for your operating system and architecture from the storage bucket. Check the releases page for OS and CPU architecture support: https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox

      • Replace <os> with linux, darwin (macOS), or windows.
      • Replace <arch> with amd64 (Intel) or arm64 (Apple Silicon).
      curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
      
    2. Make it executable:

      chmod +x toolbox
      
    3. Move binary to /usr/local/bin/ or /usr/bin/:

      sudo mv toolbox /usr/local/bin/
      # sudo mv toolbox /usr/bin/
      

      On Windows, move binary to the WindowsApps\ folder:

      move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
      

      Tip: Ensure the destination folder for your binary is included in your system's PATH environment variable. To check PATH, use echo $PATH (or echo %PATH% on Windows).

      Note: You may need to restart Antigravity for changes to take effect.

  • A Google Cloud project with the Cloud SQL Admin API enabled.

  • Ensure Application Default Credentials are available in your environment.

  • IAM Permissions:

    • Cloud SQL Client (roles/cloudsql.client)

Configuration

  1. Access the Store: Open the MCP Store panel within the "..." dropdown at the top of the editor's side panel.
  2. Browse and Install: Search for "Cloud SQL for MySQL", and click "Install".
  3. Configuration: The following configuration is needed for the server:
    • Cloud SQL Project ID: The GCP project ID.
    • Cloud SQL Region: The region of your Cloud SQL instance.
    • Cloud SQL Instance ID: The ID of your Cloud SQL instance.
    • Cloud SQL Database Name: The name of the database.
    • Cloud SQL Database User: The database username.
    • Cloud SQL Database Password: The password for the database user.
    • Cloud SQL IP Type: (Optional) The IP type i.e. “Public” or “Private”. Defaults to "Public" if unspecified.

Note

If your instance uses private IPs, you must run the MCP server in the same Virtual Private Cloud (VPC) network.

Usage

Once configured, the MCP server will automatically provide Cloud SQL for MySQL capabilities to your AI assistant. You can:

  • "Show me the schema for the 'orders' table."
  • "List the top 10 active queries."
  • "Check for tables missing unique indexes."

Server Capabilities

The Cloud SQL for MySQL MCP server provides the following tools:

Tool Name Description
execute_sql Use this tool to execute SQL.
list_active_queries Lists top N ongoing queries from processlist and innodb_trx.
get_query_plan Provide information about how MySQL executes a SQL statement (EXPLAIN).
list_tables Lists detailed schema information for user-created tables.
list_tables_missing_unique_indexes Find tables that do not have primary or unique key constraint.
list_table_fragmentation List table fragmentation in MySQL.

Documentation

For more information, visit the Cloud SQL for MySQL documentation.