Skip to content

docs: cover MCP standalone reports, calendar-period filters, sheets scale, and more - #11508

Open
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-8ob7cj
Open

docs: cover MCP standalone reports, calendar-period filters, sheets scale, and more#11508
keydunov wants to merge 1 commit into
masterfrom
claude/gallant-ramanujan-8ob7cj

Conversation

@keydunov

@keydunov keydunov commented Aug 8, 2026

Copy link
Copy Markdown
Member

Check List

  • Docs have been added / updated if required
  • Tests have been run in packages where changes have been made if available (docs-only change)
  • Linter has been run for changed code (docs-only change)
  • Tests for the changes have been added if not covered yet (docs-only change)

Description of Changes Made

Routine audit of cubejs-enterprise (Cube Cloud) commits merged since the prior daily audit (#11497), cross-checked against docs-mintlify and the customer-facing criteria. Eight small doc gaps found and fixed, each verified against the actual diff (not just the commit subject):

  1. docs/integrations/mcp-server.mdx — MCP's createReport tool now takes an optional workbookId; omitting it (optionally with folderId) saves a standalone exploration reachable from the workspace browser and the Sheets/Excel add-ins, instead of only a workbook-tab report.
  2. 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).
  3. 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.
  4. 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 (so SUM/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.
  5. 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.
  6. 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.
  7. 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.json navigation changes needed.

Dropped after verification:

  • A candidate "centralized /mcp endpoint" (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 (regional stays 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:

  • A tenant-wide time-zone policy with personal and per-embed-tenant overrides (CUB-852) is a genuinely new, multi-surface feature (Admin Settings, Preferences, Embedding tenant settings) with no existing doc home. It warrants a new dedicated page rather than a surgical edit, and its tracking issue (CUB-852) is still "In Progress" with a small follow-up PR in flight, so a documentation ticket was opened in Linear instead of drafting a full page in this PR.

Also checked the 3 cube-js/cube Tesseract 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

…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
@mintlify

mintlify Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Aug 8, 2026, 12:36 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claude Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 1m 12s —— View job


Review: docs-only, no blocking issues — 0 high, 0 medium, 3 low

Prose-only edits to existing docs-mintlify pages. All new link references resolve, no duplicate ref definitions, no docs.json change needed. 2 inline nits posted.

Full review

Todos

  • Gather context (diff, changed files, CLAUDE.md conventions)
  • Verify all new reference-style links resolve to real pages/anchors
  • Check for duplicate/conflicting link definitions
  • Check for other pages carrying the same operator lists that need updating
  • Check docs.json navigation impact
  • Post review

Verification performed

Check Result
[ref-measure-format]: /reference/data-modeling/measures#format reference/data-modeling/measures.mdx:1299 has ### \format`; matches the existing convention used in reference/core-data-apis/mdx-api.mdx:235`
abbr is a real format value ✅ documented at measures.mdx:1315 (abbr / abbr_N, SI prefix)
[ref-google-sheets] / [ref-excel] added to mcp-server.mdx ✅ no pre-existing definitions of those labels in that file — no shadowing. (microsoft-excel.mdx defines its own [ref-excel] pointing elsewhere, but that's file-scoped and unaffected.)
/docs/integrations/mcp-server link from skills.mdx ✅ page exists
Other copies of the Time operator table grep for relative date across *.mdxcontrols.mdx:23 is the only operator table; other hits are REST API relative-date-range prose, unrelated
docs.json ✅ no new pages, no nav change required
Conventions (root-relative internal links, reference-style defs at file bottom, surgical edits to existing pages, /docs untouched) ✅ all followed

Findings (all low)

  1. google-sheets.mdx:148 / microsoft-excel.mdx:158 — no trailing newline. Pre-existing, but this PR appends to that exact last line, so it's free to fix here. (inline)
  2. mcp-server.mdx:258 — the createReport table cell is ~4x longer than every other row, which hurts scannability of the tool reference. Suggested moving the workbookId / folderId semantics below the table. Also a grammar nit: "add-in's saved reports list" → "add-ins' saved reports lists" (two add-ins). (inline)
  3. querying-data.mdx:217-219 — slightly compressed phrasing. "Grouping gives presets read off the granularity" is a bit terse for a doc sentence; something like "When the time dimension is grouped by, the presets follow its granularity — …" reads more plainly. Purely stylistic, not worth blocking on.

Things I could not verify

The factual claims all originate from cubedevinc/cubejs-enterprise commits, which aren't accessible from this repo. I verified structure, links, and internal consistency only — the behavioral accuracy of each statement (e.g. that Scale is session-local, that the Changes-tab base defaults to the fork point, that skills work over MCP) rests on the author's diff-level verification described in the PR body.

The reasoning in the PR body for the two dropped items looks sound: gating the centralized /mcp endpoint behind a tenant flag and non-default opt-in does put it under the "wait until on by default" rule, and a multi-surface time-zone policy genuinely warrants its own page rather than a surgical edit.

No tests/linter run — docs-only change with no code paths touched.

· branch `claude/gallant-ramanujan-8ob7cj`

[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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
[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 |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 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 / 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".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants