From e594ac7253f360a9fe38c836ca16059bebd1571c Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 26 Sep 2025 14:44:23 -0700 Subject: [PATCH 1/2] docs: update readme getting started instructions --- README.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 79e5478..4e0b272 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,9 @@ Before you begin, ensure you have the following: * Cloud SQL Viewer (`roles/cloudsql.viewer`) * Cloud SQL Admin (`roles/cloudsql.admin`) -## Installation +## Getting Started + +### Installation To install the extension, use the command: @@ -31,9 +33,9 @@ To install the extension, use the command: gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-mysql ``` -## Configuration +### Configuration -Set the following environment variables before starting the Gemini CLI. +Set the following environment variables before starting the Gemini CLI. This configuration is not required if utilizing the [Admin toolset](#supported-tools). * `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. @@ -47,7 +49,20 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. > [!NOTE] -> When using private IPs with Cloud SQL for MySQL, you must use a Virtual Private Cloud (VPC) network. +> If your Cloud SQL for MySQL instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network. + +### Start Gemini CLI + +To start the Gemini CLI, use the following command: + +```bash +gemini +``` + +> [!WARNING] +> **Changing Instance & Database Connections** +> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. +> To save and resume conversation history use command: `/chat save ` and `/chat resume `. ## Usage Examples @@ -84,8 +99,13 @@ Interact with MySQL using natural language: ## Additional Extensions -Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions). +Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including: +* [Generic MySQL extension](https://github.com/gemini-cli-extensions/mysql) +* [Cloud SQL for MySQL Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-mysql-observability) +* and more! ## Troubleshooting -* "cannot execute binary file": Ensure the correct binary for your OS/Architecture has been downloaded. See [Installing the server](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) 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 /Users//.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. +* "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](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) for more information. \ No newline at end of file From 56b99ada7411811c47ff7e328758dcef7c636b59 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 30 Sep 2025 08:30:53 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e0b272..229d16f 100644 --- a/README.md +++ b/README.md @@ -107,5 +107,5 @@ Find additional extensions to support your entire software development lifecycle ## Troubleshooting * "✖ 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 /Users//.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. +* "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/cloud-sql-mysql/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. * "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](https://googleapis.github.io/genai-toolbox/getting-started/introduction/#installing-the-server) for more information. \ No newline at end of file