Back to Genai Toolbox

AlloyDB for PostgreSQL Admin MCP Server

docs/ALLOYDBADMIN_README.md

1.1.03.9 KB
Original Source

AlloyDB for PostgreSQL Admin MCP Server

The AlloyDB Model Context Protocol (MCP) Server gives AI-powered development tools the ability to work with your Google Cloud AlloyDB for PostgreSQL resources. It supports full lifecycle control, from creating clusters and instances to exploring schemas and running queries.

Features

An editor configured to use the AlloyDB MCP server can use its AI capabilities to help you:

  • Provision & Manage Infrastructure: Create and manage AlloyDB clusters, instances, and users

To connect to the database to explore and query data, search the MCP store for the AlloyDB for PostgreSQL MCP Server.

Prerequisites

  • Node.js installed.
  • A Google Cloud project with the AlloyDB API enabled.
  • Ensure Application Default Credentials are available in your environment.
  • IAM Permissions:
    • AlloyDB Admin (roles/alloydb.admin) (for managing infrastructure)
    • Service Usage Consumer (roles/serviceusage.serviceUsageConsumer)

Install & Configuration

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

[!NOTE] On first use, the installation process automatically downloads and uses MCP Toolbox >=0.26.0. To update MCP Toolbox, use: npm i -g @toolbox-sdk/server@latest To always run the latest version, update the MCP server configuration to use: npx -y @toolbox-sdk/server@latest --prebuilt alloydb-postgres-admin.

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 AlloyDB capabilities to your AI assistant. You can:

  • "Create a new AlloyDB cluster named 'e-commerce-prod' in the 'my-gcp-project' project."
  • "Add a read-only instance to my 'e-commerce-prod' cluster."
  • "Create a new user named 'analyst' with read access to all tables."

Server Capabilities

The AlloyDB MCP server provides the following tools:

Tool NameDescription
create_clusterCreate an AlloyDB cluster.
create_instanceCreate an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY).
create_userCreate ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster.
get_clusterGet details about an AlloyDB cluster.
get_instanceGet details about an AlloyDB instance.
get_userGet details about a user in an AlloyDB cluster.
list_clustersList clusters in a given project and location.
list_instancesList instances in a given project and location.
list_usersList users in a given project and location.
wait_for_operationPoll the operations API until the operation is done.

Custom MCP Server Configuration

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

json
{
  "mcpServers": {
    "alloydb-admin": {
      "command": "npx",
      "args": ["-y", "@toolbox-sdk/server", "--prebuilt", "alloydb-postgres-admin", "--stdio"]
    }
  }
}

Documentation

For more information, visit the AlloyDB for PostgreSQL documentation.