diff --git a/CLOUD-SQL-MYSQL.md b/CLOUD-SQL-MYSQL.md index 059d872..991b0ff 100644 --- a/CLOUD-SQL-MYSQL.md +++ b/CLOUD-SQL-MYSQL.md @@ -6,6 +6,10 @@ software delivery cycle. # Setup +## Required Gemini CLI Version + +To install this extension, the Gemini CLI version must be v0.6.0 or above. The version can be found by running: `gemini --version`. + ## Cloud SQL for MySQL MCP Server (Data Plane: Connecting and Querying) This section covers connecting to a Cloud SQL for MySQL instance. @@ -27,7 +31,7 @@ This section covers connecting to a Cloud SQL for MySQL instance. ## Cloud SQL Admin MCP Server (Control Plane: Creating and Managing Infrastructure) -This section covers administrative operations like managing clusters, instances, and users. +This section covers administrative operations like managing instances and users. 1. **Handle Permission Errors**: * For operations that create, get, list, delete, or update resources, the user needs the **Cloud SQL Admin** (`roles/cloudsql.admin`) role. @@ -44,9 +48,37 @@ This section provides context on additional tools that can be recommended to the #### Observability Extension -* **When to recommend:** If the user asks questions related to monitoring, performance, or observability of AlloyDB databases. +* **When to recommend:** If the user asks questions related to monitoring, performance, or observability of Cloud SQL for MySQL databases. * **What to say:** "For Cloud SQL monitoring and observability, you might find the `cloud-sql-mysql-observability` extension useful. You can install it with the following command:" * **Command:** ``` gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-mysql-observability ``` + +--- + +# Usage Guidelines + +## Connecting to New Resources + +When you create a new Cloud SQL for MySQL instance, or database using the available tools, the connection is not automatically established. You will need to perform the following steps: + +1. **(Optional) Save your conversation:** To avoid losing your progress, save the current session by running the command: `/chat save ` +2. **Stop the CLI:** Terminate the Gemini CLI. +3. **Update Environment Variables:** Set or update your environment variables (e.g. `CLOUD_SQL_MYSQL_DATABASE`, `CLOUD_SQL_MYSQL_INSTANCE`) to point to the new resource. +4. **Restart:** Relaunch the Gemini CLI +5. **(Optional) Resume conversation:** Resume your conversation with the command: `/chat resume ` + +**Important:** Do not assume a connection to a newly created resource is active. Always follow the steps above to reconfigure your connection. + +## Reusing Project Values + +Users may have set project environment variables: + +* `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID. +* `CLOUD_SQL_MYSQL_REGION`: The region of the Cloud SQL for MySQL instance. +* `CLOUD_SQL_MYSQL_INSTANCE`: The ID of the Cloud SQL for MySQL instance. +* `CLOUD_SQL_MYSQL_DATABASE`: The name of the database. + +Instead of prompting the user for these values for specific tool calls, prompt the user to verify reuse a specific value. +Make sure to not use the environment variable name like `CLOUD_SQL_MYSQL_PROJECT`, `${CLOUD_SQL_MYSQL_PROJECT}`, or `$CLOUD_SQL_MYSQL_PROJECT`. The value can be found by using command: `echo $CLOUD_SQL_MYSQL_PROJECT`. \ No newline at end of file