chore: Add initial docs

Author: duwenxin99

CLOUD-SQL-POSTGRESQL.md

@@ -0,0 +1,20 @@
+# Cloud SQL for PostgreSQL Extension
+
+This document provides instructions for the Gemini agent to assist users with the Cloud SQL for PostgreSQL extension.
+
+## Cloud SQL for PostgreSQL MCP Server (Data Plane: Connecting and Querying)
+
+This section covers connecting to a Cloud SQL for PostgreSQL instance.
+
+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.
+
+    *   `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
+    *   `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance.
+    *   `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance.
+    *   `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to.
+    *   `CLOUD_SQL_POSTGRES_USER`: The database username.
+    *   `CLOUD_SQL_POSTGRES_PASSWORD`: The password for the database user.
+
+2.  **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${CLOUD_SQL_POSTGRES_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
+
+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.

README.md

@@ -0,0 +1,66 @@
+# Gemini CLI Extension - Cloud SQL for PostgreSQL
+
+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, and explore schemas directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
+
+## Features
+
+*   **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.
+*   **Connect to Cloud SQL for PostgreSQL:** Securely connect to your Cloud SQL for PostgreSQL instances.
+*   **Explore Database Schema:** List databases, tables, views, and schemas.
+*   **Query your Database:** Execute SQL queries against your database.
+
+## Supported Tools
+
+🟢 list-tables: Use this tool to list tables and descriptions.
+🟢 execute-sql: Use this tool to execute any SQL statement.
+🚧 cloudsql-wait-for-operation: Polls the operations API until an operation is complete.
+🚧 cloudsql-user-create: Use this tool to create a new user for a Cloud SQL instance.
+🚧 cloudsql-database-list: Use this tool to list databases within a Cloud SQL instance.
+🚧 cloudsql-database-create: Use this tool to create a new database within a Cloud SQL instance.
+🚧 cloudsql-instance-list: Use this tool to list Cloud SQL instances in a given project and location.
+🚧 cloudsql-instance-get: Use this tool to get details about a specific Cloud SQL instance.
+🚧 cloudsql-instance-create: Use this tool to create (insert) a new Cloud SQL instance.
+🔜 csql-postgresql-system-metrics: Use this tool to retrieve system metrics for a Cloud SQL for PostgreSQL instance.
+🔜 csql-postgresql-query-metrics: Use this tool to retrieve query-related metrics for a Cloud SQL for PostgreSQL instance.
+
+## Prerequisites
+
+Before you begin, ensure you have the following:
+
+*   [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed.
+*   A Google Cloud project with the **Cloud SQL Admin API** enabled.
+*   IAM Permissions
+
+## Installation
+
+To install the extension, use the `gemini extensions install` command:
+
+```bash
+gemini extensions install github.com/gemini-cli-extensions/cloud-sql-postgresql.git
+```
+
+## Configuration
+
+*   `CLOUD_SQL_POSTGRES_PROJECT`: The GCP project ID.
+*   `CLOUD_SQL_POSTGRES_REGION`: The region of your Cloud SQL instance.
+*   `CLOUD_SQL_POSTGRES_INSTANCE`: The ID of your Cloud SQL instance.
+*   `CLOUD_SQL_POSTGRES_DATABASE`: The name of the database to connect to.
+*   `CLOUD_SQL_POSTGRES_USER`: (Optional) The database username.
+*   `CLOUD_SQL_POSTGRES_PASSWORD`: (Optional) The password for the database user.
+*   `CLOUD_SQL_POSTGRES_IP_TYPE`: (Optional) The IP Type.
+
+
+## Usage
+
+* Provision Infrastructure
+* Explore Schemas and Data
+* Generate code
+
+
+## Security
+
+This extension executes commands against your Cloud SQL for PostgreSQL database. Always review the generated SQL queries before execution, especially for write operations.
+
+## Disclaimer
+
+This is not an officially supported Google product. This extension is under active development, and breaking changes may be introduced.

gemini-extension.json

@@ -0,0 +1,22 @@
+{
+  "name": "Cloud SQL for PostgreSQL",
+  "version": "0.1.0",
+  "description": "Create, connect, and interact with a Cloud SQL for PostgreSQL database and data.",
+  "mcpServers": {
+    "Cloud SQL for PostgreSQL": {
+      "command": "${extensionPath}${/}toolbox",
+      "args": [
+        "--prebuilt",
+        "cloud-sql-postgres",
+        "--stdio"
+      ],
+      "env": {
+        "CLOUD_SQL_POSTGRESQL_PROJECT": "${CLOUD_SQL_POSTGRESQL_PROJECT}",
+        "CLOUD_SQL_POSTGRESQL_REGION": "${CLOUD_SQL_POSTGRESQL_REGION}",
+        "CLOUD_SQL_POSTGRESQL_INSTANCE": "${CLOUD_SQL_POSTGRESQL_INSTANCE}",
+        "CLOUD_SQL_POSTGRESQL_DATABASE": "${CLOUD_SQL_POSTGRESQL_DATABASE}"
+      }
+    }
+  },
+  "contextFileName": "CLOUD-SQL-POSTGRESQL.md"
+}