AlloyDB Omni Agent Skills

Note

Currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).

This repository provides a set of agent skills to interact with AlloyDB Omni instances. These skills can be used with various AI agents, including Gemini CLI, 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 Agent Skills?
• Prerequisites
• Getting Started
  • Configuration
  • Installation & Usage
    • Gemini CLI
    • Claude Code
    • Codex
    • Antigravity
• Usage Examples
• Supported Skills
• Troubleshooting

Why Use AlloyDB Omni Agent Skills?

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

• One of these AI agents installed
  • Gemini CLI version v0.6.0 or higher
  • Claude Code version v2.1.94 or higher
  • Codex v0.117.0 or higher
  • Antigravity v1.14.2 or higher
• An active AlloyDB Omni instance.

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

Gemini CLI

1. Install the extension:

gemini extensions install https://github.com/gemini-cli-extensions/alloydb-omni

During the installation, enter your environment vars as described in the configuration section.

2. (Optional) Manage Configuration: To view or update your configuration in Gemini CLI:

• Terminal: gemini extensions config alloydb-omni [setting name] [--scope <scope>]
• Gemini CLI: /extensions list

3. Start the agent:

gemini

(Tip: Run /extensions list to verify your configuration and active extensions.)

[!WARNING] Changing Instance & Database Connections Currently, the database connection must be configured before starting the agent and can not be changed during a session. To save and resume conversation history in Gemini CLI use command: /chat save <tag> and /chat resume <tag>.

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. Add the marketplace:

/plugin marketplace add https://github.com/gemini-cli-extensions/alloydb-omni.git#0.2.1

4. Install the plugin:

/plugin install alloydb-omni@alloydb-omni-marketplace

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

Codex

1. Clone the Repo:

git clone --branch 0.2.1 git@github.com:gemini-cli-extensions/alloydb-omni.git

2. Install the plugin:

mkdir -p ~/.codex/plugins
cp -R /absolute/path/to/alloydb-omni ~/.codex/plugins/alloydb-omni

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

4. Create or update marketplace.json: ~/.agents/plugins/marketplace.json

{
  "name": "my-data-cloud-google-marketplace",
  "interface": {
    "displayName": "Google Data Cloud Skills"
  },
  "plugins": [
    {
      "name": "alloydb-omni",
      "source": {
        "source": "local",
        "path": "./plugins/alloydb-omni"
      },
      "policy": {
        "installation": "AVAILABLE",
        "authentication": "ON_INSTALL"
      },
      "category": "Database"
    }
  ]
}

(Tip: Run codex plugin list or use the /plugins interactive menu to verify your installed plugins.)

Antigravity

1. Clone the Repo:

git clone --branch 0.2.1 https://github.com/gemini-cli-extensions/alloydb-omni.git

2. Install the skills:

Choose a location for the skills:

• Global (all workspaces): ~/.gemini/antigravity/skills/
• Workspace-specific: <workspace-root>/.agents/skills/

Copy the skill folders from the cloned repository's skills/ directory to your chosen location:

cp -R alloydb-omni/skills/* ~/.gemini/antigravity/skills/

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

(Tip: Antigravity automatically discovers skills in these directories at the start of a session.)

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

Supported Skills

The following skills are available in this repository:

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

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.