Skip to content

docs: document MCP render_chart tool and query result links#728

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/4fba8e06
Open

docs: document MCP render_chart tool and query result links#728
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/4fba8e06

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Jun 1, 2026

Summary

Updates the Lightdash MCP reference page to reflect the new render_chart tool and best-effort exploreUrl / sqlRunnerUrl fields now returned with completed query results.

Context

Triggered by lightdash/lightdash#23693 (feat(mcp): add query result links), which:

  • Adds a generic render_chart MCP tool that renders charts for completed metric query results in MCP App-capable clients.
  • Decouples chart rendering from run_metric_query — that tool now returns data only.
  • Exposes a best-effort exploreUrl on completed metric query results and a best-effort sqlRunnerUrl on completed run_sql results so users can jump back into Lightdash.
  • render_chart does not support SQL Runner results.

Changes

  • Split the "Run metric query" capability bullet from chart rendering and added a new Render chart capability bullet.
  • Noted that completed metric query results include exploreUrl and completed run_sql results include sqlRunnerUrl, with a link to the SQL Runner guide.
  • Updated the developer-focused run_sql response shape accordion: added sqlRunnerUrl to the JSON envelope, the TypeScript example, and the notes (including the best-effort/null caveat).

cc @irakli-x (PR author)

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Jun 1, 2026

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

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Jun 1, 2026, 6:32 AM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

🤖 Documentation Bot

Status

⚠️ 1 broken link needs manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 timezones-draft.mdx

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.

1 participant