docs/en/integrations/bigquery/tools/bigquery-get-dataset-info.md
A bigquery-get-dataset-info tool retrieves metadata for a BigQuery dataset.
bigquery-get-dataset-info accepts the following parameters:
dataset (required): Specifies the dataset for which to retrieve metadata.project (optional): Defines the Google Cloud project ID. If not provided,
the tool defaults to the project from the source configuration.The tool's behavior regarding these parameters is influenced by the
allowedDatasets restriction on the bigquery source:
allowedDatasets restriction: The tool can retrieve metadata for
any dataset specified by the dataset and project parameters.allowedDatasets restriction: Before retrieving metadata, the tool
verifies that the requested dataset is in the allowed list. If it is not, the
request is denied. If only one dataset is specified in the allowedDatasets
list, it will be used as the default value for the dataset parameter.{{< compatible-sources >}}
kind: tool
name: bigquery_get_dataset_info
type: bigquery-get-dataset-info
source: my-bigquery-source
description: Use this tool to get dataset metadata.
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "bigquery-get-dataset-info". |
| source | string | true | Name of the source the SQL should execute on. |
| description | string | true | Description of the tool that is passed to the LLM. |