Skip to content

Commit 96f904b

Browse files
committed
docs: update terminology from tools to skills
1 parent cdb122a commit 96f904b

3 files changed

Lines changed: 50 additions & 57 deletions

File tree

BIGQUERY.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,48 @@
1+
You are a highly skilled data engineer and data analyst. Your purpose is to help the developer interact with BigQuery datasets, execute queries, and generate data insights throughout the entire software delivery cycle.
2+
3+
---
4+
15
# Setup
26

37
## Required Gemini CLI Version
48

59
To install this extension, the Gemini CLI version must be v0.6.0 or above. The version can be found by running: `gemini --version`.
610

7-
## BigQuery MCP Server (Data Plane: Connecting and Querying)
11+
## BigQuery Skills (Data Plane: Connecting and Querying)
12+
13+
This section covers connecting to BigQuery.
14+
15+
1. **Extension Configuration**: This extension requires several settings (e.g., Project ID, Location). These values are gathered via prompts when you first install or link the extension:
16+
17+
* `BIGQUERY_PROJECT`: The GCP project ID.
18+
* `BIGQUERY_LOCATION`: (Optional) Location of the BigQuery resources.
19+
20+
If you need to update any of these values later, use the `gemini extensions config bigquery-data-analytics` command.
21+
22+
2. **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${BIGQUERY_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
23+
24+
3. **Handle Permission Errors**:
25+
* For operations that execute queries and view metadata, the user needs the **BigQuery User** (`roles/bigquery.user`) and **BigQuery Metadata Viewer** (`roles/bigquery.metadataViewer`) role.
26+
* For operations that create, or modify datasets and tables, the user needs the **BigQuery Data Editor** (`roles/bigquery.dataEditor`) role.
27+
* If an operation fails due to permissions, identify the type of operation and recommend the appropriate role. You can provide these links for assistance:
28+
* Granting Roles: https://cloud.google.com/iam/docs/grant-role-console
29+
* BigQuery Permissions: https://cloud.google.com/iam/docs/roles-permissions/bigquery
30+
31+
---
32+
33+
# Usage Guidelines
34+
35+
## Reusing Project Values
836

9-
This section covers connecting to a BigQuery instance.
37+
Users may have set project environment variables:
1038

11-
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.
39+
* `BIGQUERY_PROJECT`: The GCP project ID.
40+
* `BIGQUERY_LOCATION`: (Optional) Location of the BigQuery resources.
1241

13-
* `BIGQUERY_PROJECT`: The GCP project ID.
42+
Instead of prompting the user for these values for specific skill calls, prompt the user to verify the reuse of a specific setting value.
43+
Make sure to not use the environment variable name like `BIGQUERY_PROJECT`, `${BIGQUERY_PROJECT}`, or `$BIGQUERY_PROJECT`.
44+
The value can be verified by the user using the `gemini extensions config bigquery-data-analytics` command or by checking their local settings.
1445

15-
2. **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${BIGQUERY_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
46+
## Use Full Table Name Format "PROJECT.DATASET.TABLE"
1647

17-
3. **Handle Permission Errors**:
18-
* For operations that execute queries and view metadata, the user needs the
19-
**BigQuery User** (`roles/bigquery.user`) and **BigQuery Metadata Viewer** (`roles/bigquery.metadataViewer`) role.
20-
* For operations that create, or modify datasets and tables, the user neds
21-
the **BigQuery Data Editor** (`roles/bigquery.dataEditor`) role.
22-
* If an operation fails due to permissions, identify the type of operation
23-
and recommend the appropriate role. you can provide these links for
24-
assistance:
25-
* Granting Roles: https://cloud.google.com/iam/docs/grant-role-console
26-
* BigQuery Permissions:
27-
https://cloud.google.com/iam/docs/roles-permissions/bigquery
48+
**ALWAYS** use the full table name format, `PROJECT.DATASET.TABLE` in the generated SQL when executing the `execute_sql` script.

DEVELOPER.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before you begin, ensure you have the following:
1616

1717
### Running from Local Source
1818

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.
19+
The development process involves installing the extension locally into the Gemini CLI to test changes.
2020

2121
1. **Clone the Repository:**
2222

@@ -25,29 +25,16 @@ The core logic for this extension is handled by a pre-built `toolbox` binary. Th
2525
cd bigquery-data-analytics
2626
```
2727

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
28+
2. **Install the Extension Locally:** Use the Gemini CLI to install the
4229
extension from your local directory.
4330

4431
```bash
45-
gemini extensions link .
32+
gemini extensions install .
4633
```
47-
The CLI will prompt you to confirm the linking. Accept it to proceed.
34+
The CLI will prompt you to confirm the installation. Accept it to proceed.
4835

49-
4. **Testing Changes:** After linking, start the Gemini CLI (`gemini`).
50-
You can now interact with the `bigquery-data-analytics` tools to manually test your changes
36+
3. **Testing Changes:** After installing, start the Gemini CLI (`gemini`).
37+
You can now interact with the `bigquery-data-analytics` skills to manually test your changes
5138
against your connected database.
5239

5340
## Testing
@@ -76,13 +63,8 @@ are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/m
7663
## Building the Extension
7764

7865
The "build" process for this extension involves packaging the extension's
79-
metadata files (`gemini-extension.json`, `bigquery-data-analytics.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.
66+
metadata files (`gemini-extension.json`, `BIGQUERY.md`, `LICENSE`) along with the
67+
skills.
8668
8769
## Maintainer Information
8870
@@ -135,7 +117,3 @@ The process is handled by the [`mirror-changelog.yml`](.github/workflows/mirror-
135117
2. **Merge Release PR:** A maintainer approves and merges the Release PR. This
136118
action triggers `release-please` to create a new GitHub tag and a
137119
corresponding GitHub Release.
138-
3. **Package and Upload:** The new release triggers the
139-
`package-and-upload-assets.yml` workflow. This workflow builds the
140-
platform-specific extension archives and uploads them as assets to the
141-
GitHub Release.

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
1717

1818
* **Natural Language to data analytics :** Find required BigQuery tables and ask analytical questions in natural language.
1919
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for generating analytical insights.
20-
* **Run advanced analytics :** Generate forecasts, run a contributions analysis using built-in advanced tools.
20+
* **Run advanced analytics :** Generate forecasts, run a contributions analysis using built-in advanced skills.
2121

2222

2323
## Prerequisites
@@ -93,18 +93,12 @@ Interact with BigQuery using natural language right from your IDE:
9393
* "Using bigquery-public-data.pypi.file\_downloads show me the top 10 downloaded pypi packages this month."
9494
* “Using bigquery-public-data.pypi.file\_downloads can you forecast downloads for the last four months of 2025 for package urllib3?”
9595

96-
## Supported Tools
96+
## Supported Skills
9797

98-
This extension provides a comprehensive set of tools:
98+
This extension provides a comprehensive set of skills:
9999

100-
* `execute_sql`: Executes a SQL query.
101-
* `forecast`: Forecast time series data.
102-
* `get_dataset_info`: Get dataset metadata.
103-
* `get_table_info`: Get table metadata.
104-
* `list_dataset_ids`: Lists dataset ids in the database.
105-
* `list_table_ids`: Lists table ids in the database.
106-
* `analyze_contribution`: Perform contribution analysis, also called key driver analysis.
107-
* `search_catalog`: Search for tables based on the provided query.
100+
* `bigquery-data`: Use these skills when you need to handle large-scale data exploration and dataset management. Use when users need to find data assets or run SQL at scale. Provides metadata discovery and query execution across the data warehouse.
101+
* `bigquery-analytics`: Use these skills when you need to handle advanced data intelligence and predictive tasks. Use when a user asks "why" data changed or needs future projections. Provides automated insight generation and time-series forecasting.
108102

109103
## Additional Extensions
110104

0 commit comments

Comments
 (0)