googleapis--mcp-toolbox/docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-get-data-insights.md

title, type, weight, description, aliases

title	type	weight	description	aliases
dataplex-get-data-insights	docs	1	Retrieves the final generated data insights (descriptions, schema relationships, sample SQL queries) for a completed insights scan.	/integrations/dataplex/tools/dataplex-get-data-insights/

About

A dataplex-get-data-insights tool retrieves the final results of a completed Data Insights scan.

WARNING: You must verify that the execution run has succeeded (via dataplex-get-run-status) before calling this tool, otherwise the results will be empty. CRITICAL: Access the results only via the nested public GA fields dataDocumentationResult.datasetResult (for datasets) or dataDocumentationResult.tableResult (for tables). The top-level fields (like dataDocumentationResult.queries) are restricted and will be empty.

Compatible Sources

{{< compatible-sources >}}

Requirements

IAM Permissions

Knowledge Catalog uses Identity and Access Management (IAM) to control user and group access to Knowledge Catalog resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with [Knowledge Catalog][dataplex-docs].

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the tasks you intend to perform. See Knowledge Catalog IAM permissions and Knowledge Catalog IAM roles for more information on applying IAM permissions and roles to an identity.

Parameters

The dataplex-get-data-insights tool accepts the following parameters:

field	type	required	description
scanId	string	true	The unique ID of the Dataplex scan (e.g. nq-doc-12345).
location	string	true	The Google Cloud region where the scan was created (e.g. us-central1).

Example

kind: tool
name: get_data_insights
type: dataplex-get-data-insights
source: my-dataplex-source
description: Retrieve results from a completed data insights scan.

Reference

field	type	required	description
type	string	true	Must be "dataplex-get-data-insights".
source	string	true	Name of the source the tool should execute on.
description	string	true	Description of the tool that is passed to the LLM.