mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -04:00

Files

Yuan Teoh 975d02e243 docs: update docs for antigravity (#2015 )

Update docs formatting and bullet point indentation. 
Update option to move binary into executables folder.

2025-11-21 15:57:07 -08:00

6.2 KiB

Raw Blame History

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

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

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`.

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

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

{
  "mcpServers": {
    "cloud-sql-postgres": {
      "command": "toolbox",
      "args": ["--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"
      }
    }
  }
}

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.

Documentation

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

6.2 KiB Raw Blame History