Skip to content

gemini-cli-extensions/alloydb-omni

v0.2.2Apache-2.0

Create, connect, and interact with an AlloyDB Omni database and data.

GitHubOpen Website

AlloyDB Omni

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-omni server as a plugin/extension to interact with AlloyDB Omni 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 Omni?

  • 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 clusters 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:

Getting Started

Configuration

Please keep these environment variables handy during the installation process:

  • ALLOYDB_OMNI_HOST: (Optional: localhost by default) The host of your AlloyDB cluster.
  • ALLOYDB_OMNI_PORT: (Optional: 5432 by default) The port of your AlloyDB cluster.
  • ALLOYDB_OMNI_DATABASE: The name of the database to connect to.
  • ALLOYDB_OMNI_USER: The database username.
  • ALLOYDB_OMNI_PASSWORD: The password for the database user.
  • ALLOYDB_OMNI_QUERY_PARAMS: (Optional) Additional query parameters.

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.

Antigravity

You can use either of these two agents for Antigravity:

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-omni

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-omni

2. Set env vars: Set your environment vars as described in the configuration section.

Claude Code

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-omni@claude-plugins-official

_(Tip: Run /plugin list inside Claude Code to verify the plugin is active, or /reload-plugins if you just installed it.)

Codex

1. Install marketplace:

codex plugin marketplace add GoogleCloudPlatform/data-cloud-plugins

2. Install the plugin:

codex plugin add alloydb-omni@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-omni

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 Omni using natural language right from your IDE:

  • Provision Infrastructure:

    • "Create a new AlloyDB Omni container with Docker."
    • "Show me all the AlloyDB Omni DBClusters on my Kubernetes 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, and what were the top 5 most purchased items?"

  • Generate Code:

    • "Generate a Python dataclass to represent the 'customers' table."

Available Tools

The tools come from MCP Toolbox's prebuilt alloydb-omni server, grouped into toolsets:

  • data - Use these tools when you need to explore the database structure, identify schema objects like views and triggers, and execute SQL queries to interact with your data.
  • performance - Use these tools when you need to analyze query performance, generate execution plans, check table/column statistics, and monitor overall database activity.
  • monitor - Use these tools when you need to troubleshoot production issues by identifying locks, tracking long-running transactions, and getting a high-level view of server state.
  • optimize - Use these tools when you need to fine-tune the database engine settings, manage extensions, or optimize the columnar engine for better analytical performance.
  • health - Use these tools when you need to audit database health, identify storage bloat, find broken indexes, and verify tablespace or maintenance configurations.
  • replication - Use these tools when you need to monitor the health of database replication, manage sync states between nodes, and audit publication tables for distributed setups.
  • access-control - Use these tools when you need to manage user roles, inspect permissions, and verify security-related configuration parameters.

For the full, up-to-date list, see the alloydb-omni 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-omni 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.

The hand-authored skills in skills/ are unaffected and still ship with the plugin.

Troubleshooting

Use the debug mode of your agent (e.g., gemini --debug) to enable debugging.

Common issues:

  • "✖ 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 ... ENOENT": A skill script or dependency might be missing. Ensure you have Node.js installed and have properly installed the extension.