Skip to content

Document what read_content returns for a data app - #1740

Merged
jpetey75 merged 3 commits into
mainfrom
cloudy/docs-2026-11-12-change-7dc728ded00638ec
Nov 19, 2026
Merged

jpetey75 merged 3 commits into
mainfrom
cloudy/docs-2026-11-12-change-7dc728ded00638ec

Conversation

@lightdash-bot

@lightdash-bot lightdash-bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

Docs only said read_content fetches charts and dashboards, so readers assumed reading a data app returns only metadata or its full query definition.

  • New Reading a data app section on the MCP page: metadata plus dataReferences, no code
  • Explains static extraction, unresolved runtime values, and the stats and unresolved fields
  • Says to link saved charts so a number stays readable in full
  • Data apps page links to the new section instead of restating it
  • Clears validator warnings on the MCP page: same-page link paragraph, "powerful", and a question heading

Checked against AppGenerateService.ts (readDataApp) and AiAgentToolsService.ts (buildDataAppRead) in lightdash/lightdash main.

Review this PR individually. Close it to reject this change, then ask Cloudy to restack before merging.

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Documentation validation

✅ All blocking checks passed.

Component system

67 finding(s) across the corpus. Largest: heading.question 23 · prose.filler-word 22 · prose.anchor-index 12 · heading.overview 9 · prose.interface-narration 1.

Findings on lines this pull request touched are annotated inline in Files changed.

View the validation run.

@mintlify

mintlify Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
lightdash 🟢 Ready View Preview Nov 19, 2026, 9:09 PM

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

Cloudy and others added 3 commits November 19, 2026 15:08
- H5 headings need an explicit <a id> for the link checker
- stats counts every call site, not only queries
- data-apps.mdx links to the MCP page instead of restating it

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Drop the paragraph of same-page links
- Cut 'powerful'; state the comparison heading as a topic

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jpetey75
jpetey75 force-pushed the cloudy/docs-2026-11-12-change-7dc728ded00638ec branch from 5eb98ea to 21c3fea Compare November 19, 2026 21:08
@jpetey75
jpetey75 merged commit 70a4cc2 into main Nov 19, 2026
9 checks passed
@jpetey75
jpetey75 deleted the cloudy/docs-2026-11-12-change-7dc728ded00638ec branch November 19, 2026 21:10

This branch was successfully deployed

1 active deployment
staging — 21c3fea0 Deployed Nov 19, 2026 by mintlify[bot]
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