Repository navigation
docs(mcp): List accepted statements for execute_external_sql_query, incl. SHOW DATABASES - #1383
Conversation
…_sql_query docs Co-Authored-By: AJ Steers <[email protected]>
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This PyAirbyte VersionYou can test this version of PyAirbyte using the following: # Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1792014758-sql-query-docs-show-databases' pyairbyte --help
# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1792014758-sql-query-docs-show-databases'PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful ResourcesCommunity SupportQuestions? Join the #pyairbyte channel in our Slack workspace. |
There was a problem hiding this comment.
🔵 Needs a closer look
The prerequisite server PR #6908 was inaccessible, so statement support and deployment require human confirmation.
0 open findings
What changed in this PR
Updates SQL passthrough documentation to describe the accepted statements consistently across the MCP tool and connector APIs.
Changes:
- Lists
SELECT/WITH,SHOW TABLES,SHOW DATABASES, andDESCRIBE TABLE <table>. - Recommends
DESCRIBE TABLEfor discovering columns without reading rows.
| File | Description |
|---|---|
| airbyte/mcp/cloud.py | Updates tool and SQL parameter descriptions and discovery guidance. |
| airbyte/cloud/connectors.py | Documents accepted statements in the connector method. |
| airbyte/_direct_connectors/actions.py | Aligns the sql_select action documentation. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Code coverage overviewLanguages: Python Python / code-coverage/pytest-no-creds
View coverage of the 10 most impacted files.
Python / code-coverage/pytest
View coverage of the 10 most impacted files.
Python / code-coverage/pytest-unit
Line coverage data for the release-candidate/v1 branch is not yet available. View coverage of the 10 most covered files.
ℹ️ Calculations represent line coverage. Results may change as calculations are updated. Updated |
c037dd8
into
release-candidate/v1
Overview
👉 TL;DR: The SQL query tool docs said
SHOW TABLESwas the only statement accepted besides SELECT. They now list exactly what the server accepts.Specifically, this updates the docstrings for
execute_external_sql_query(and itssqlField),CloudConnector.execute_sql_query, andAgentReadActionto listSELECT/WITH,SHOW TABLES,SHOW DATABASES, andDESCRIBE TABLE <table>.Depends on https://github.com/airbytehq/sonar/pull/6908 (merge and deploy first):
Test plan
test_mcp_local_tool_descriptions.pyandtest_mcp_docs_includes.py→ 21 passed; ruff clean.Link to Devin session: https://app.devin.ai/sessions/a51d808f26c9402fafc93e7640648187
Open in Devin Desktop: https://app.devin.ai/desktop/session/a51d808f26c9402fafc93e7640648187?variant=devin
Requested by: Aaron ("AJ") Steers (@aaronsteers)