Tools on MCP Toolbox for Databases

dataplex-lookup-context

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataplex-lookup-context tool provides rich metadata of one or more data assets along with their relationships.

dataplex-lookup-context takes a required name parameter which contains the project and location to which the request should be attributed in the following form: projects/{project}/locations/{location} and also a required resources parameter which is a list of resource names for which metadata is needed in the following form: projects/{project}/locations/{location}/entryGroups/{group}/entries/{entry}

Compatible Sources

This tool can be used with the following database sources:

dataplex-lookup-entry

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataplex-lookup-entry tool returns details of a particular entry in Knowledge Catalog.

dataplex-lookup-entry takes a required name parameter which contains the project and location to which the request should be attributed in the following form: projects/{project}/locations/{location} and also a required entry parameter which is the resource name of the entry in the following form: projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}. It also optionally accepts following parameters:

view - View to control which parts of an entry the service should return. It takes integer values from 1-4 corresponding to type of view - BASIC, FULL, CUSTOM, ALL
aspectTypes - Limits the aspects returned to the provided aspect types in the format projects/{project}/locations/{location}/aspectTypes/{aspectType}. It only works for CUSTOM view.
paths - Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.

Compatible Sources

This tool can be used with the following database sources:

dataplex-search-aspect-types

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataplex-search-aspect-types tool allows to fetch the metadata template of aspect types based on search query.

dataplex-search-aspect-types accepts following parameters optionally:

query - Narrows down the search of aspect types to value of this parameter. If not provided, it fetches all aspect types available to the user.
pageSize - Number of returned aspect types in the search page. Defaults to 5.
orderBy - Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc.

Compatible Sources

This tool can be used with the following database sources:

dataplex-search-dq-scans

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataplex-search-dq-scans tool returns data quality scans that match the given criteria. It’s compatible with the following sources:

dataplex

dataplex-search-dq-scans accepts the following optional parameters:

filter - Filter string to search/filter data quality scans. E.g. “display_name = "my-scan"”.
data_scan_id - The resource name of the data scan to filter by: projects/{project}/locations/{locationId}/dataScans/{dataScanId}.
table_name - The name of the table to filter by. Maps to data.entity in the filter string. E.g. “//bigquery.googleapis.com/projects/P/datasets/D/tables/T”.
pageSize - Number of returned data quality scans in the page. Defaults to 10.
orderBy - Specifies the ordering of results.

Requirements

IAM Permissions

Dataplex uses Identity and Access Management (IAM) to control user and group access to Dataplex resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with Dataplex.

dataplex-search-entries

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataplex-search-entries tool returns all entries in Knowledge Catalog (formerly known as Dataplex) (e.g. tables, views, models) that matches given user query.

dataplex-search-entries takes a required query parameter based on which entries are filtered and returned to the user. It also optionally accepts following parameters:

scope - A scope limits the search space to a particular project or organization. It must be in the format: organizations/<org_id> or projects/<project_id> or projects/<project_number>.
pageSize - Number of results in the search page. Defaults to 5.
orderBy - Specifies the ordering of results. Supported values are: relevance (default), last_modified_timestamp, last_modified_timestamp asc.

Compatible Sources

This tool can be used with the following database sources: