Skip to content

Commit ad5a215

Browse files
authored
docs: update docs (#1)
* update docs * update iam * fix link * modify config * nit
1 parent 8a37352 commit ad5a215

File tree

4 files changed

+60
-217
lines changed

4 files changed

+60
-217
lines changed

CLOUD-SQL-SQLSERVER.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# Cloud SQL for SQL Server Extension
1+
You are a highly skilled database engineer and database administrator. Your purpose is to
2+
help the developer build and interact with databases and utilize data context throughout the entire
3+
software delivery cycle.
24

3-
This document provides instructions for the Gemini agent to assist users with the Cloud SQL for SQL Server extension.
5+
--
6+
7+
# Setup
48

59
## Cloud SQL for SQL Server MCP Server (Data Plane: Connecting and Querying)
610

711
This section covers connecting to a Cloud SQL for SQL Server instance.
812

9-
1. **Verify Environment Variables**: Before attempting to connect, confirm with the user that the following environment variables are set in the extension configuration or their shell environment.
13+
1. **Verify Environment Variables**: The extension requires the following environment variables to be set before the Gemini CLI is started:
1014

1115
* `CLOUD_SQL_MSSQL_PROJECT`: The GCP project ID.
1216
* `CLOUD_SQL_MSSQL_REGION`: The region of your Cloud SQL instance.
@@ -18,4 +22,6 @@ This section covers connecting to a Cloud SQL for SQL Server instance.
1822

1923
2. **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${CLOUD_SQL_MSSQL_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
2024

21-
3. **Handle Permission Errors**: If you encounter permission errors, ensure the user has the **Cloud SQL Client** (`roles/cloudsql.client`) role and the correct database-level permissions.
25+
3. **Handle Permission Errors**: If you encounter permission errors, ensure the user has the **Cloud SQL Client** (`roles/cloudsql.client`) role and the correct database-level permissions. You can provide these links for assistance:
26+
* Granting Roles: <https://cloud.google.com/iam/docs/grant-role-console>
27+
* Cloud SQL Permissions: <https://cloud.google.com/iam/docs/roles-permissions/cloudsql>

CONTRIBUTING.md

Lines changed: 21 additions & 191 deletions
Original file line numberDiff line numberDiff line change
@@ -1,202 +1,32 @@
1+
# How to Contribute
12

2-
Apache License
3-
Version 2.0, January 2004
4-
http://www.apache.org/licenses/
3+
We would love to accept your patches and contributions to this project.
54

6-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
5+
## Before you begin
76

8-
1. Definitions.
7+
### Sign our Contributor License Agreement
98

10-
"License" shall mean the terms and conditions for use, reproduction,
11-
and distribution as defined by Sections 1 through 9 of this document.
9+
Contributions to this project must be accompanied by a
10+
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
11+
You (or your employer) retain the copyright to your contribution; this simply
12+
gives us permission to use and redistribute your contributions as part of the
13+
project.
1214

13-
"Licensor" shall mean the copyright owner or entity authorized by
14-
the copyright owner that is granting the License.
15+
If you or your current employer have already signed the Google CLA (even if it
16+
was for a different project), you probably don't need to do it again.
1517

16-
"Legal Entity" shall mean the union of the acting entity and all
17-
other entities that control, are controlled by, or are under common
18-
control with that entity. For the purposes of this definition,
19-
"control" means (i) the power, direct or indirect, to cause the
20-
direction or management of such entity, whether by contract or
21-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22-
outstanding shares, or (iii) beneficial ownership of such entity.
18+
Visit <https://cla.developers.google.com/> to see your current agreements or to
19+
sign a new one.
2320

24-
"You" (or "Your") shall mean an individual or Legal Entity
25-
exercising permissions granted by this License.
21+
### Review our Community Guidelines
2622

27-
"Source" form shall mean the preferred form for making modifications,
28-
including but not limited to software source code, documentation
29-
source, and configuration files.
23+
This project follows [Google's Open Source Community
24+
Guidelines](https://opensource.google/conduct/).
3025

31-
"Object" form shall mean any form resulting from mechanical
32-
transformation or translation of a Source form, including but
33-
not limited to compiled object code, generated documentation,
34-
and conversions to other media types.
26+
## Contribution process
3527

36-
"Work" shall mean the work of authorship, whether in Source or
37-
Object form, made available under the License, as indicated by a
38-
copyright notice that is included in or attached to the work
39-
(an example is provided in the Appendix below).
28+
### Code Reviews
4029

41-
"Derivative Works" shall mean any work, whether in Source or Object
42-
form, that is based on (or derived from) the Work and for which the
43-
editorial revisions, annotations, elaborations, or other modifications
44-
represent, as a whole, an original work of authorship. For the purposes
45-
of this License, Derivative Works shall not include works that remain
46-
separable from, or merely link (or bind by name) to the interfaces of,
47-
the Work and Derivative Works thereof.
48-
49-
"Contribution" shall mean any work of authorship, including
50-
the original version of the Work and any modifications or additions
51-
to that Work or Derivative Works thereof, that is intentionally
52-
submitted to Licensor for inclusion in the Work by the copyright owner
53-
or by an individual or Legal Entity authorized to submit on behalf of
54-
the copyright owner. For the purposes of this definition, "submitted"
55-
means any form of electronic, verbal, or written communication sent
56-
to the Licensor or its representatives, including but not limited to
57-
communication on electronic mailing lists, source code control systems,
58-
and issue tracking systems that are managed by, or on behalf of, the
59-
Licensor for the purpose of discussing and improving the Work, but
60-
excluding communication that is conspicuously marked or otherwise
61-
designated in writing by the copyright owner as "Not a Contribution."
62-
63-
"Contributor" shall mean Licensor and any individual or Legal Entity
64-
on behalf of whom a Contribution has been received by Licensor and
65-
subsequently incorporated within the Work.
66-
67-
2. Grant of Copyright License. Subject to the terms and conditions of
68-
this License, each Contributor hereby grants to You a perpetual,
69-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70-
copyright license to reproduce, prepare Derivative Works of,
71-
publicly display, publicly perform, sublicense, and distribute the
72-
Work and such Derivative Works in Source or Object form.
73-
74-
3. Grant of Patent License. Subject to the terms and conditions of
75-
this License, each Contributor hereby grants to You a perpetual,
76-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77-
(except as stated in this section) patent license to make, have made,
78-
use, offer to sell, sell, import, and otherwise transfer the Work,
79-
where such license applies only to those patent claims licensable
80-
by such Contributor that are necessarily infringed by their
81-
Contribution(s) alone or by combination of their Contribution(s)
82-
with the Work to which such Contribution(s) was submitted. If You
83-
institute patent litigation against any entity (including a
84-
cross-claim or counterclaim in a lawsuit) alleging that the Work
85-
or a Contribution incorporated within the Work constitutes direct
86-
or contributory patent infringement, then any patent licenses
87-
granted to You under this License for that Work shall terminate
88-
as of the date such litigation is filed.
89-
90-
4. Redistribution. You may reproduce and distribute copies of the
91-
Work or Derivative Works thereof in any medium, with or without
92-
modifications, and in Source or Object form, provided that You
93-
meet the following conditions:
94-
95-
(a) You must give any other recipients of the Work or
96-
Derivative Works a copy of this License; and
97-
98-
(b) You must cause any modified files to carry prominent notices
99-
stating that You changed the files; and
100-
101-
(c) You must retain, in the Source form of any Derivative Works
102-
that You distribute, all copyright, patent, trademark, and
103-
attribution notices from the Source form of the Work,
104-
excluding those notices that do not pertain to any part of
105-
the Derivative Works; and
106-
107-
(d) If the Work includes a "NOTICE" text file as part of its
108-
distribution, then any Derivative Works that You distribute must
109-
include a readable copy of the attribution notices contained
110-
within such NOTICE file, excluding those notices that do not
111-
pertain to any part of the Derivative Works, in at least one
112-
of the following places: within a NOTICE text file distributed
113-
as part of the Derivative Works; within the Source form or
114-
documentation, if provided along with the Derivative Works; or,
115-
within a display generated by the Derivative Works, if and
116-
wherever such third-party notices normally appear. The contents
117-
of the NOTICE file are for informational purposes only and
118-
do not modify the License. You may add Your own attribution
119-
notices within Derivative Works that You distribute, alongside
120-
or as an addendum to the NOTICE text from the Work, provided
121-
that such additional attribution notices cannot be construed
122-
as modifying the License.
123-
124-
You may add Your own copyright statement to Your modifications and
125-
may provide additional or different license terms and conditions
126-
for use, reproduction, or distribution of Your modifications, or
127-
for any such Derivative Works as a whole, provided Your use,
128-
reproduction, and distribution of the Work otherwise complies with
129-
the conditions stated in this License.
130-
131-
5. Submission of Contributions. Unless You explicitly state otherwise,
132-
any Contribution intentionally submitted for inclusion in the Work
133-
by You to the Licensor shall be under the terms and conditions of
134-
this License, without any additional terms or conditions.
135-
Notwithstanding the above, nothing herein shall supersede or modify
136-
the terms of any separate license agreement you may have executed
137-
with Licensor regarding such Contributions.
138-
139-
6. Trademarks. This License does not grant permission to use the trade
140-
names, trademarks, service marks, or product names of the Licensor,
141-
except as required for reasonable and customary use in describing the
142-
origin of the Work and reproducing the content of the NOTICE file.
143-
144-
7. Disclaimer of Warranty. Unless required by applicable law or
145-
agreed to in writing, Licensor provides the Work (and each
146-
Contributor provides its Contributions) on an "AS IS" BASIS,
147-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148-
implied, including, without limitation, any warranties or conditions
149-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150-
PARTICULAR PURPOSE. You are solely responsible for determining the
151-
appropriateness of using or redistributing the Work and assume any
152-
risks associated with Your exercise of permissions under this License.
153-
154-
8. Limitation of Liability. In no event and under no legal theory,
155-
whether in tort (including negligence), contract, or otherwise,
156-
unless required by applicable law (such as deliberate and grossly
157-
negligent acts) or agreed to in writing, shall any Contributor be
158-
liable to You for damages, including any direct, indirect, special,
159-
incidental, or consequential damages of any character arising as a
160-
result of this License or out of the use or inability to use the
161-
Work (including but not limited to damages for loss of goodwill,
162-
work stoppage, computer failure or malfunction, or any and all
163-
other commercial damages or losses), even if such Contributor
164-
has been advised of the possibility of such damages.
165-
166-
9. Accepting Warranty or Additional Liability. While redistributing
167-
the Work or Derivative Works thereof, You may choose to offer,
168-
and charge a fee for, acceptance of support, warranty, indemnity,
169-
or other liability obligations and/or rights consistent with this
170-
License. However, in accepting such obligations, You may act only
171-
on Your own behalf and on Your sole responsibility, not on behalf
172-
of any other Contributor, and only if You agree to indemnify,
173-
defend, and hold each Contributor harmless for any liability
174-
incurred by, or claims asserted against, such Contributor by reason
175-
of your accepting any such warranty or additional liability.
176-
177-
END OF TERMS AND CONDITIONS
178-
179-
APPENDIX: How to apply the Apache License to your work.
180-
181-
To apply the Apache License to your work, attach the following
182-
boilerplate notice, with the fields enclosed by brackets "[]"
183-
replaced with your own identifying information. (Don't include
184-
the brackets!) The text should be enclosed in the appropriate
185-
comment syntax for the file format. We also recommend that a
186-
file or class name and description of purpose be included on the
187-
same "printed page" as the copyright notice for easier
188-
identification within third-party archives.
189-
190-
Copyright [yyyy] [name of copyright owner]
191-
192-
Licensed under the Apache License, Version 2.0 (the "License");
193-
you may not use this file except in compliance with the License.
194-
You may obtain a copy of the License at
195-
196-
http://www.apache.org/licenses/LICENSE-2.0
197-
198-
Unless required by applicable law or agreed to in writing, software
199-
distributed under the License is distributed on an "AS IS" BASIS,
200-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201-
See the License for the specific language governing permissions and
202-
limitations under the License.
30+
All submissions, including submissions by project members, require review. We
31+
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
32+
for this purpose.

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,33 @@
22

33
This Gemini CLI extension provides a set of tools to interact with [Cloud SQL for SQL Server](https://cloud.google.com/sql/docs/sqlserver) instances. It allows you to manage your databases, execute queries, and explore schemas directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
44

5-
## Features
5+
## Why Use the Cloud SQL for SQL Server Extension?
66

7-
* **Integrated with Gemini CLI:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment, making security an accessible part of your workflow.
8-
* **Connect to Cloud SQL for SQL Server:** Securely connect to your Cloud SQL for SQL Server instances.
9-
* **Explore Database Schema:** List databases, tables, views, and schemas.
10-
* **Query your Database:** Execute SQL queries against your database.
11-
12-
## Supported Tools
13-
14-
* `list_tables`
15-
* `execute_sql`
7+
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
8+
* **Seamless Workflow:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
9+
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
1610

1711
## Prerequisites
1812

1913
Before you begin, ensure you have the following:
2014

2115
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed.
2216
* A Google Cloud project with the **Cloud SQL Admin API** enabled.
23-
* IAM Permissions
17+
* IAM Permissions:
18+
* Cloud SQL Client (`roles/cloudsql.client`)
2419

2520
## Installation
2621

27-
To install the extension, use the `gemini extensions install` command:
22+
To install the extension, use the command:
2823

2924
```bash
30-
gemini extensions install github.com/gemini-cli-extensions/cloud-sql-sqlserver.git
25+
gemini extensions install github.com/gemini-cli-extensions/cloud-sql-sqlserver
3126
```
3227

3328
## Configuration
3429

30+
Set the following environment variables before starting the Gemini CLI:
31+
3532
* `CLOUD_SQL_MSSQL_PROJECT`: The GCP project ID.
3633
* `CLOUD_SQL_MSSQL_REGION`: The region of your Cloud SQL instance.
3734
* `CLOUD_SQL_MSSQL_INSTANCE`: The ID of your Cloud SQL instance.
@@ -40,16 +37,26 @@ gemini extensions install github.com/gemini-cli-extensions/cloud-sql-sqlserver.g
4037
* `CLOUD_SQL_MSSQL_USER`: The database username.
4138
* `CLOUD_SQL_MSSQL_PASSWORD`: The password for the database user.
4239

43-
## Usage
40+
## Usage Examples
41+
42+
Interact with Cloud SQL for SQL Server using natural language right from your IDE:
43+
44+
* **Explore Schemas and Data:**
45+
* "Show me all tables in the 'orders' database."
46+
* "What are the columns in the 'products' table?"
47+
* "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
48+
* **Generate Code:**
49+
* "Generate a Python dataclass to represent the 'customers' table."
50+
51+
## Supported Tools
4452

45-
* Provision Infrastructure
46-
* Explore Schemas and Data
47-
* Generate code
53+
* `list-tables`: Use this tool to list tables and descriptions.
54+
* `execute-sql`: Use this tool to execute any SQL statement.
4855

49-
## Security
56+
## Additional Extensions
5057

51-
This extension executes commands against your Cloud SQL for SQL Server database. Always review the generated SQL queries before execution, especially for write operations.
58+
Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions).
5259

53-
## Disclaimer
60+
## Troubleshooting
5461

55-
This is not an officially supported Google product. This extension is under active development, and breaking changes may be introduced.
62+
* "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.

gemini-extension.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "Cloud SQL for SQL Server",
2+
"name": "cloud-sql-sqlserver",
33
"version": "0.1.0",
44
"description": "Connect to Cloud SQL for SQL Server",
55
"mcpServers": {

0 commit comments

Comments
 (0)