Cloud Sql Mysql

Cloud SQL for MySQL 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 Cloud SQL for MySQL instances. These skills 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 Cloud SQL for MySQL Agent Skills?
• Prerequisites
• Getting Started
  • Configuration
  • Installation & Usage
    • Antigravity
    • Claude Code
    • Codex
• Usage Examples
• Supported Skills
• Additional Agent Skills
• Troubleshooting

Why Use Cloud SQL for MySQL 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
  • 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.
• A Google Cloud project with the Cloud SQL Admin API enabled.
• Ensure Application Default Credentials are available in your environment.
• IAM Permissions:
  • Cloud SQL Client (roles/cloudsql.client)
  • Cloud SQL Viewer (roles/cloudsql.viewer)
  • Cloud SQL Admin (roles/cloudsql.admin)

[!NOTE] If you do not configure a specific CLOUD_SQL_MYSQL_USER or CLOUD_SQL_MYSQL_PASSWORD, these skills default to using the active local IAM user credentials. You must also add the IAM user to your Cloud SQL instance, see Creating a database user.

Getting Started

Configuration

Please keep these env vars handy during the installation process:

• CLOUD_SQL_MYSQL_PROJECT: The GCP project ID.
• CLOUD_SQL_MYSQL_REGION: The region of your Cloud SQL instance.
• CLOUD_SQL_MYSQL_INSTANCE: The ID of your Cloud SQL instance.
• CLOUD_SQL_MYSQL_DATABASE: The name of the database to connect to.
• CLOUD_SQL_MYSQL_USER: (Optional) The database username. Defaults to the active IAM user.
• CLOUD_SQL_MYSQL_PASSWORD: (Optional) The password for the database user.
• CLOUD_SQL_MYSQL_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 Cloud SQL for MySQL 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.

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

Antigravity 2.0 (IDE)

1. Clone the Repo:

git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/cloud-sql-mysql.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 cloud-sql-mysql/skills/* ~/.gemini/antigravity/skills/

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

(Tip: Antigravity 2.0 automatically discovers skills in these directories at the start of a session. You can verify they are active by running the /skills command in your active session.)

Antigravity CLI

1. Clone the Repo:

git clone --branch 0.2.0 https://github.com/gemini-cli-extensions/cloud-sql-mysql.git

2. Install the skills:

Choose a location for the skills:

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

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

cp -R cloud-sql-mysql/skills/* ~/.gemini/antigravity-cli/skills/

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

(Tip: Antigravity CLI automatically discovers skills in these directories at the start of a session. You can verify they are active by running the /skills command in your active session.)

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/cloud-sql-mysql.git#0.2.0

4. Install the plugin:

/plugin install cloud-sql-mysql@cloud-sql-mysql-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 git@github.com:gemini-cli-extensions/cloud-sql-mysql.git

2. Install the plugin:

mkdir -p ~/.codex/plugins
cp -R /absolute/path/to/cloud-sql-mysql ~/.codex/plugins/cloud-sql-mysql

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

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

You can install skills using the npx skills command.

Run the following command in your terminal to automatically download and register the skills:

npx skills add https://github.com/gemini-cli-extensions/cloud-sql-mysql/tree/0.2.0

For detailed info check out the Skills npm package.

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

Usage Examples

Interact with Cloud SQL for MySQL using natural language:

• Provision Infrastructure:
  • "Create a new Cloud SQL for MySQL instance named 'e-commerce-prod' in the 'my-gcp-project' project."
  • "Create a new user named 'analyst' with read access to all tables."
• 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:

• Cloud SQL for MySQL Admin - Use these skills when you need to provision new Cloud SQL for MySQL instances, create databases and users, clone existing environments, and monitor the progress of infrastructure operations.
• Cloud SQL for MySQL Data - Use these skills when you need to explore your database schema, execute SQL queries to interact with your data, and inspect how MySQL plans to execute your statements.
• Cloud SQL for MySQL Lifecycle - Use these skills when you need to manage the durability and safety of your data by creating backups, restoring from previous states, or cloning instances for recovery and testing.
• Cloud SQL for MySQL Monitor - Use these skills when you need to troubleshoot slow queries, analyze system-level PromQL metrics, and identify structural performance issues like table fragmentation or missing unique indexes.

Additional Agent Skills

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

• Generic MySQL skills
• Cloud SQL for MySQL Observability extension
• and more!

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 ar

…