chore(sources/dataplex)!: Renaming changes across all the files related to Dataplex Toolbox by anikasharma03 · Pull Request #2958 · googleapis/mcp-toolbox

anikasharma03 · 2026-04-06T10:13:58Z

Description

Perform a full rename across files and directories related to the Dataplex Toolbox . This wide-scale refactoring is needed to ensure consistency across the entire codebase and documentation.

Key Changes

File and Directory Renaming:

Moved and renamed all directories and files associated with the dataplex implementation to follow the new naming convention (e.g., in internal/tools/, internal/sources/, and tests/).

Documentation Updates:

Updated references in README.md, integration guides, and other documentation files to reflect the new component naming.

Code Refactoring:

Updated internal references, variable names, and configuration keys to match the new naming standard while maintaining functional compatibility.

Test Updates:

Renamed test files and updated test cases to ensure they correctly validate the renamed components.

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:

Make sure you reviewed
CONTRIBUTING.md
Make sure to open an issue as a
bug/issue
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)
Appropriate docs were updated (if necessary)
Make sure to add ! if this involve a breaking change

🛠️ Fixes #2956

gemini-code-assist

Code Review

This pull request renames "Dataplex" to "Knowledge Catalog" across the entire repository, including CI configurations, documentation, internal Go packages, and integration tests. The feedback provided focuses on maintaining consistent naming conventions in the documentation and fixing a minor typo in the description of the search aspect types tool.

docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-search-entries.md

docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-search-aspect-types.md

Yuan325

Might be good to update the project env var as well so users are not confused (having to use type as "knowledge-catalog" but env var with the "dataplex" name). Please update it across the docs~

we're missing updates on these files:

.github/CODEOWNERS - folder name (we can keep the mdb group as is for now)
.github/blunderbuss.yml - update the label name (can keep the group as is)
.github/labels.yaml

Will dataplex be updating the official cloud docs page link? e.g. https://cloud.google.com/dataplex? If yes, we might want to update that as well. seems like some of bigquery doc that points towards that too.

Thank you!

docs/en/integrations/knowledge-catalog/prebuilt-configs/knowledge-catalog.md

internal/prebuiltconfigs/tools/knowledge-catalog.yaml

.ci/integration.cloudbuild.yaml

cmd/internal/config_test.go

docs/KNOWLEDGECATALOG_README.md

Yuan325 · 2026-04-09T01:30:36Z

/gcbrun

Yuan325

Hi @anikasharma03 can we implement this for cases where user uses "dataplex"? With this, we shouldn't have to worrry about breaking change.

We will also need to update the following to change entryName to "knowledge-catalog" if "dataplex" is detected (this will handle all the migration when user uses our migrate subcommand):

mcp-toolbox/cmd/internal/config.go

Line 212 in c924701

entryName, ok := entry.Key.(string)

We can keep all the docs updated to knowledge-catalog, no need to update those, thank you!

internal/sources/knowledge-catalog/knowledge_catalog.go

Yuan325 · 2026-04-09T18:27:35Z

tests/knowledge-catalog/knowledge_catalog_integration_test.go

can we do another copy of this file and keep the types with the "dataplex" name?

internal/sources/knowledge-catalog/knowledge_catalog.go

internal/prebuiltconfigs/prebuiltconfigs_test.go

…entation, file names, directories, configurations etc to reflect the new name of the dataplex toolbox.

Yuan325 · 2026-04-09T22:17:02Z

/gcbrun

Yuan325 · 2026-04-09T23:44:47Z

internal/sources/knowledge-catalog/knowledge_catalog.go

+	if r.Project == "" {
+		r.Project = os.Getenv("DATAPLEX_PROJECT")
+	}
+


Would prefer not to do this. We try not to grab environment variable from the server code post-unmarshalling. This might be flaky if the server is deployed in a separate environment as well.

Suggested change

if r.Project == "" {

r.Project = os.Getenv("DATAPLEX_PROJECT")

}

Yuan325 · 2026-04-09T23:46:40Z

tests/knowledge-catalog/dataplex_compatibility_test.go

+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package knowledgecatalog_test


Suggested change

package knowledgecatalog_test

package knowledgecatalog

Yuan325 · 2026-04-09T23:48:01Z

tests/knowledge-catalog/dataplex_compatibility_test.go

+	KnowledgeCatalogSearchEntriesToolType     = "dataplex-search-entries"
+	KnowledgeCatalogLookupEntryToolType       = "dataplex-lookup-entry"
+	KnowledgeCatalogSearchAspectTypesToolType = "dataplex-search-aspect-types"
+	KnowledgeCatalogProject                   = getProject()


Suggested change

KnowledgeCatalogProject = getProject()

KnowledgeCatalogProject = os.Getenv("DATAPLEX_PROJECT")

Yuan325 · 2026-04-09T23:48:11Z

tests/knowledge-catalog/dataplex_compatibility_test.go

+)
+
+func getProject() string {
+	p := os.Getenv("KNOWLEDGE_CATALOG_PROJECT")
+	if p == "" {
+		p = os.Getenv("DATAPLEX_PROJECT")
+	}
+	return p
+}


Suggested change

)

func getProject() string {

p := os.Getenv("KNOWLEDGE_CATALOG_PROJECT")

if p == "" {

p = os.Getenv("DATAPLEX_PROJECT")

}

return p

}

)

Yuan325 · 2026-04-09T23:49:38Z

tests/knowledge-catalog/dataplex_compatibility_test.go

can we just keep this file as the exact same as what we have now in dataplex_integration_test.go? I don't think we will need to update anything~

Yuan325 · 2026-04-09T23:51:31Z

internal/prebuiltconfigs/prebuiltconfigs_test.go

-	if len(dataplex_config) <= 0 {
-		t.Fatalf("unexpected error: could not fetch dataplex prebuilt tools yaml")


let's keep this~

Yuan325 · 2026-04-09T23:51:49Z

internal/prebuiltconfigs/prebuiltconfigs_test.go

-	expectedKeys := expectedToolSources
+	var expectedKeys []string
+	for _, k := range expectedToolSources {
+		if k != "dataplex" {
+			expectedKeys = append(expectedKeys, k)
+		}
+	}


Let's keep as is and don't modify this~

Yuan325 · 2026-04-09T23:52:16Z

cmd/internal/config_test.go

 	cloudsqlmysql_admin_config, _ := prebuiltconfigs.Get("cloud-sql-mysql-admin")
 	cloudsqlmssql_config, _ := prebuiltconfigs.Get("cloud-sql-mssql")
 	cloudsqlmssql_admin_config, _ := prebuiltconfigs.Get("cloud-sql-mssql-admin")
-	dataplex_config, _ := prebuiltconfigs.Get("dataplex")


let's keep this to make sure we implement the backwards compatibility.

Yuan325 · 2026-04-09T23:52:21Z

cmd/internal/config_test.go

 	t.Setenv("API_KEY", "your_api_key")

 	t.Setenv("BIGQUERY_PROJECT", "your_gcp_project_id")
-	t.Setenv("DATAPLEX_PROJECT", "your_gcp_project_id")


let's keep this.

Yuan325 · 2026-04-09T23:52:42Z

cmd/internal/config_test.go

-			name: "dataplex prebuilt tools",
-			in:   dataplex_config,


let's keep this~ and add a new test case for knowledge catalog.

Yuan325 · 2026-04-10T16:47:18Z

Closing since we are no longer renaming the src code.

anikasharma03 requested review from a team as code owners April 6, 2026 10:13

blunderbuss-gcf bot assigned Yuan325 Apr 6, 2026

gemini-code-assist bot reviewed Apr 6, 2026

View reviewed changes

docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-search-entries.md Outdated Show resolved Hide resolved

docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-search-aspect-types.md Outdated Show resolved Hide resolved

Yuan325 changed the title ~~chore(renaming): Renaming changes across all the files related to Dataplex Toolbox~~ chore(sources/dataplex)!: Renaming changes across all the files related to Dataplex Toolbox Apr 6, 2026

Yuan325 requested changes Apr 7, 2026

View reviewed changes

anikasharma03 added a commit to anikasharma03/genai-toolbox that referenced this pull request Apr 7, 2026

Fix: Address review comments on PR googleapis#2958

c93e28d

anikasharma03 force-pushed the rename-toolbox branch from 9b32fcf to c93e28d Compare April 7, 2026 10:30

anikasharma03 added a commit to anikasharma03/genai-toolbox that referenced this pull request Apr 7, 2026

Fix: Address review comments on PR googleapis#2958

966c516

Yuan325 approved these changes Apr 7, 2026

View reviewed changes

Yuan325 added release candidate Use label to signal PR should be included in the next release. do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Apr 7, 2026

Yuan325 force-pushed the rename-toolbox branch from c2ccc7a to 5749fb5 Compare April 9, 2026 01:30

Yuan325 pushed a commit to anikasharma03/genai-toolbox that referenced this pull request Apr 9, 2026

Fix: Address review comments on PR googleapis#2958

c98f276

Yuan325 pushed a commit to anikasharma03/genai-toolbox that referenced this pull request Apr 9, 2026

Fix: Address review comments on PR googleapis#2958

2745e9e

Yuan325 reviewed Apr 9, 2026

View reviewed changes

anikasharma03 added 4 commits April 9, 2026 21:59

chore(renaming): Renaming changes across all the files. Updates docum…

b85ceb6

…entation, file names, directories, configurations etc to reflect the new name of the dataplex toolbox.

Fix: Address review comments on PR googleapis#2958

35b4893

Fix: Address review comments on PR googleapis#2958

8c29c43

Fix: Address review comments on PR googleapis#2958

bd41aaa

anikasharma03 force-pushed the rename-toolbox branch from 5749fb5 to bd41aaa Compare April 9, 2026 22:13

Yuan325 requested changes Apr 9, 2026

View reviewed changes

Yuan325 closed this Apr 10, 2026

	if r.Project == "" {
	r.Project = os.Getenv("DATAPLEX_PROJECT")
	}

	KnowledgeCatalogProject = getProject()
	KnowledgeCatalogProject = os.Getenv("DATAPLEX_PROJECT")

		if len(dataplex_config) <= 0 {
		t.Fatalf("unexpected error: could not fetch dataplex prebuilt tools yaml")

Conversation

anikasharma03 commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Key Changes

File and Directory Renaming:

Documentation Updates:

Code Refactoring:

Test Updates:

PR Checklist

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Yuan325 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Yuan325 commented Apr 9, 2026

Uh oh!

Yuan325 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Yuan325 commented Apr 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yuan325 commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

anikasharma03 commented Apr 6, 2026 •

edited

Loading

Yuan325 left a comment •

edited

Loading