Skip to content

Commit 3db7111

Browse files
authored
docs: Update documentation for different platforms (#116)
1 parent ce52772 commit 3db7111

3 files changed

Lines changed: 204 additions & 97 deletions

File tree

BIGQUERY.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,22 @@
44

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

7-
## BigQuery MCP Server (Data Plane: Connecting and Querying)
7+
## BigQuery Skills (Data Plane: Connecting and Querying)
88

9-
This section covers connecting to a BigQuery instance.
9+
This section covers connecting to BigQuery.
1010

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.
11+
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:
1212

13-
* `BIGQUERY_PROJECT`: The GCP project ID.
13+
* `BIGQUERY_PROJECT`: The GCP project ID.
14+
* `BIGQUERY_LOCATION`: (Optional) Location of the BigQuery resources.
1415

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.
16+
If you need to update any of these values later, use the `gemini extensions config bigquery-data-analytics` command.
1617

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
18+
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.
19+
20+
3. **Handle Permission Errors**:
21+
* 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.
22+
* For operations that create, or modify datasets and tables, the user needs the **BigQuery Data Editor** (`roles/bigquery.dataEditor`) role.
23+
* If an operation fails due to permissions, identify the type of operation and recommend the appropriate role. You can provide these links for assistance:
24+
* Granting Roles: https://cloud.google.com/iam/docs/grant-role-console
25+
* BigQuery Permissions: https://cloud.google.com/iam/docs/roles-permissions/bigquery

DEVELOPER.md

Lines changed: 10 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ 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. **BigQuery Access** For testing data plane tools, you will need access to an active BigQuery dataset.
13+
2. **BigQuery Access** For testing data plane skills, you will need access to an active BigQuery dataset.
1414

1515
## Developing the Extension
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
@@ -59,7 +46,7 @@ for every pull request. This workflow primarily verifies that the extension can
5946
be successfully installed by the Gemini CLI.
6047

6148
Currently, there are no automated unit or integration test suites
62-
within this repository. All functional testing must be performed manually. All tools
49+
within this repository. All functional testing must be performed manually. All skills
6350
are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/mcp-toolbox).
6451

6552
### Other GitHub Checks
@@ -75,14 +62,8 @@ are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/m
7562

7663
## Building the Extension
7764

78-
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.
65+
The building process for this extension is handled automatically by the
66+
automated workflows when a new release is created. Manual building is not required.
8667

8768
## Maintainer Information
8869

@@ -135,7 +116,3 @@ The process is handled by the [`mirror-changelog.yml`](.github/workflows/mirror-
135116
2. **Merge Release PR:** A maintainer approves and merges the Release PR. This
136117
action triggers `release-please` to create a new GitHub tag and a
137118
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.

0 commit comments

Comments
 (0)