-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: fix a batch of undocumented/stale Cube Cloud features found in a doc audit #11519
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -211,7 +211,7 @@ neither `listDeployments` nor the `chat` selection can reach an excluded deploym | |
|
|
||
| ## Available actions | ||
|
|
||
| The MCP server exposes 16 tools, grouped below. | ||
| The MCP server exposes 20 tools, grouped below. | ||
|
|
||
| Every tool runs as the authenticated user. Queries respect the same | ||
| [permissions][ref-roles] as the rest of Cube, including row-level security — MCP is a new | ||
|
|
@@ -277,6 +277,19 @@ default. Users without it never see them. | |
| | `writeDataModelFile` | Creates or overwrites a model source file on the dev branch (whole-file replacement). Recompiles the model and reports `valid` plus any `validationError`. | Destructive — prompts | | ||
| | `deleteDataModelFile` | Deletes a model source file on the dev branch. | Destructive — prompts | | ||
| | `getDataModelChanges` | Shows the diff of the dev branch against its parent — the pending changes, for review before committing. | Read-only | | ||
| | `getBranchDiff` | Diffs any branch against an arbitrary base (the deploy branch by default) — unlike `getDataModelChanges`, which only diffs a dev branch against its immediate parent. | Read-only | | ||
| | `getDeploymentEnv` | Lists the deployment's environment variables, with secret-named values redacted. Useful for checking configuration (e.g., an export bucket) when a pre-aggregation build fails. | Read-only | | ||
|
|
||
| ### Pre-aggregations | ||
|
|
||
| These tools verify that pre-aggregations defined in the data model actually build — including on an un-deployed dev branch, which `runQuery` can't reach since it only hits the deployed SQL API. Gated the same way as [Data model editing](#data-model-editing). | ||
|
|
||
| | Tool | Description | Access | | ||
| | --- | --- | --- | | ||
| | `getPreAggregationStatus` | Lists pre-aggregations with their partitions, how many have built, the newest build time, and the exact error for any that failed. | Read-only | | ||
| | `buildPreAggregation` | Triggers an on-demand build of one pre-aggregation. | Write | | ||
|
|
||
| Both tools target the deploy branch by default; pass a dev `branchName` from `startDataModelEdit` to target that branch's dev worker instead. | ||
|
Comment on lines
+283
to
+292
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Heading nesting is now wrong. Inserting Fix: move this whole Also, once it moves, the cross-reference "Gated the same way as Data model editing" reads naturally as a back-reference rather than a forward one. |
||
|
|
||
| #### How model edits stay safe | ||
|
|
||
|
|
@@ -293,7 +306,7 @@ into the MCP server: | |
| from the Cube UI, as described in [Development mode][ref-dev-mode]. The MCP server | ||
| deliberately exposes no commit tool — an AI client can prepare changes, but only a | ||
| person can ship them. | ||
| - **Registration is permission-gated.** The six tools above are only offered to users | ||
| - **Registration is permission-gated.** The tools above are only offered to users | ||
| whose role allows editing the semantic model. | ||
|
|
||
| Review pending work with `getDataModelChanges` before you commit. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit (style): this section is a bullet list, and the new content is a refinement of the "Event-specific attributes" bullet. Folding it in as a nested bullet keeps the section scannable and drops a paragraph, matching the "say it once / be concise" guidance in
docs-mintlify/CLAUDE.md. Either form is fine — take it or leave it.with the list above becoming:
Also worth double-checking on the
cubejs-enterpriseside thatDeleted group via SCIMgenuinely carries a non-emptymembershipChangespayload — for a delete it's plausible the members are implicitly removed without an explicit delta, in which case that third event name shouldn't be listed here.