Skip to content

docs: document run_sql structuredContent response shape#665

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
docs/mcp-run-sql-structured-content
Open

docs: document run_sql structuredContent response shape#665
mintlify[bot] wants to merge 1 commit into
mainfrom
docs/mcp-run-sql-structured-content

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 19, 2026

Summary

Document the new structuredContent field returned by the MCP run_sql tool, so developers building custom MCP clients know to read typed rows directly instead of parsing the CSV payload.

Changes

  • Added a developer-facing accordion under Run SQL in the Lightdash MCP reference covering:
    • The full response envelope (content + structuredContent)
    • A short callMcpTool usage example
    • Behavior for empty results and errors
    • Back-compat note that content[0].text still carries raw CSV

Context

Upstream change adds structuredContent: { rows, columns, rowCount } and an outputSchema to run_sql. The CSV text payload is unchanged, so existing clients keep working — the structured response is purely additive and lets clients consume typed values without re-parsing strings.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 19, 2026

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

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview May 19, 2026, 10:46 AM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

🤖 Documentation Bot

All checks passed! No issues found.

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.

0 participants