googleapis--mcp-toolbox/docs/en/integrations/spanner/tools/spanner-search-catalog.md

title, type, weight, description

title	type	weight	description
spanner-search-catalog	docs	1	A "spanner-search-catalog" tool allows to search for entries based on the provided query.

About

A spanner-search-catalog tool returns all entries in Knowledge Catalog (e.g. tables, views, databases) with system=Spanner that matches given user query.

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

• databaseIds - The IDs of the spanner database.
• projectIds - The IDs of the GCP project.
• types - The type of the data. Accepted values are: DATABASE, TABLE, VIEW.
• pageSize - Number of results in the search page. Defaults to 5.

Compatible Sources

{{< compatible-sources >}}

Requirements

IAM Permissions

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

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.

Example

kind: tool
name: search_catalog
type: spanner-search-catalog
source: spanner-source
description: Searches for data assets (eg. Spanner tables, views, or databases) in Knowledge Catalog (formerly known as Dataplex) based on the provided search query

Reference

field	type	required	description
type	string	true	Must be "spanner-search-catalog".
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.