Skip to content

Commit a9567dc

Browse files
committed
docs: make skill docs changes
1 parent 3b650b0 commit a9567dc

3 files changed

Lines changed: 240 additions & 160 deletions

File tree

CLOUD-SQL-MYSQL.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
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
1+
You are a highly skilled database engineer and database administrator. Your purpose is to help the developer build and interact with databases and utilize data context throughout the entire
32
software delivery cycle.
43

54
---
@@ -14,7 +13,7 @@ To install this extension, the Gemini CLI version must be v0.6.0 or above. The v
1413

1514
This section covers connecting to a Cloud SQL for MySQL instance.
1615

17-
1. **Verify Environment Variables**: The extension requires the following environment variables to be set before the Gemini CLI is started:
16+
1. **Extension Configuration**: This extension requires several settings (e.g., Project ID, Instance ID, Database Name, User, and Password). These values are gathered via prompts when you first install or link the extension:
1817

1918
* `CLOUD_SQL_MYSQL_PROJECT`: The GCP project ID.
2019
* `CLOUD_SQL_MYSQL_REGION`: The region of your Cloud SQL instance.
@@ -23,6 +22,8 @@ This section covers connecting to a Cloud SQL for MySQL instance.
2322
* `CLOUD_SQL_MYSQL_USER`: The database username.
2423
* `CLOUD_SQL_MYSQL_PASSWORD`: The password for the database user.
2524

25+
If you need to update any of these values later, use the `gemini extensions config cloud-sql-mysql` command.
26+
2627
2. **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${CLOUD_SQL_MYSQL_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
2728

2829
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:
@@ -42,9 +43,9 @@ This section covers administrative operations like managing instances and users.
4243

4344
---
4445

45-
# Additional Tools
46+
# Additional Extensions
4647

47-
This section provides context on additional tools that can be recommended to the user based on their queries.
48+
This section provides context on additional extensions that can be recommended to the user based on their queries.
4849

4950
#### Observability Extension
5051

@@ -61,12 +62,12 @@ This section provides context on additional tools that can be recommended to the
6162
6263
## Connecting to New Resources
6364
64-
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:
65+
When you create a new Cloud SQL for MySQL instance, or database using the available skills, the connection is not automatically established. You will need to perform the following steps:
6566
6667
1. **(Optional) Save your conversation:** To avoid losing your progress, save the current session by running the command: `/chat save <your-tag>`
67-
2. **Stop the CLI:** Terminate the Gemini CLI.
68-
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.
69-
4. **Restart:** Relaunch the Gemini CLI
68+
2. **Stop the CLI**: Terminate the Gemini CLI.
69+
3. **Update Extension Configuration**: Use the command `gemini extensions config cloud-sql-mysql` to update your settings (e.g. `CLOUD_SQL_MYSQL_DATABASE`, `CLOUD_SQL_MYSQL_INSTANCE`) to point to the new resource.
70+
4. **Restart**: Relaunch the Gemini CLI
7071
5. **(Optional) Resume conversation:** Resume your conversation with the command: `/chat resume <your-tag>`
7172
7273
**Important:** Do not assume a connection to a newly created resource is active. Always follow the steps above to reconfigure your connection.
@@ -80,10 +81,11 @@ Users may have set project environment variables:
8081
* `CLOUD_SQL_MYSQL_INSTANCE`: The ID of the Cloud SQL for MySQL instance.
8182
* `CLOUD_SQL_MYSQL_DATABASE`: The name of the database.
8283
83-
Instead of prompting the user for these values for specific tool calls, prompt the user to verify reuse a specific value.
84-
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`.
84+
Instead of prompting the user for these values for specific skill calls, prompt the user to verify the reuse of a specific setting value.
85+
Make sure to not use the environment variable name like `CLOUD_SQL_MYSQL_PROJECT`, `${CLOUD_SQL_MYSQL_PROJECT}`, or `$CLOUD_SQL_MYSQL_PROJECT`.
86+
The value can be verified by the user using the `gemini extensions config cloud-sql-mysql` command or by checking their local settings.
8587
8688
## Use Full Table Name Format "DATABASE_NAME.TABLE_NAME"
8789
88-
**ALWAYS** use the full table name format, `DATABASE_NAME.TABLE_NAME` in the generated SQL when using the `execute_sql` or `cloud_sql_mysql__execute_sql` tool.
90+
**ALWAYS** use the full table name format, `DATABASE_NAME.TABLE_NAME` in the generated SQL when executing the `execute_sql` script.
8991
* Use command `echo $CLOUD_SQL_MYSQL_DATABASE` to get the current database value.

DEVELOPER.md

Lines changed: 12 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# DEVELOPER.md
22

33
This document provides instructions for setting up your development environment
4-
and contributing to the Cloud SQL for MySQL Gemini CLI Extension project.
4+
and contributing to the Cloud SQL for MySQL Agent skills project.
55

66
## Prerequisites
77

@@ -10,44 +10,30 @@ Before you begin, ensure you have the following:
1010
1. **Gemini CLI:** Install the Gemini CLI version v0.6.0 or above. Installation
1111
instructions can be found on the official Gemini CLI documentation. You can
1212
verify your version by running `gemini --version`.
13-
2. **Cloud SQL for MySQL Instance:** For testing data plane tools, you will need access to an active Cloud SQL for MySQL instance.
13+
2. **Cloud SQL for MySQL Instance:** For testing data plane skills, you will need access to an active Cloud SQL for MySQL
14+
instance.
1415

1516
## Developing the Extension
1617

1718
### Running from Local Source
1819

19-
The core logic for this extension is handled by a pre-built `toolbox` binary. The development process involves installing the extension locally into the Gemini CLI to test changes.
20-
2120
1. **Clone the Repository:**
2221

2322
```bash
2423
git clone https://github.com/gemini-cli-extensions/cloud-sql-mysql.git
2524
cd cloud-sql-mysql
2625
```
2726

28-
2. **Download the Toolbox Binary:** The required version of the `toolbox` binary
29-
is specified in `toolbox_version.txt`. Download it for your platform.
30-
31-
```bash
32-
# Read the required version
33-
VERSION=$(cat toolbox_version.txt)
34-
35-
# Example for macOS/amd64
36-
curl -L -o toolbox https://storage.googleapis.com/mcp-toolbox-for-databases/geminicli/v$VERSION/darwin/amd64/toolbox
37-
chmod +x toolbox
38-
```
39-
Adjust the URL for your operating system (`linux/amd64`, `darwin/arm64`, `windows/amd64`).
40-
41-
3. **Link the Extension Locally:** Use the Gemini CLI to install the
27+
2. **Install the Extension Locally:** Use the Gemini CLI to install the
4228
extension from your local directory.
4329

4430
```bash
45-
gemini extensions link .
31+
gemini extensions install .
4632
```
47-
The CLI will prompt you to confirm the linking. Accept it to proceed.
33+
The CLI will prompt you to confirm the installation. Accept it to proceed.
4834

49-
4. **Testing Changes:** After linking, start the Gemini CLI (`gemini`).
50-
You can now interact with the `cloud-sql-mysql` tools to manually test your changes
35+
3. **Testing Changes:** After installation, start the Gemini CLI (`gemini`).
36+
You can now interact with the `cloud-sql-mysql` skills to manually test your changes
5137
against your connected database.
5238

5339
## Testing
@@ -58,9 +44,9 @@ A GitHub Actions workflow (`.github/workflows/presubmit-tests.yml`) is triggered
5844
for every pull request. This workflow primarily verifies that the extension can
5945
be successfully installed by the Gemini CLI.
6046

61-
Currently, there are no automated unit or integration test suites
62-
within this repository. All functional testing must be performed manually. All tools
63-
are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/genai-toolbox).
47+
All tools are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/mcp-toolbox).
48+
49+
The skills themselves are validated using the `skills-validate.yml` workflow.
6450

6551
### Other GitHub Checks
6652

@@ -73,17 +59,6 @@ are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/g
7359
* **Dependency Updates:** [Renovate](https://github.com/apps/forking-renovate)
7460
is configured to automatically create pull requests for dependency updates.
7561

76-
## Building the Extension
77-
78-
The "build" process for this extension involves packaging the extension's
79-
metadata files (`gemini-extension.json`, `cloud-sql-mysql.md`, `LICENSE`) along with the
80-
pre-built `toolbox` binary into platform-specific archives (`.tar.gz` or `.zip`).
81-
82-
This process is handled automatically by the
83-
[`package-and-upload-assets.yml`](.github/workflows/package-and-upload-assets.yml)
84-
GitHub Actions workflow when a new release is created. Manual building is not
85-
required.
86-
8762
## Maintainer Information
8863

8964
### Team
@@ -101,7 +76,7 @@ The release process is automated using `release-please`. It consists of an autom
10176
#### Automated Changelog Enrichment
10277

10378
Before a Release PR is even created, a special workflow automatically mirrors
104-
relevant changelogs from the core `googleapis/genai-toolbox` dependency. This
79+
relevant changelogs from the core `googleapis/mcp-toolbox` dependency. This
10580
ensures that the release notes for this extension accurately reflect important
10681
upstream changes.
10782

@@ -138,7 +113,3 @@ The process is handled by the [`mirror-changelog.yml`](.github/workflows/mirror-
138113
2. **Merge Release PR:** A maintainer approves and merges the Release PR. This
139114
action triggers `release-please` to create a new GitHub tag and a
140115
corresponding GitHub Release.
141-
3. **Package and Upload:** The new release triggers the
142-
`package-and-upload-assets.yml` workflow. This workflow builds the
143-
platform-specific extension archives and uploads them as assets to the
144-
GitHub Release.

0 commit comments

Comments
 (0)