alloydb-plugin
Health Gecti
- License — License: Apache-2.0
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Community trust — 24 GitHub stars
Code Gecti
- Code scan — Scanned 12 files during light audit, no dangerous patterns found
Permissions Gecti
- Permissions — No dangerous permissions requested
This tool provides a set of natural language agent skills for managing Google Cloud AlloyDB for PostgreSQL instances. It allows AI agents like Gemini CLI, Claude Code, and Codex to explore database schemas, execute queries, and handle administrative tasks.
Security Assessment
The tool inherently interacts with sensitive data by design, as it requires IAM permissions to access and query your AlloyDB databases. It makes network requests to the Google Cloud API using Application Default Credentials rather than hardcoded secrets (none were found). A code scan of 12 files revealed no dangerous patterns, no shell command execution, and no excessive permissions. Overall risk is rated as Medium solely because a compromised or misconfigured AI agent could potentially read or alter your database.
Quality Assessment
The project appears to be actively maintained, with its most recent push occurring today. It uses the permissive Apache-2.0 license and includes clear documentation. While community trust is currently low due to having only 18 GitHub stars, the codebase itself passed all automated health and security checks. Keep in mind that it is currently in beta, meaning breaking changes might occur before the v1.0 release.
Verdict
Safe to use, provided you strictly limit the IAM roles granted to the agent and understand the inherent risks of letting an AI execute actions directly against your database.
Skills for AlloyDB
AlloyDB for PostgreSQL
[!NOTE]
Currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).
This repository packages MCP Toolbox's prebuilt alloydb-postgres server as a plugin/extension to interact with AlloyDB for PostgreSQL instances. It can be used with various AI agents, including Antigravity, Claude Code and Codex, to manage your databases, execute queries, explore schemas, and troubleshoot issues using natural language prompts.
[!IMPORTANT]
We Want Your Feedback!
Please share your thoughts with us by filling out our feedback form.
Your input is invaluable and helps us improve the project for everyone.
Table of Contents
- Why Use AlloyDB for PostgreSQL?
- Prerequisites
- Getting Started
- Installing via a compatible Agent Plugins client
- Usage Examples
- Available Tools
- Generating Skills Instead
- Additional Agent Skills
- Troubleshooting
Why Use AlloyDB for PostgreSQL?
- Seamless Workflow: Integrates seamlessly into your AI agent's environment. No need to constantly switch contexts for common database tasks.
- Natural Language Queries: Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
- Full Lifecycle Control: Manage the entire lifecycle of your database, from creating instances to exploring schemas and running queries.
- Code Generation: Accelerate development by asking your agent to generate data classes and other code snippets based on your table schemas.
Prerequisites
Before you begin, ensure you have the following:
- One of these AI agents installed
- Antigravity
- Antigravity CLI version v1.6.0 or higher
- Antigravity 2.0 version v2.0.0 or higher.
- Claude Code version v2.1.94 or higher.
- Codex v0.117.0 or higher.
- Antigravity
- Node.js — the MCP server runs via
npx. - A Google Cloud project with the AlloyDB API enabled.
- Ensure Application Default Credentials are available in your environment.
- IAM Permissions:
- AlloyDB Client (
roles/alloydb.client) - AlloyDB Admin (
roles/alloydb.admin)
- AlloyDB Client (
Getting Started
Configuration
Please keep these env vars handy during the installation process:
ALLOYDB_POSTGRES_PROJECT: The GCP project ID.ALLOYDB_POSTGRES_REGION: The region of your AlloyDB instance.ALLOYDB_POSTGRES_CLUSTER: The ID of your AlloyDB cluster.ALLOYDB_POSTGRES_INSTANCE: The ID of your AlloyDB instance.ALLOYDB_POSTGRES_DATABASE: The name of the database to connect to.ALLOYDB_POSTGRES_USER: (Optional) The database username.ALLOYDB_POSTGRES_PASSWORD: (Optional) The password for the database user.ALLOYDB_POSTGRES_IP_TYPE: (Optional) Type of the IP address:PUBLIC,PRIVATE, orPSC. Defaults toPUBLIC.
[!NOTE]
- Ensure Application Default Credentials are available in your environment.
- If your AlloyDB instance uses private IPs, you must run your agent in the same Virtual Private Cloud (VPC) network.
Installation & Usage
To start interacting with your database, install the extension for your preferred AI agent, then launch the agent and use natural language to ask questions or perform tasks.
For the latest version, check the releases page.
AntigravityYou can use either of these two agents for Antigravity:
- Antigravity CLI version v1.6.0 or higher
- Antigravity 2.0 version v2.0.0 or higher.
💡 Tip — Migrating from Gemini CLI?
If you previously installed this extension withgemini extensions install, you can convert it to an Antigravity plugin instead of reinstalling from scratch:See Migrating from Gemini CLI for details on plugins, context files (
- On first launch of Antigravity CLI, accept the Migration Options prompt to automatically convert your installed Gemini CLI extensions to Antigravity plugins.
- Or, from your terminal, run:
agy plugin import geminiGEMINI.md/AGENTS.md), and MCP server config differences.
Antigravity 2.0 (IDE)
1. Install the plugin:
Install the plugin directly from the remote GitHub repository:
agy plugin install https://github.com/gemini-cli-extensions/alloydb
2. Set env vars:
Set your environment vars as described in the configuration section.
(Tip: You can verify the MCP server is active by running the /mcp command in your active session.)
Antigravity CLI
You can install plugins directly from a remote GitHub repository.
1. Install the plugin:
agy plugin install https://github.com/gemini-cli-extensions/alloydb
2. Set env vars:
Set your environment vars as described in the configuration section.
1. Set env vars:
In your terminal, set your environment vars as described in the configuration section.
2. Start the agent:
claude
3. Install the plugin:
/plugin install alloydb@claude-plugins-official
_(Tip: Run /plugin list inside Claude Code to verify the plugin is active, or /reload-plugins if you just installed it.)
1. Install marketplace:
codex plugin marketplace add GoogleCloudPlatform/data-cloud-plugins
2. Install the plugin:
codex plugin add alloydb@data-cloud-plugins
3. Set env vars:
Enter your environment vars as described in the configuration section.
4. (Optional) Update the marketplace:
codex plugin marketplace upgrade data-cloud-plugins
Installing via a compatible Agent Plugins client
Installing via a compatible Agent Plugins client
This repository is a valid Agent Plugins (v1) plugin. Any Agent Plugins–compatible client can install it directly using its own built-in plugin command — no extra tooling required — by pointing at this repository:
https://github.com/gemini-cli-extensions/alloydb
Beyond harnesses covered by the native install above, compatible clients include VS Code, Cursor, GitHub Copilot, and Kiro. See your agent's documentation for its exact install command.
Set env vars:
Set your environment vars as described in the configuration section.
Usage Examples
Interact with AlloyDB using natural language right from your agent:
- Provision Infrastructure:
- "Create a new AlloyDB cluster named 'e-commerce-prod' in project 'my-gcp-project'."
- "Add a read-only instance to my 'e-commerce-prod' cluster."
- Explore Schemas and Data:
- "Show me all tables in the 'orders' database."
- "What are the columns in the 'products' table?"
- "How many orders were placed in the last 30 days?"
- Generate Code:
- "Generate a Python dataclass to represent the 'customers' table."
Available Tools
The tools come from MCP Toolbox's prebuilt alloydb-postgres server, grouped into toolsets:
- admin - Use these tools when you need to provision new AlloyDB clusters and instances, monitor their creation status, and retrieve high-level configuration or health data for the environment.
- access-management - Use these tools when you need to manage database users, inspect permissions and roles, and verify global configuration parameters related to security and access control.
- data - Use these tools when you need to explore the database schema, identify objects like views and triggers, and execute custom SQL queries to interact with your data.
- monitor - Use these tools when you need to troubleshoot slow performance, analyze query execution plans, identify resource-heavy processes, and monitor system-level PromQL metrics.
- health - Use these tools when you need to optimize storage, identify index issues, analyze table statistics, or manage autovacuum and tablespace configurations to maintain peak database health.
- optimize - Use these tools when you need to discover and manage PostgreSQL extensions or fine-tune engine-level settings such as memory allocation and server configuration parameters.
- replication - Use these tools when you need to monitor replication health, manage sync states between nodes, and ensure the high availability and data distribution of your AlloyDB cluster.
For the full, up-to-date list, see the alloydb-postgres prebuilt config
in the MCP Toolbox repository.
Generating Skills Instead
The tool-backed skills this plugin used to ship were generated from the same prebuilt
toolsets. If your agent lacks deferred tool loading, or you prefer skills, regenerate
them with the script in this repository:
VERSION=<toolbox version> ./.github/scripts/generate_skills.sh
Use the toolbox version pinned in mcp.json. A single toolset, without
the script:
npx @toolbox-sdk/server@<toolbox version> --prebuilt alloydb-postgres skills-generate \
--name "<skill name>" \
--toolset "<toolset>" \
--description "<what it is for>"
The generated scripts call the toolbox through npx, so no binary download is needed.
See Generate Agent Skills
in the MCP Toolbox repository.
Additional Agent Skills
Find additional skills to support your entire software development lifecycle at github.com/gemini-cli-extensions, including:
Troubleshooting
Use the debug mode of your agent (e.g., gemini --debug) to enable debugging.
Common issues:
- "failed to find default credentials: google: could not find default credentials.": Ensure Application Default Credentials are available in your environment. See Set up Application Default Credentials for more information.
- "✖ Error during discovery for server: MCP error -32000: Connection closed": The database connection has not been established. Ensure your configuration is set via environment variables.
- "✖ MCP ERROR: Error: spawn npx ENOENT": Node.js is not installed, or
npxis not on yourPATH. Install Node.js, which providesnpx. - "cannot execute binary file": The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded. See Installing the server for more information.
Yorumlar (0)
Yorum birakmak icin giris yap.
Yorum birakSonuc bulunamadi