AlloyDB for PostgreSQL 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 for PostgreSQL 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 for PostgreSQL Agent Skills?
• Prerequisites
• Getting Started
  • Configuration
  • Installation & Usage
    • Gemini CLI
    • Claude Code
    • Codex
    • Antigravity
• Usage Examples
• Supported Skills
• Additional Agent Skills
• Troubleshooting

Why Use AlloyDB for PostgreSQL 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 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
  • 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
• 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)

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, or PSC. Defaults to PUBLIC.

[!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 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.

1. Install the extension:

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

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

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.git#0.2.0

4. Install the plugin:

/plugin install alloydb@alloydb-marketplace

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

1. Clone the Repo:

git clone --branch 0.2.0 [email protected]:gemini-cli-extensions/alloydb.git

2. Install the plugin:

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

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",
      "source": {
        "source": "local",
        "path": "./plugins/alloydb"
      },
      "policy": {
        "installation": "AVAILABLE",
        "authentication": "ON_INSTALL"
      },
      "category": "Database"
    }
  ]
}

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

1. Clone the Repo:

git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/alloydb.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/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 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."

Supported Skills

This repository includes the following skill sets:

• alloydb-postgres-admin: Provision clusters/instances, monitor creation, and retrieve configuration.
• alloydb-postgres-access-management: Manage users, roles, and security settings.
• alloydb-postgres-data: Explore schemas, identify objects (views, triggers), and execute SQL.
• alloydb-postgres-monitor: Troubleshoot performance, analyze query plans, and monitor metrics.
• alloydb-postgres-health: Optimize storage, identify index issues, and manage maintenance.
• alloydb-postgres-optimize: Manage extensions and fine-tune engine-level settings.
• alloydb-postgres-replication: Monitor replication health and manage sync states.

Additional Agent Skills

Find additional skills to support your entire software development lifecycle at github.com/gemini-cli-extensions, including:

• Generic PostgreSQL extension
• AlloyDB Observability extension

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 .../toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using the latest version of your agent.
• "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.