From 341c4c307be4546fbe56febb9090ba0c35a73050 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Fri, 26 Sep 2025 14:44:19 -0700 Subject: [PATCH 1/2] docs: update readme getting started instructions --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index de0f815..860cf89 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,9 @@ Before you begin, ensure you have the following: * BigQuery User (`roles/bigquery.user`) (for executing queries and view metadata) * Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API) -## Installation +## Getting Started + +### Installation To install the extension, use the command: @@ -31,7 +33,7 @@ To install the extension, use the command: gemini extensions install https://github.com/gemini-cli-extensions/bigquery-conversational-analytics ``` -## Configuration +### Configuration Set the following environment variables before starting the Gemini CLI: @@ -41,25 +43,37 @@ Set the following environment variables before starting the Gemini CLI: Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. -## **Usage Examples** +### Start Gemini CLI + +To start the Gemini CLI, use the following command: + +```bash +gemini +``` + +## Usage Examples Interact with BigQuery using natural language right from your IDE: -* **Ask for insights** +* Ask for insights * Using the tables under bigquery-public-data.google\_analytics\_sample , tell me the channels I should focus on and why? -## **Supported Tools** +## Supported Tools This extension provides a comprehensive set of tools: -* `ask_data_insights`: Executes a SQL query. +* `ask_data_insights`: Perform data analysis, get insights, or answer complex questions about the contents of specific BigQuery tables. * `search_catalog`: Find BigQuery tables relevant to users, natural language query. ## Additional Extensions -Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions). +Find additional extensions to support your entire software development lifecycle at [github.com/gemini-cli-extensions](https://github.com/gemini-cli-extensions), including: +* [BigQuery Data Analytics](https://github.com/gemini-cli-extensions/bigquery-data-analytics) +* 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//.gemini/extensions/cloud-sql-sqlserver/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. \ No newline at end of file From 8449627db72c1c86476e61584793691b84822b74 Mon Sep 17 00:00:00 2001 From: Averi Kitsch Date: Tue, 30 Sep 2025 08:30:33 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 860cf89..7e63d0c 100644 --- a/README.md +++ b/README.md @@ -75,5 +75,5 @@ Find additional extensions to support your entire software development lifecycle ## Troubleshooting * "✖ 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//.gemini/extensions/cloud-sql-sqlserver/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+. +* "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/bigquery-conversational-analytics/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. \ No newline at end of file