Skip to content

Commit d14cae2

Browse files
chore: Add renaming changes across dataplex documentation (googleapis#3018)
## Description Updates documentation files, folder indexes, and GitHub labels/Blunderbuss configs to reflect the renaming for Dataplex while maintaining backward compatibility for existing tool types. ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/mcp-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/mcp-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [ ] Make sure to add `!` if this involve a breaking change 🛠️ Fixes googleapis#2956 --------- Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
1 parent 7a6d849 commit d14cae2

File tree

17 files changed

+78
-73
lines changed

17 files changed

+78
-73
lines changed

MCP-TOOLBOX-EXTENSION.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,16 +166,16 @@ instances, often by analyzing metrics and logs.
166166

167167
### Other Google Cloud Data Services
168168

169-
#### Dataplex
169+
#### Knowledge Catalog (formerly known as Dataplex)
170170

171-
* For interacting with Dataplex data lakes and assets:
171+
* For interacting with Knowledge Catalog data lakes and assets:
172172

173173
```bash
174-
gemini extensions install https://github.com/gemini-cli-extensions/dataplex
174+
gemini extensions install https://github.com/gemini-cli-extensions/knowledge-catalog
175175
```
176176

177177
Configuration:
178-
https://github.com/gemini-cli-extensions/dataplex/tree/main?tab=readme-ov-file#configuration
178+
https://github.com/gemini-cli-extensions/knowledge-catalog/tree/main?tab=readme-ov-file#configuration
179179

180180
#### Looker
181181

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ You can use the Toolbox in any MCP-compatible IDE or client (e.g., Gemini CLI, G
9797
When you run Toolbox with a `--prebuilt=<database>` flag, you instantly get access to standard tools to interact with that database.
9898

9999
Supported databases currently include:
100-
- **Google Cloud:** AlloyDB, BigQuery, Cloud SQL (PostgreSQL, MySQL, SQL Server), Spanner, Firestore, Dataplex
100+
- **Google Cloud:** AlloyDB, BigQuery, Cloud SQL (PostgreSQL, MySQL, SQL Server), Spanner, Firestore, Knowledge Catalog (formerly known as Dataplex).
101101
- **Other Databases:** PostgreSQL, MySQL, SQL Server, Oracle, MongoDB, Redis, Elasticsearch, CockroachDB, ClickHouse, Couchbase, Neo4j, Snowflake, Trino, and more.
102102

103103
For a full list of available tools and their capabilities across all supported databases, see the [Prebuilt Tools Reference](https://mcp-toolbox.dev/documentation/configuration/prebuilt-configs/).
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Dataplex MCP Server
1+
# Knowledge Catalog MCP Server
22

3-
The Dataplex Model Context Protocol (MCP) Server gives AI-powered development tools the ability to work with your Google Cloud Dataplex Catalog. It supports searching and looking up entries and aspect types.
3+
The Knowledge Catalog (formerly known as Dataplex) Model Context Protocol (MCP) Server gives AI-powered development tools the ability to work with your Google Cloud Knowledge Catalog. It supports searching and looking up entries and aspect types.
44

55
## Features
66

7-
An editor configured to use the Dataplex MCP server can use its AI capabilities to help you:
7+
An editor configured to use the Knowledge Catalog MCP server can use its AI capabilities to help you:
88

9-
- **Search Catalog** - Search for entries in Dataplex Catalog
9+
- **Search Catalog** - Search for entries in Knowledge Catalog
1010
- **Explore Metadata** - Lookup specific entries and search aspect types
1111

1212
## Prerequisites
@@ -37,18 +37,18 @@ You'll now be able to see all enabled tools in the "Tools" tab.
3737
3838
## Usage
3939

40-
Once configured, the MCP server will automatically provide Dataplex capabilities to your AI assistant. You can:
40+
Once configured, the MCP server will automatically provide Knowledge Catalog capabilities to your AI assistant. You can:
4141

42-
* "Search for entries related to 'sales' in Dataplex."
42+
* "Search for entries related to 'sales' in Knowledge Catalog."
4343
* "Look up details for the entry 'projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry'."
4444

4545
## Server Capabilities
4646

47-
The Dataplex MCP server provides the following tools:
47+
The Knowledge Catalog MCP server provides the following tools:
4848

4949
| Tool Name | Description |
5050
|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
51-
| `search_entries` | Search for entries in Dataplex Catalog. |
51+
| `search_entries` | Search for entries in Knowledge Catalog. |
5252
| `lookup_entry` | Retrieve specific subset of metadata (for example, schema, usage, business overview, and contacts) of a specific data asset. |
5353
| `search_aspect_types` | Find aspect types relevant to the query. |
5454
| `lookup_context` | Retrieve rich metadata regarding one or more data assets along with their relationships. |
@@ -79,4 +79,4 @@ Add the following configuration to your MCP client (e.g., `settings.json` for Ge
7979

8080
## Documentation
8181

82-
For more information, visit the [Dataplex documentation](https://cloud.google.com/dataplex/docs).
82+
For more information, visit the [Knowledge Catalog documentation](https://cloud.google.com/dataplex/docs).

docs/en/documentation/connect-to/gemini-cli/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Below are a list of Gemini CLI Extensions powered by MCP Toolbox:
3636
* [cloud-sql-postgresql-observability](https://github.com/gemini-cli-extensions/cloud-sql-postgresql-observability)
3737
* [cloud-sql-sqlserver](https://github.com/gemini-cli-extensions/cloud-sql-sqlserver)
3838
* [cloud-sql-sqlserver-observability](https://github.com/gemini-cli-extensions/cloud-sql-sqlserver-observability)
39-
* [dataplex](https://github.com/gemini-cli-extensions/dataplex)
39+
* [knowledge-catalog](https://github.com/gemini-cli-extensions/knowledge-catalog)
4040
* [firestore-native](https://github.com/gemini-cli-extensions/firestore-native)
4141
* [looker](https://github.com/gemini-cli-extensions/looker)
4242
* [mcp-toolbox](https://github.com/gemini-cli-extensions/mcp-toolbox)

docs/en/documentation/introduction/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Set the appropriate environment variables to connect, see the [Prebuilt Tools Re
7777
When you run Toolbox with a `--prebuilt=<database>` flag, you instantly get access to standard tools to interact with that database.
7878

7979
Supported databases currently include:
80-
- **Google Cloud:** AlloyDB, BigQuery, Cloud SQL (PostgreSQL, MySQL, SQL Server), Spanner, Firestore, Dataplex
80+
- **Google Cloud:** AlloyDB, BigQuery, Cloud SQL (PostgreSQL, MySQL, SQL Server), Spanner, Firestore, Knowledge Catalog (formerly known as Dataplex).
8181
- **Other Databases:** PostgreSQL, MySQL, SQL Server, Oracle, MongoDB, Redis, Elasticsearch, CockroachDB, ClickHouse, Couchbase, Neo4j, Snowflake, Trino, and more.
8282

8383
For a full list of available tools and their capabilities across all supported databases, see the [Prebuilt Tools Reference](https://mcp-toolbox.dev/documentation/configuration/prebuilt-configs/).

docs/en/integrations/bigquery/tools/bigquery-search-catalog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88

99
## About
1010

11-
A `bigquery-search-catalog` tool returns all entries in Dataplex Catalog (e.g.
11+
A `bigquery-search-catalog` tool returns all entries in Knowledge Catalog (e.g.
1212
tables, views, models) with system=bigquery that matches given user query.
1313

1414
`bigquery-search-catalog` takes a required `query` parameter based on which
@@ -30,14 +30,14 @@ following parameters:
3030
### IAM Permissions
3131

3232
Bigquery uses [Identity and Access Management (IAM)][iam-overview] to control
33-
user and group access to Dataplex resources. Toolbox will use your
33+
user and group access to Knowledge Catalog (formerly known as Dataplex) resources. Toolbox will use your
3434
[Application Default Credentials (ADC)][adc] to authorize and authenticate when
35-
interacting with [Dataplex][dataplex-docs].
35+
interacting with [Knowledge Catalog][dataplex-docs].
3636

3737
In addition to [setting the ADC for your server][set-adc], you need to ensure
3838
the IAM identity has been given the correct IAM permissions for the tasks you
39-
intend to perform. See [Dataplex Universal Catalog IAM permissions][iam-permissions]
40-
and [Dataplex Universal Catalog IAM roles][iam-roles] for more information on
39+
intend to perform. See [Knowledge Catalog IAM permissions][iam-permissions]
40+
and [Knowledge Catalog IAM roles][iam-roles] for more information on
4141
applying IAM permissions and roles to an identity.
4242

4343
[iam-overview]: https://cloud.google.com/dataplex/docs/iam-and-access-control

docs/en/integrations/dataplex/_index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/en/integrations/dataplex/prebuilt-configs/_index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Knowledge Catalog"
3+
weight: 1
4+
---
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Prebuilt Configs"
3+
type: docs
4+
description: "Prebuilt configurations for Knowledge Catalog (formerly known as Dataplex)."
5+
---

0 commit comments

Comments
 (0)