mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-14 09:05:04 -05:00

Files

Averi Kitsch b935193bea docs: add MCP server readme docs per database (#2004 )

## Description

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

## 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](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-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)
- [ ] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

2025-11-20 20:08:27 -06:00

3.1 KiB

Raw Blame History

Dataplex MCP Server

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.

Features

An editor configured to use the Dataplex MCP server can use its AI capabilities to help you:

Search Catalog - Search for entries in Dataplex Catalog
Explore Metadata - Lookup specific entries and search aspect types

Installation and Setup

Prerequisites

Download and install MCP Toolbox:

Download the Toolbox binary: Download the latest binary for your operating system and architecture from the storage bucket. Check the releases page for OS and CPU architecture support: https://storage.googleapis.com/genai-toolbox/v0.21.0/<os>/<arch>/toolbox
- Replace <os> with linux, darwin (macOS), or windows.
- Replace <arch> with amd64 (Intel) or arm64 (Apple Silicon).
```
curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
```
Make it executable:
```
chmod +x toolbox
```
Add the binary to $PATH in .~/bash_profile:
```
export PATH=$PATH:/path/to/toolbox
```

Note: You may need to restart Antigravity for changes to take effect. Windows OS users will need to follow one of the Windows-specific methods.

A Google Cloud project with the Dataplex API enabled.
Ensure Application Default Credentials are available in your environment.
IAM Permissions:
- Dataplex Viewer (roles/dataplex.viewer) or equivalent permissions to read catalog entries.

Configuration

The MCP server is configured using environment variables.

export DATAPLEX_PROJECT="<your-gcp-project-id>"

Add the following configuration to your MCP client (e.g., settings.json for Gemini CLI):

{
  "mcpServers": {
    "dataplex": {
      "command": "toolbox",
      "args": ["--prebuilt", "dataplex", "--stdio"],
      "env": {
        "DATAPLEX_PROJECT": "your-project-id"
      }
    }
  }
}

Usage

Once configured, the MCP server will automatically provide Dataplex capabilities to your AI assistant. You can:

"Search for entries related to 'sales' in Dataplex."
"Look up details for the entry 'projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry'."

Server Capabilities

The Dataplex MCP server provides the following tools:

Tool Name	Description
`search_entries`	Search for entries in Dataplex Catalog.
`lookup_entry`	Retrieve a specific entry from Dataplex Catalog.
`search_aspect_types`	Find aspect types relevant to the query.

Documentation

For more information, visit the Dataplex documentation.

3.1 KiB Raw Blame History