Docs menu

warmquery_read_query

This page answers what warmquery_read_query returns, what it takes, and when it is offered.

Purpose

warmquery_read_query reads one saved warm query by its lookup: its steps, its parameters and the surface it is bound to. It does not run the query or read its results; to run a saved warm query, use call_api. It changes nothing.

It is a contributed tool: the warm query kind declares it, the platform's review gives it the effect read, and the OpenX MCP Server runs it. See Contributing to Thinky.

When it is offered

  • By its kind. The server lists it while the workspace has the warm query kind. The listing names the kind in its _meta: openx/azi-kind is warmquery, openx/azi-effect is read and openx/azi-load is open-panel.
  • In Thinky. Thinky loads it only while a Warm Query panel is open. With no Warm Query panel open, Thinky finds it with search_tools when you ask for it by name.

Inputs

InputTypeMeaning
warmQueryLookuptextRequired. The lookup of the warm query, as an open Warm Query panel shares it.

Example

{ "warmQueryLookup": "orders-by-day" }

The answer is { WarmQueryLookup, WarmQuery }: the lookup and the warm query's record, limited exactly as get_workspace limits it for you.

Errors

  • WARM_QUERY_LOOKUP_REQUIRED (400): no warmQueryLookup was given. Pass the lookup an open Warm Query panel shares.
  • WARM_QUERY_NOT_FOUND (404): there is no warm query with that lookup that you can read. Call get_workspace with kinds: ["WarmQueries"] for the warm queries you can read.
On this page