## Description > Should include a concise description of the changes (bug or feature), it's > impact, along with a summary of the solution ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [ ] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: prernakakkar-google <158031829+prernakakkar-google@users.noreply.github.com>
5.0 KiB
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
-
Download and install MCP Toolbox:
-
Download the Toolbox binary: Download the latest binary for your operating system and architecture from the storage bucket. Check the releases page for additional versions:
-
To install Toolbox as a binary on Linux (AMD64):
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox -
To install Toolbox as a binary on macOS (Apple Silicon):
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/arm64/toolbox -
To install Toolbox as a binary on macOS (Intel):
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/amd64/toolbox -
To install Toolbox as a binary on Windows (AMD64):
curl -o toolbox.exe "https://storage.googleapis.com/genai-toolbox/v0.21.0/windows/amd64/toolbox.exe"
-
-
Make it executable:
chmod +x toolbox -
Add the binary to $PATH in
.~/bash_profile(Note: You may need to restart Antigravity for changes to take effect.):export PATH=$PATH:path/to/folderOn 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, useecho $PATH(orecho %PATH%on Windows).
-
-
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)
- AlloyDB Admin (
Install & Configuration
- In the Antigravity MCP Store, click the "Install" button.
You'll now be able to see all enabled tools in the "Tools" tab.
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 Name | Description |
|---|---|
create_cluster |
Create an AlloyDB cluster. |
create_instance |
Create an AlloyDB instance (PRIMARY, READ-POOL, or SECONDARY). |
create_user |
Create ALLOYDB-BUILT-IN or IAM-based users for an AlloyDB cluster. |
get_cluster |
Get details about an AlloyDB cluster. |
get_instance |
Get details about an AlloyDB instance. |
get_user |
Get details about a user in an AlloyDB cluster. |
list_clusters |
List clusters in a given project and location. |
list_instances |
List instances in a given project and location. |
list_users |
List users in a given project and location. |
wait_for_operation |
Poll 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):
{
"mcpServers": {
"alloydb-admin": {
"command": "toolbox",
"args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"]
}
}
}
Documentation
For more information, visit the AlloyDB for PostgreSQL documentation.