genai-toolbox/docs/CLOUDSQLPG_README.md

Cloud SQL for PostgreSQL MCP Server

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

Features

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

• Query Data - Execute SQL queries and analyze query plans
• Explore Schema - List tables, views, indexes, and triggers
• Monitor Performance - View active queries, bloat, and memory configurations
• Manage Extensions - List available and installed extensions

For Cloud SQL infrastructure management, search the MCP store for the Cloud SQL for PostgreSQL Admin MCP Server.

Prerequisites

• Node.js installed.
• 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)

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

Install & Configuration

1. In the Antigravity MCP Store, click the "Install" button.

2. Add the required inputs for your instance in the configuration pop-up, then click "Save". You can update this configuration at any time in the "Configure" tab.

You'll now be able to see all enabled tools in the "Tools" tab.

Note

If you encounter issues with Windows Defender blocking the execution, you may need to configure an allowlist. See Configure exclusions for Microsoft Defender Antivirus for more details.

Usage

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

• "Show me the top 5 bloated tables."
• "List all installed extensions."
• "Explain the query plan for SELECT * FROM users."

Server Capabilities

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

Tool Name	Description
execute_sql	Use this tool to execute sql.
list_tables	Lists detailed schema information for user-created tables.
list_active_queries	List the top N currently running queries.
list_available_extensions	Discover all PostgreSQL extensions available for installation.
list_installed_extensions	List all installed PostgreSQL extensions.
list_autovacuum_configurations	List PostgreSQL autovacuum-related configurations.
list_memory_configurations	List PostgreSQL memory-related configurations.
list_top_bloated_tables	List the top tables by dead-tuple (approximate bloat signal).
list_replication_slots	List key details for all PostgreSQL replication slots.
list_invalid_indexes	Lists all invalid PostgreSQL indexes.
get_query_plan	Generate a PostgreSQL EXPLAIN plan in JSON format.
list_views	Lists views in the database.
list_schemas	Lists all schemas in the database.
database_overview	Fetches the current state of the PostgreSQL server.
list_triggers	Lists all non-internal triggers in a database.
list_indexes	Lists available user indexes in the database.
list_sequences	Lists sequences in the database.

Custom MCP Server Configuration

The MCP server is configured using environment variables.

export CLOUD_SQL_POSTGRES_PROJECT="<your-gcp-project-id>"
export CLOUD_SQL_POSTGRES_REGION="<your-cloud-sql-region>"
export CLOUD_SQL_POSTGRES_INSTANCE="<your-cloud-sql-instance-id>"
export CLOUD_SQL_POSTGRES_DATABASE="<your-database-name>"
export CLOUD_SQL_POSTGRES_USER="<your-database-user>"  # Optional
export CLOUD_SQL_POSTGRES_PASSWORD="<your-database-password>"  # Optional
export CLOUD_SQL_POSTGRES_IP_TYPE="PUBLIC"  # Optional: `PUBLIC`, `PRIVATE`, `PSC`. Defaults to `PUBLIC`.

Add the following configuration to your MCP client (e.g., settings.json for Gemini CLI, mcp_config.json for Antigravity):

{
  "mcpServers": {
    "cloud-sql-postgres": {
      "command": "npx",
      "args": ["-y", "@toolbox-sdk/server", "--prebuilt", "cloud-sql-postgres", "--stdio"],
      "env": {
        "CLOUD_SQL_POSTGRES_PROJECT": "your-project-id",
        "CLOUD_SQL_POSTGRES_REGION": "your-region",
        "CLOUD_SQL_POSTGRES_INSTANCE": "your-instance-id",
        "CLOUD_SQL_POSTGRES_DATABASE": "your-database-name",
        "CLOUD_SQL_POSTGRES_USER": "your-username",
        "CLOUD_SQL_POSTGRES_PASSWORD": "your-password"
      }
    }
  }
}

Documentation

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