Skip to content

Commit 6e9215a

Browse files
chore(renaming)!: Renaming changes across all the files. (#93)
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> Co-authored-by: Yuan Teoh <yuanteoh@google.com>
1 parent 425633e commit 6e9215a

11 files changed

Lines changed: 92 additions & 91 deletions

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
label: Pre-reqs
3131
description: |
3232
Please run through the following list and make sure you've tried the usual "quick fixes":
33-
- Search the [current open issues](https://github.com/gemini-cli-extensions/dataplex/issues)
33+
- Search the [current open issues](https://github.com/gemini-cli-extensions/knowledge-catalog/issues)
3434
- Update to the latest version of the extension and [Gemini CLI](https://github.com/google-gemini/gemini-cli?tab=readme-ov-file#stable)
3535
options:
3636
- label: "I've searched the current open issues"

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
description: |
3131
Please run through the following list and make sure you've tried the usual "quick fixes":
3232
options:
33-
- label: "Search the [current open issues](https://github.com/gemini-cli-extensions/dataplex/issues)"
33+
- label: "Search the [current open issues](https://github.com/gemini-cli-extensions/knowledge-catalog/issues)"
3434
required: true
3535

3636
- type: textarea

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
description: |
3131
Please run through the following list and make sure you've tried the usual "quick fixes":
3232
options:
33-
- label: "Search the [issues](https://github.com/gemini-cli-extensions/dataplex/issues)"
33+
- label: "Search the [issues](https://github.com/gemini-cli-extensions/knowledge-catalog/issues)"
3434
required: true
3535

3636
- type: textarea

.github/workflows/mirror-changelog.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
- name: Add Toolbox Release Notes to PR Body
3030
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8
3131
env:
32-
REQUIRED_KEYWORDS: 'dataplex'
32+
REQUIRED_KEYWORDS: 'knowledge-catalog, dataplex'
3333
with:
3434
script: |
3535
const requiredKeywordsEnv = process.env.REQUIRED_KEYWORDS;

.github/workflows/package-and-upload-assets.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ name: Package and Upload Release Assets
1717
# Global variables
1818
env:
1919
PACKAGE_NAME: "dataplex"
20-
FILES_TO_PACKAGE: "gemini-extension.json DATAPLEX.md LICENSE"
20+
FILES_TO_PACKAGE: "gemini-extension.json KNOWLEDGE_CATALOG.md LICENSE"
2121
GCS_BUCKET_URL: "https://storage.googleapis.com/mcp-toolbox-for-databases/geminicli"
2222

2323
on:

.lycheeignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
https://github.com/gemini-cli-extensions/dataplex/compare/
2+
https://github.com/gemini-cli-extensions/knowledge-catalog/compare/

CHANGELOG.md

Lines changed: 59 additions & 59 deletions
Large diffs are not rendered by default.

DEVELOPER.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# DEVELOPER.md
22

33
This document provides instructions for setting up your development environment
4-
and contributing to the Dataplex Gemini CLI Extension project.
4+
and contributing to the Knowledge Catalog (formerly known as Dataplex) Gemini CLI Extension project.
55

66
## Prerequisites
77

@@ -10,7 +10,7 @@ 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. **Dataplex:** For testing tools, you will need access to an active Dataplex setup.
13+
2. **Knowledge Catalog:** For testing tools, you will need access to an active Knowledge Catalog setup.
1414

1515
## Developing the Extension
1616

@@ -21,8 +21,8 @@ The core logic for this extension is handled by a pre-built `toolbox` binary. Th
2121
1. **Clone the Repository:**
2222

2323
```bash
24-
git clone https://github.com/gemini-cli-extensions/dataplex.git
25-
cd dataplex
24+
git clone https://github.com/gemini-cli-extensions/knowledge-catalog.git
25+
cd knowledge-catalog
2626
```
2727

2828
2. **Download the Toolbox Binary:** The required version of the `toolbox` binary
@@ -47,7 +47,7 @@ The core logic for this extension is handled by a pre-built `toolbox` binary. Th
4747
The CLI will prompt you to confirm the linking. Accept it to proceed.
4848

4949
4. **Testing Changes:** After linking, start the Gemini CLI (`gemini`).
50-
You can now interact with the `dataplex` tools to manually test your changes
50+
You can now interact with the `knowledge-catalog` tools to manually test your changes
5151
against your connected database.
5252

5353
## Testing
@@ -76,7 +76,7 @@ are currently tested in the [MCP Toolbox GitHub](https://github.com/googleapis/g
7676
## Building the Extension
7777

7878
The "build" process for this extension involves packaging the extension's
79-
metadata files (`gemini-extension.json`, `dataplex.md`, `LICENSE`) along with the
79+
metadata files (`gemini-extension.json`, `KNOWLEDGE_CATALOG.md`, `LICENSE`) along with the
8080
pre-built `toolbox` binary into platform-specific archives (`.tar.gz` or `.zip`).
8181
8282
This process is handled automatically by the

DATAPLEX.md renamed to KNOWLEDGE_CATALOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ Your primary objective is to help discover, organize and manage metadata related
88

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

11-
## Dataplex MCP Server (Data Plane: Connecting and Querying)
11+
## Knowledge Catalog(formerly known as Dataplex) MCP Server (Data Plane: Connecting and Querying)
1212

13-
This section covers connecting to a Dataplex instance.
13+
This section covers connecting to a Knowledge Catalog instance.
1414

1515
1. **Verify Environment Variables**: The extension requires the following environment variables to be set before the Gemini CLI is started:
1616

1717
* `DATAPLEX_PROJECT`: The GCP project ID.
1818

1919
2. **Handle Missing Variables**: If a command fails with an error message containing a placeholder like `${DATAPLEX_PROJECT}`, it signifies a missing environment variable. Inform the user which variable is missing and instruct them to set it.
2020

21-
3. **Handle Permission Errors**: If you encounter permission errors, ensure the user has the correct Dataplex permissions:
21+
3. **Handle Permission Errors**: If you encounter permission errors, ensure the user has the correct Knowledge Catalog permissions:
2222
* Dataplex Reader (`roles/dataplex.viewer`) to search and look up entries.
2323
* Dataplex Editor (`roles/dataplex.editor`) to modify entries.
2424

@@ -147,7 +147,7 @@ Entries can be linked together using EntryLinks to represent relationships betwe
147147

148148
# Tool instructions
149149

150-
## Tool: dataplex_search_entries
150+
## Tool: search_entries
151151

152152
## General
153153

@@ -341,12 +341,12 @@ This abbreviated syntax works for the qualified predicates except for `label` in
341341
1. Explain that no search result was found
342342
2. Suggest to provide a more specific search query.
343343
344-
## Tool: dataplex_lookup_entry
344+
## Tool: lookup_entry
345345
346346
### Request
347347
348-
1. Always try to limit the size of the response by specifying `aspect_types` parameter. Make sure to include to select view=CUSTOM when using aspect_types parameter. If you do not know the name of the aspect type, use the `dataplex_search_aspect_types` tool.
349-
2. If you do not know the name of the entry, use `dataplex_search_entries` tool
348+
1. Always try to limit the size of the response by specifying `aspect_types` parameter. Make sure to include to select view=CUSTOM when using aspect_types parameter. If you do not know the name of the aspect type, use the `search_aspect_types` tool.
349+
2. If you do not know the name of the entry, use `search_entries` tool
350350
351351
### Response
352352

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Gemini CLI Extension - Dataplex
1+
# Gemini CLI Extension - Knowledge Catalog (formerly known as Dataplex)
22

33
> [!NOTE]
44
> This extension is currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).
55
6-
This Gemini CLI extension provides a set of tools to interact with [Dataplex](https://cloud.google.com/dataplex/docs) instances. It allows you to manage your data lakes, zones, and assets directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
6+
This Gemini CLI extension provides a set of tools to interact with [Knowledge Catalog](https://cloud.google.com/dataplex/docs) instances. It allows you to manage your data lakes, zones, and assets directly from the [Gemini CLI](https://google-gemini.github.io/gemini-cli/), using natural language prompts.
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
99
> [!IMPORTANT]
@@ -13,7 +13,7 @@ Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini
1313
1414
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=dataplex
1515

16-
## Why Use the Dataplex Extension?
16+
## Why Use the Knowledge Catalog Extension?
1717

1818
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
1919
* **Seamless Workflow:** As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
@@ -39,7 +39,7 @@ Before you begin, ensure you have the following:
3939
To install the extension, use the command:
4040

4141
```bash
42-
gemini extensions install https://github.com/gemini-cli-extensions/dataplex
42+
gemini extensions install https://github.com/gemini-cli-extensions/knowledge-catalog
4343
```
4444

4545
### Configuration
@@ -55,15 +55,15 @@ To view or update your configuration:
5555
* Gemini CLI: `/extensions list`
5656

5757
**Update Settings:**
58-
* Terminal: `gemini extensions config dataplex [setting name] [--scope <scope>]`
58+
* Terminal: `gemini extensions config knowledge-catalog [setting name] [--scope <scope>]`
5959
* `setting name`: (Optional) The single setting to configure.
6060
* `scope`: (Optional) The scope of the setting in (`user` or `workspace`). Defaults to `user`.
6161
* Currently, you must restart the Gemini CLI for changes to take effect. We recommend using `gemini --resume` to resume your session.
6262

6363
Alternatively, you can manually set these environment variables before starting the Gemini CLI:
6464

6565
```bash
66-
export DATAPLEX_PROJECT="<your-gcp-project-id>"
66+
export KNOWLEDGE_CATALOG_PROJECT="<your-gcp-project-id>"
6767
```
6868

6969
> [!NOTE]
@@ -80,7 +80,7 @@ gemini
8080

8181
## Usage Examples
8282

83-
Interact with Dataplex using natural language right from your IDE:
83+
Interact with Knowledge Catalog using natural language right from your IDE:
8484

8585
* **Explore Catalog and Metadata:**
8686
* "Find all catalog entries related to 'customer orders'."
@@ -92,8 +92,8 @@ Interact with Dataplex using natural language right from your IDE:
9292

9393
## Supported Tools
9494

95-
* `search_entries`: Use this tool to search for entries in Dataplex Catalog based on the provided search query.
96-
* `lookup_entry`: Use this tool to retrieve a specific entry from Dataplex Catalog.
95+
* `search_entries`: Use this tool to search for entries in Knowledge Catalog based on the provided search query.
96+
* `lookup_entry`: Use this tool to retrieve a specific entry from Knowledge Catalog.
9797
* `search_aspect_types`: Use this tool to find aspect types relevant to the query.
9898

9999
## Additional Extensions
@@ -108,5 +108,5 @@ Common issues:
108108

109109
* "failed to find default credentials: google: could not find default credentials.": Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/external/set-up-adc) for more information.
110110
* "✖ 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.
111-
* "✖ MCP ERROR: Error: spawn /Users/USER/.gemini/extensions/dataplex/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
111+
* "✖ MCP ERROR: Error: spawn /Users/USER/.gemini/extensions/knowledge-catalog/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
112112
* "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://mcp-toolbox.dev/documentation/introduction/#install-toolbox) for more information.

0 commit comments

Comments
 (0)