Merge branch 'main' into pr-title-lint

twishabansal · web-flow · commit cee26c1291c8 · 2025-10-10T00:28:30.000+05:30
diff --git a/.github/renovate.json5 b/.github/renovate.json5
@@ -0,0 +1,34 @@
+{
+  extends: [
+    'config:recommended',
+    ':semanticCommitTypeAll(chore)',
+    ':ignoreUnstable',
+    ':separateMajorReleases',
+    ':prConcurrentLimitNone',
+    ':prHourlyLimitNone',
+    ':preserveSemverRanges',
+  ],
+  rebaseWhen: 'conflicted',
+  dependencyDashboardLabels: [
+    'type: process',
+  ],
+  packageRules: [
+    {
+      groupName: 'GitHub Actions',
+      matchManagers: [
+        'github-actions',
+      ],
+      pinDigests: true,
+    },
+  ],
+  customManagers: [
+    {
+      customType: "regex",
+      managerFilePatterns: ["/toolbox_version\\.txt$/"],
+      matchStrings: ["(?<currentValue>[\\d\\.]+)"],
+      datasourceTemplate: "github-releases",
+      packageNameTemplate: "googleapis/genai-toolbox",
+      extractVersionTemplate: "^v(?<version>.*)$",
+    }
+  ]
+}
diff --git a/.github/workflows/json-lint.yml b/.github/workflows/json-lint.yml
@@ -0,0 +1,29 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Lint JSON
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  json-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Run JSON Lint
+        run: jq . gemini-extension.json
diff --git a/.github/workflows/markdown-checks.yml b/.github/workflows/markdown-checks.yml
@@ -0,0 +1,33 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Lint Markdown
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  link-check:
+    name: Run link check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@885c65f3dc543b57c898c8099f4e08c8afd178a2 # v2.6.1
+        with:
+          # There is no security token. So, it would fail on any links which aren't public.
+          args: "--verbose --no-progress **/*.md"
diff --git a/.github/workflows/package-and-upload-assets.yml b/.github/workflows/package-and-upload-assets.yml
@@ -39,7 +39,7 @@ jobs:
     
     steps:
       - name: Checkout code at the new tag
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
         with:
           ref: ${{ github.event.release.tag_name }}
 
@@ -102,7 +102,7 @@ jobs:
           echo "ARCHIVE_PATH=${ARCHIVE_NAME}" >> $GITHUB_OUTPUT
 
       - name: Upload archive as workflow artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
         with:
           name: ${{ steps.vars.outputs.archive_name }}
           path: ${{ steps.create_archive.outputs.ARCHIVE_PATH }}
@@ -116,10 +116,10 @@ jobs:
       contents: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
 
       - name: Download all archives from workflow artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
         with:
           path: release-archives
 
diff --git a/.github/workflows/presubmit-tests.yml b/.github/workflows/presubmit-tests.yml
@@ -0,0 +1,37 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+name: Presubmit Tests
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  run-presubmit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Install Gemini CLI
+        run: npm install @google/gemini-cli
+
+      - name: Install toolbox binary
+        run: |
+          VERSION=$(cat toolbox_version.txt)
+          curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v$VERSION/linux/amd64/toolbox
+          chmod +x toolbox
+
+      - name: Install Extension
+        run: yes | npx gemini extensions install --path=.
diff --git a/.lycheeignore b/.lycheeignore
@@ -0,0 +1 @@
+https://github.com/gemini-cli-extensions/cloud-sql-postgresql/compare/
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0"
+  ".": "0.1.1"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.1.1](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/compare/0.1.0...0.1.1) (2025-09-30)
+
+
+### Features
+
+* additional instructions for the context file ([#30](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/issues/30)) ([9c87df1](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/commit/9c87df1f1959686bf1efa863f463fa4e39882fe2))
+* standardize mcp server names ([#27](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/issues/27)) ([eeeaf81](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/commit/eeeaf813b802491e183a21fbfa23b2f684bda032))
+* update context file to recommend observability extension ([#17](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/issues/17)) ([f4f7069](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/commit/f4f7069a41dabfb995bf1728ed4e0a710cc0425e))
+* update context file to use full table name ([#31](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/issues/31)) ([533a2f3](https://github.com/gemini-cli-extensions/cloud-sql-postgresql/commit/533a2f388fbf5b21484da904e46247d10cc43746))
+
+
 ## 0.1.0 (2025-09-20)
 
 
diff --git a/CLOUD-SQL-POSTGRESQL.md b/CLOUD-SQL-POSTGRESQL.md
@@ -1,10 +1,14 @@
 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
 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 PostgreSQL MCP Server (Data Plane: Connecting and Querying)
 
 This section covers connecting to a Cloud SQL for PostgreSQL instance.
@@ -30,5 +34,54 @@ This section covers administrative operations like managing clusters, instances,
     * For operations that create, get, list, delete, or update resources, the user needs the **Cloud SQL Admin** (`roles/cloudsql.admin`) role.
     * For read-only operations (get/list), the **Cloud SQL Viewer** (`roles/cloudsql.viewer`) role is sufficient.
     * If an operation fails due to permissions, identify the type of operation and recommend the appropriate role. You can provide these links for assistance:
-        * Granting Roles: <https://cloud.google.com/iam/docs/grant-role-console>
-        * Cloud SQL Permissions: <https://cloud.google.com/sql/docs/postgres/iam-permissions>
+        * Granting Roles: https://cloud.google.com/iam/docs/grant-role-console
+        * Cloud SQL Permissions: https://cloud.google.com/sql/docs/postgres/iam-permissions
+
+---
+
+# Additional Tools
+
+This section provides context on additional tools that can be recommended to the user based on their queries.
+
+#### Observability Extension
+
+*   **When to recommend:** If the user asks questions related to monitoring, performance, or observability of Cloud SQL for PostgreSQL databases.
+*   **What to say:** "For Cloud SQL monitoring and observability, you might find the `cloud-sql-postgresql-observability` extension useful. You can install it with the following command:"
+*   **Command:**
+    ```
+    gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-postgresql-observability
+    ```
+
+---
+
+# Usage Guidelines
+
+## Connecting to New Resources
+
+When you create a new Cloud SQL for PostgreSQL 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 <your-tag>`
+2.  **Stop the CLI:** Terminate the Gemini CLI.
+3.  **Update Environment Variables:** Set or update your environment variables (e.g. `CLOUD_SQL_POSTGRES_DATABASE`, `CLOUD_SQL_POSTGRES_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 <your-tag>`
+
+**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_POSTGRES_PROJECT`: The GCP project ID.
+*   `CLOUD_SQL_POSTGRES_REGION`: The region of the Cloud SQL for PostgreSQL instance.
+*   `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of the Cloud SQL for PostgreSQL instance.
+*   `CLOUD_SQL_POSTGRES_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_POSTGRES_PROJECT`, `${CLOUD_SQL_POSTGRES_PROJECT}`, or `$CLOUD_SQL_POSTGRES_PROJECT`. The value can be found by using command: `echo $CLOUD_SQL_POSTGRES_PROJECT`.
+
+## Use Full Table Name Format "DATABASE_NAME.SCHEMA_NAME.TABLE_NAME"
+
+**ALWAYS** use the full table name format, `DATABASE_NAME.SCHEMA_NAME.TABLE_NAME` in the generated SQL when using the `execute_sql` or `cloud_sql_postgresql__execute_sql` tool.
+* Default to using "public" for the schema name.
+* Use command `echo $CLOUD_SQL_POSTGRES_DATABASE` to get the current database value.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 This Gemini CLI extension provides a set of tools to interact with [Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres) instances. It allows you to manage your databases, execute queries, explore schemas, and troubleshoot issues directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
 
-Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extension.md).
+Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
 
 ## Why Use the Cloud SQL for PostgreSQL Extension?
 
@@ -24,15 +24,17 @@ Before you begin, ensure you have the following:
   * Cloud SQL Client (`roles/cloudsql.client`)
   * Cloud SQL Admin (`roles/cloudsql.admin`)
 
-## Installation
+## Getting Started
+
+### Installation
 
 To install the extension, use the command:
 
 ```bash
 gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-postgresql
 ```
 
-## Configuration
+### Configuration
 
 Set the following environment variables before starting the Gemini CLI.
 This configuration is not required if utilizing the [Admin toolset](#supported-tools).
@@ -48,13 +50,26 @@ This configuration is not required if utilizing the [Admin toolset](#supported-t
 Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
 
 > [!NOTE]
-> When using private IPs with Cloud SQL for PostgreSQL, you must use a Virtual Private Cloud (VPC) network.
+> If your Cloud SQL for PostgreSQL instance uses private IPs, you must run Gemini CLI in the same Virtual Private Cloud (VPC) network.
+
+### Start Gemini CLI
+
+To start the Gemini CLI, use the following command:
+
+```bash
+gemini
+```
+
+> [!WARNING]
+> **Changing Instance & Database Connections**
+> Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session.
+> To save and resume conversation history use command: `/chat save <tag>` and `/chat resume <tag>`.
 
 ## Usage Examples
 
 Interact with Cloud SQL for PostgreSQL using natural language:
 
-*   **Provision Infrastructure:**
+* **Provision Infrastructure:**
     * "Create a new CLoud SQL for Postgres instance named 'e-commerce-prod' in the 'my-gcp-project' project."
     * "Create a new user named 'analyst' with read access to all tables."
 * **Explore Schemas and Data:**
@@ -69,10 +84,10 @@ Interact with Cloud SQL for PostgreSQL using natural language:
 *   **Admin:**
    	* `create_instance`: Use this tool to create an Postgres instance.
    	* `create_user`: Use this tool to create Postgres-BUILT-IN or IAM-based users.
+    * `create_database`: Creates a new database in a Cloud SQL instance.
    	* `get_instance`: Use this tool to get details about an Postgres instance.
-   	* `get_user`: Use this tool to get details about a user.
    	* `list_instances`: Use this tool to list instances in a given project and location.
-   	* `list_users`: Use this tool to list users in a given project and location.
+    * `list_databases`: Lists all databases for a Cloud SQL instance.
     * `wait_for_operation`: Use this tool to poll the operations API until the operation is done.
 
 *   **Data:**
@@ -90,8 +105,13 @@ Interact with Cloud SQL for PostgreSQL using natural language:
 
 ## Additional Extensions
 
-Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including a generic [PostgreSQL extension](https://github.com/gemini-cli-extensions/postgres).
+Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including:
+* [Generic PostgreSQL extension](https://github.com/gemini-cli-extensions/postgres)
+* [Cloud SQL for PostgreSQL Observability extension](https://github.com/gemini-cli-extensions/cloud-sql-postgresql-observability)
+* and more!
 
 ## Troubleshooting
 
-* "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.
+* "✖ 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.
+* "✖ MCP ERROR: Error: spawn /Users/<USER>/.gemini/extensions/cloud-sql-postgresql/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
+* "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.
diff --git a/gemini-extension.json b/gemini-extension.json
@@ -1,17 +1,17 @@
 {
   "name": "cloud-sql-postgresql",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Create, connect, and interact with a Cloud SQL for PostgreSQL database and data.",
   "mcpServers": {
-    "Cloud SQL for PostgreSQL Admin": {
+    "cloud_sql_postgresql_admin": {
       "command": "${extensionPath}${/}toolbox",
       "args": [
         "--prebuilt",
         "cloud-sql-postgres-admin",
         "--stdio"
       ]
     },
-    "Cloud SQL for PostgreSQL": {
+    "cloud_sql_postgresql": {
       "command": "${extensionPath}${/}toolbox",
       "args": [
         "--prebuilt",
@@ -27,4 +27,4 @@
     }
   },
   "contextFileName": "CLOUD-SQL-POSTGRESQL.md"
-}
+}
diff --git a/release-please-config.json b/release-please-config.json
diff --git a/toolbox_version.txt b/toolbox_version.txt

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+https://github.com/gemini-cli-extensions/cloud-sql-postgresql/compare/`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.1.0"`
	`2`	`+ ".": "0.1.1"`
`3`	`3`	`}`