Skip to content

Commit ae52f70

Browse files
committed
feat: additional instructions for the context file
1 parent 4fa30b4 commit ae52f70

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CLOUD-SQL-SQLSERVER.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ software delivery cycle.
66

77
# Setup
88

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+
913
## Cloud SQL for SQL Server MCP Server (Data Plane: Connecting and Querying)
1014

1115
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,
3640
* If an operation fails due to permissions, identify the type of operation and recommend the appropriate role. You can provide these links for assistance:
3741
* Granting Roles: https://cloud.google.com/iam/docs/grant-role-console
3842
* Cloud SQL Permissions: https://cloud.google.com/sql/docs/postgres/iam-permissions
43+
44+
---
45+
46+
# Additional Tools
47+
48+
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:"
54+
* **Command:**
55+
```
56+
gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-sqlserver-observability
57+
```
58+
59+
---
60+
61+
# Usage Guidelines
62+
63+
## Connecting to New Resources
64+
65+
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`.

0 commit comments

Comments
 (0)