You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLOUD-SQL-SQLSERVER.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ software delivery cycle.
6
6
7
7
# Setup
8
8
9
+
## Required Gemini CLI Version
10
+
11
+
To install this extension, the Gemini CLI version must be v0.6.0 or above. The version can be found by running: `gemini --version`.
12
+
9
13
## Cloud SQL for SQL Server MCP Server (Data Plane: Connecting and Querying)
10
14
11
15
This section covers connecting to a Cloud SQL for SQL Server instance.
@@ -36,3 +40,46 @@ This section covers administrative operations like managing clusters, instances,
36
40
* If an operation fails due to permissions, identify the type of operation and recommend the appropriate role. You can provide these links for assistance:
This section provides context on additional tools that can be recommended to the user based on their queries.
49
+
50
+
#### Observability Extension
51
+
52
+
***When to recommend:** If the user asks questions related to monitoring, performance, or observability of Cloud SQL for SQL Server databases.
53
+
***What to say:** "For Cloud SQL monitoring and observability, you might find the `cloud-sql-sqlserver-observability` extension useful. You can install it with the following command:"
When you create a new Cloud SQL for SQL Server instance, or database using the available tools, the connection is not automatically established. You will need to perform the following steps:
66
+
67
+
1. **(Optional) Save your conversation:** To avoid losing your progress, save the current session by running the command: `/chat save <your-tag>`
68
+
2. **Stop the CLI:** Terminate the Gemini CLI.
69
+
3. **Update Environment Variables:** Set or update your environment variables (e.g. `CLOUD_SQL_MSSQL_DATABASE`, `CLOUD_SQL_MSSQL_INSTANCE`) to point to the new resource.
70
+
4. **Restart:** Relaunch the Gemini CLI
71
+
5. **(Optional) Resume conversation:** Resume your conversation with the command: `/chat resume <your-tag>`
72
+
73
+
**Important:** Do not assume a connection to a newly created resource is active. Always follow the steps above to reconfigure your connection.
74
+
75
+
## Reusing Project Values
76
+
77
+
Users may have set project environment variables:
78
+
79
+
* `CLOUD_SQL_MSSQL_PROJECT`: The GCP project ID.
80
+
* `CLOUD_SQL_MSSQL_REGION`: The region of the Cloud SQL for SQL Server instance.
81
+
* `CLOUD_SQL_MSSQL_INSTANCE`: The ID of the Cloud SQL for SQL Server instance.
82
+
* `CLOUD_SQL_MSSQL_DATABASE`: The name of the database.
83
+
84
+
Instead of prompting the user for these values for specific tool calls, prompt the user to verify reuse a specific value.
85
+
Make sure to not use the environment variable name like `CLOUD_SQL_MSSQL_PROJECT`, `${CLOUD_SQL_MSSQL_PROJECT}`, or `$CLOUD_SQL_MSSQL_PROJECT`. The value can be found by using command: `echo $CLOUD_SQL_MSSQL_PROJECT`.
> When using private IPs with Cloud SQL for SQL Server, you must use a Virtual Private Cloud (VPC) network.
52
54
55
+
### Start Gemini CLI
56
+
57
+
To start the Gemini CLI, use the following command:
58
+
59
+
```bash
60
+
gemini
61
+
```
62
+
63
+
> [!WARNING]
64
+
> **Changing Instance & Database Connections**
65
+
> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
66
+
> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
67
+
53
68
## Usage Examples
54
69
55
70
Interact with Cloud SQL for SQL Server using natural language:
@@ -85,4 +100,6 @@ Find additional extensions to support your entire software development lifecycle
85
100
86
101
## Troubleshooting
87
102
88
-
* "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.
103
+
* "✖ 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.
104
+
* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
105
+
* "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.
0 commit comments