Get complete hierarchy of catalogs, databases, and tables.
⚠️ WORKFLOW: Use this for a quick overview of all managed catalogs.
For external catalogs, use list_catalogs_tool instead.
📋 PREREQUISITES:
- Call search_documentation_tool first to understand what data you need
📋 NEXT STEPS after this tool:
1. Use describe_table_tool to get schemas of tables you want to query
2. Use list_catalogs_tool to discover external catalogs not shown here
This tool provides a comprehensive view of all available assets in the Wherobots system,
including their hierarchical relationships. It can be used to retrieve
information about all catalogs, list all databases within those catalogs,
and enumerate all tables within each database.
***
IMPORTANT LIMITATION:
- This tool is being DEPRECATED, but is the only way to get a full hierarchy in one call.
- This tool ONLY shows catalogs managed within Wherobots.
- External catalogs (e.g., on Databricks, other cloud platforms) are NOT visible in this hierarchy.
- If the user mentions specific catalog names that don't appear in the results, they may be
external catalogs that need to be accessed differently.
- ALWAYS call list_catalogs_tool before or after calling this tool.
***
Parameters
----------
ctx : Context
FastMCP context (injected automatically)
Returns
-------
HierarchyListOutput
A structured object containing the hierarchy of catalogs, databases, and tables.
- 'hierarchy': A dictionary representing the hierarchical structure, where keys are catalog names.
Each catalog entry contains a dictionary of its databases.
Each database entry includes a list of its tables.
Each table entry contains its name.
- 'summary': A dictionary providing counts of total catalogs, databases, and tables.
Example Usage for LLM:
- When user asks for a general overview of data, or specific items across multiple catalogs/databases.
- Example User Queries and corresponding Tool Calls:
- User: "List all tables in the 'default' database of the 'wherobots' catalog AND in the 'overture_maps_foundation' database of 'wherobots_open_data'."
- Tool Call: list_hierarchy()
- User: "Show me all databases in 'wherobots' and 'wherobots_open_data' catalogs."
- Tool Call: list_hierarchy()
- User: "What data is available?"
- Tool Call: list_hierarchy()