docs: cover MCP standalone reports, calendar-period filters, sheets scale, and more - #11508
docs: cover MCP standalone reports, calendar-period filters, sheets scale, and more#11508keydunov wants to merge 1 commit into
Conversation
…cale, and more Routine audit of cubejs-enterprise commits merged since the prior daily audit (PR #11497), cross-checked against docs-mintlify and the customer-facing criteria. Eight small gaps found and fixed: - mcp-server.mdx: createReport's workbookId is now optional (standalone explorations reachable from the workspace browser and Sheets/Excel add-ins) - controls.mdx: new time-filter operators (in/not in the month/quarter/year); manually changed dashboard filters now round-trip into the URL - querying-data.mdx: period comparisons can anchor to a filtered (not just grouped) time dimension; dashboard comparisons now follow the viewer's active filter window - google-sheets.mdx, microsoft-excel.mdx: compact number formats write as real numbers, not text; new Display > Scale control - dashboard-themes.mdx: Rename action added to the Styling tab's theme menu - admin/ai/skills.mdx: skills now work over the MCP server, not just in-app chat (still unavailable on published/embedded dashboards) - data-model-ide.mdx: Changes view diffs against an explicit, shareable `?base=` branch Dropped one candidate (a centralized /mcp endpoint) after verifying it's gated behind a tenant flag and defaults off even when enabled — not shipped per the customer-facing criteria. A larger finding (tenant-wide time zone policy with personal/embed overrides, CUB-852) is being tracked separately via a Linear documentation ticket rather than folded into this PR. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LEfUVvGy8HbJ4BnCJ2V9jY
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @keydunov's task in 1m 12s —— View job Review: docs-only, no blocking issues — 0 high, 0 medium, 3 lowProse-only edits to existing Full reviewTodos
Verification performed
Findings (all low)
Things I could not verifyThe factual claims all originate from The reasoning in the PR body for the two dropped items looks sound: gating the centralized No tests/linter run — docs-only change with no code paths touched. |
| [ref-sql-api-enabled]: /reference/core-data-apis/sql-api#cube-cloud | ||
| [ref-saved-reports]: /docs/workspace/saved-reports No newline at end of file | ||
| [ref-saved-reports]: /docs/workspace/saved-reports | ||
| [ref-measure-format]: /reference/data-modeling/measures#format No newline at end of file |
There was a problem hiding this comment.
Nit: this file still ends without a trailing newline (\ No newline at end of file in the diff). Since this PR already touches the last line, worth fixing here — same for microsoft-excel.mdx:158.
| [ref-measure-format]: /reference/data-modeling/measures#format | |
| [ref-measure-format]: /reference/data-modeling/measures#format |
| | `readWorkbook` | Reads a workbook — its name and its current dashboard draft and published configs. | Read-only | | ||
| | `createWorkbook` | Creates a new empty workbook, the container that holds reports and a dashboard. | Write | | ||
| | `createReport` | Saves a query plus its visualization as a report inside a workbook, and returns the `reportId` a chart widget references. | Write | | ||
| | `createReport` | Saves a query plus its visualization as a report, and returns the `reportId` a chart widget references. `workbookId` is optional: pass it to add the report as a tab of that workbook (referenceable by a CHART widget there); omit it (optionally passing `folderId`) to save a standalone exploration reachable from the workspace browser and the [Google Sheets][ref-google-sheets] / [Excel][ref-excel] add-in's saved reports list instead. | Write | |
There was a problem hiding this comment.
This cell is now ~4x longer than every other row in the table, which makes the tool reference hard to scan. Consider keeping the row to the one-line summary and moving the workbookId / folderId semantics into a short paragraph or <Note> below the table — e.g.:
createReport— Saves a query plus its visualization as a report, and returns thereportIda chart widget references.
workbookIdis optional. Pass it to add the report as a tab of that workbook (referenceable by aCHARTwidget there); omit it (optionally passingfolderId) to save a standalone exploration reachable from the workspace browser and the Google Sheets / Excel add-ins' saved reports lists.
Also, "add-in's saved reports list" is possessive-singular while referring to two add-ins — should be "add-ins' saved reports lists".
Check List
Description of Changes Made
Routine audit of
cubejs-enterprise(Cube Cloud) commits merged since the prior daily audit (#11497), cross-checked againstdocs-mintlifyand the customer-facing criteria. Eight small doc gaps found and fixed, each verified against the actual diff (not just the commit subject):docs/integrations/mcp-server.mdx— MCP'screateReporttool now takes an optionalworkbookId; omitting it (optionally withfolderId) saves a standalone exploration reachable from the workspace browser and the Sheets/Excel add-ins, instead of only a workbook-tab report.docs/explore-analyze/dashboards/widgets/controls.mdx— new time-filter operators (in the month/not in the month,in the quarter/not in the quarter,in the year/not in the year) on the report bar, dashboard Filter widget, and embedded dashboards. Also: manually changing a dashboard filter now writes the value back into the URL, so it's bookmarkable/shareable (previously URL → filter was one-way).docs/explore-analyze/workbooks/querying-data.mdx— a period-over-period comparison can now anchor to a time dimension the query only filters (not just one it groups by), so a report with no time column can still compare periods. Also documents that a comparison on a dashboard now correctly follows the viewer's active filter window rather than the report's original saved window.docs/integrations/google-sheets.mdx,docs/integrations/microsoft-excel.mdx— new "Number formatting" section: compact measure formats (e.g.abbr) now write as real numbers rather than text (soSUM/pivots/charts keep working), and a new Display → Scale control (Model default / Absolute / Thousands (K) / Millions (M) / Billions (B)) lets a user pin every measure column to a fixed magnitude.admin/customization/dashboard-themes.mdx— a Rename action was added to the Styling tab's theme "..." menu, so a custom theme can be renamed from the dashboard builder directly, not only from the Admin themes list.admin/ai/skills.mdx— skills now work when the agent is used through the MCP server, not just in-app chat (previously silently unavailable over MCP); still unavailable on published/embedded dashboards, which stay read-only Q&A.docs/data-modeling/data-model-ide.mdx— the Data Model IDE's Changes view now always names an explicit comparison base (defaulting to the branch's fork point, with the deploy branch offered as an alternative), carried in a shareable?base=<branch-name>link parameter alongside the existing?branch=.Prose-only edits to existing pages; no
docs.jsonnavigation changes needed.Dropped after verification:
/mcpendpoint" (feat(cloud-router): centralized MCP endpoint at /mcp) turned out to be gated behind a tenant flag and opt-in even when the flag is on (regionalstays the default) — not shipped per the customer-facing criteria's "wait until on by default" rule, so left undocumented for now.Not a doc gap — filed as a Linear ticket instead:
Also checked the 3
cube-js/cubeTesseract fixes merged in this window (FILTER_PARAMS column callbacks, multi-stage filter row-set bug, ungrouped-query/rollup matching) — all are internal correctness fixes that make previously-wrong results correct without changing any documented option or contract, so none needed a doc change.🤖 Generated with Claude Code
https://claude.ai/code/session_01LEfUVvGy8HbJ4BnCJ2V9jY
Generated by Claude Code