get_query_guide
Loads your organization's query guidance: what Guides exist, how to navigate them, and an overview of the available guide topics. Call this before writing SQL to answer a data question.
Description
The get_query_guide tool is the entry point into the guide layer for querying. It returns orientation on how to use and navigate guides plus an unfolded overview of your organization's topics and root-level guides — every topic with its guide count, then the guides without a topic with title, description, access level, and UUID.
The reserved dives and flights topics are omitted here; they have their own entry points (get_dive_guide and get_flight_guide).
Input parameters
This tool takes no arguments.
Output
The tool returns the guide as a plain-text document: navigation instructions followed by the topic overview. The response is mirrored into structured content as:
{
"text": string // Navigation instructions plus the topic overview
}
The overview lists every topic with its guide count first, then the root-level guides:
- data-quality/ (1 guide)
- revenue-billing/ (2 guides)
- revenue-billing/forecasting/ (1 guide)
- "Data platform overview" — what lives where in our warehouse (organization, uuid: a1b2c3d4-...)
Example usage
When the user asks a data question, the assistant should call this tool before exploring the schema or writing SQL:
What was our net revenue retention last quarter?
The assistant calls get_query_guide, sees that a revenue-billing topic exists, opens it with list_guides, and reads the relevant guide with get_guide before writing the query.
Related
list_guides— Browse the guide catalog level by level.get_guide— Load a guide's full content by UUID.get_dive_guide— Entry point for Dive conventions.get_flight_guide— Entry point for Flight conventions.- Guides how-to — Step-by-step instructions for creating and managing Guides.