cube-explore-content

# Explore saved Cube content Read-only. Workbooks, reports, dashboards, folders and notifications — the things people made, as opposed to the model underneath them. ## Choose the path Cube MCP tools are written `cube:<tool>` below: the `cube` server this plugin bundles. Through the Cube connector, the same tools carry the connector's name. Finding content is a CLI job: the Cube MCP tools cannot list workbooks, reports or notifications. They can read one you already have the id of — `cube:readWorkbook`, `cube:readReport` — and list folders with `cube:manageFolders` (`action: "list"`). With only the MCP tools connected, ask the user for a link to the workbook or report, or ask `cube:chat`, which searches existing reports. ## Preflight ```bash command -v cube >/dev/null || echo "Cube CLI not installed: curl -fsSL https://raw.githubusercontent.com/cube-js/cube/master/install-cli.sh | sh" cube whoami || echo "Not authenticated. Interactive: cube login. Headless: set CUBE_API_URL + CUBE_API_KEY." cube context list ``` ## The shape of a workspace Worth knowing before you go looking, because the names are not interchangeable: - **Workbook** — the authoring surface. Holds reports; can be published as a dashboard. - **Report** — a saved query with a visualization. Lives in a workbook, and can also be filed in folders. - **Dashboard** — the published output of a workbook, what viewers consume. - **Folder** — organizes saved content; nests. - **Notification** — a schedule that sends content to recipients. ## Start broad ```bash cube workspace list <deployment> # everything in your workspace cube workspace list <deployment> --search <text> # find by name cube workspace shared <deployment> # items shared with embed users cube folders list <deployment> cube folders ancestors <deployment> <folder> # where a folder sits in the tree ``` ## Workbooks, reports, dashboards ```bash cube workbooks list <deployment> cube workbooks get <deployment> <workbook> # includes draft and published dashboards cube reports list <deployment> cube reports get <deployment> <report> # includes the saved query cube reports folders <deployment> # folders that contain reports ``` Despite their names, `cube workbooks dashboard` updates a dashboard draft and `cube workbooks ai-thread` attaches a thread to a published dashboard. They are writes owned by `cube-build-content`, not inspection commands. `cube reports get` is the one that answers "what does this actually show" — it returns the saved query, so you can name the measures and dimensions rather than describing the chart. ## Notifications ```bash cube notifications list <deployment> cube notifications get <deployment> <notification> cube notifications recipients list <deployment> <notification> ``` Check recipients before anyone edits or deletes a schedule. A notification with recipients is something people are receiving. ## Finding what references a model field This is the half of impact analysis that `cube-explore-model` cannot do. Renaming a measure is only safe if no saved content queries it: 1. `cube reports list <deployment> --json --first 100` to enumerate. It returns one page: repeat with `--after <pageInfo.endCursor>` while `pageInfo.hasNextPage` is true, and read every page's `items`. 2. `cube reports get` the candidates and look at the saved query for the member name. 3. Report every report that references it, by name and id. Saved queries reference members by name. A rename in the model does not rewrite them, so anything you miss breaks silently the next time it runs. Say how many reports you checked — "no references found" across three reports means something different from across three hundred. ## Conventions - List commands print tables; `--json` when you need to filter. Get commands always print JSON. - Report ids alongside names. Names are not unique and the user needs the id to act. ## When something fails | Symptom | Cause | | --- | --- | | Empty list | Real — a new deployment or an empty workspace. Say so rather than retrying | | 403 on a workbook | This account lacks access; `cube policies get --resource-type Workbook --resource-id <id>` shows who has it | | Report has no query | A report that was never configured — a finding, not an error |