docs(mcp): Add Airbyte MCP overview to README by devin-ai-integration[bot] · Pull Request #1434 · airbytehq/PyAirbyte

devin-ai-integration · 2026-10-30T19:22:59Z

Summary

TL;DR: Introduce the Airbyte MCP in the PyAirbyte README so visitors and MCP submission reviewers can find its capabilities and setup instructions. Adds an `Airbyte MCP` section to `README.md` without changing runtime behavior.

DOCS-114. Requested by Ian Alton (@ian-at-airbyte).

Changes

Summarize agent permissions, pipeline management, troubleshooting, direct reads, connector skills, and Airbyte knowledge lookup from the public overview.
Document Cloud/Flex hosted availability, Core local-deployment caveats, and conditional read-only access, including the external-secrets-manager restriction.
Use absolute documentation links for PyPI rendering; link setup instructions rather than copying client configurations.

Review Spotlight

Reviewers with limited time, please review first:

Rendered MCP section: capabilities, availability, and direct-read restrictions.

Target branch: main

This README-only documentation patch intentionally targets main, not release-candidate/v1: the MCP submission needs the overview on the default branch. The RC sync workflow carries changes from main into release-candidate/v1.

Validation

Passed git diff --check origin/main...HEAD.
Rendered the new section with MarkdownIt: one heading, five capability bullets, six absolute links, and the inline-code hosted endpoint.
All six new links returned HTTP 200; checked claims against the live overview, installation, tools, and Core pages.
All 28 CI checks passed, including Python lint, type checks, and unit/integration tests. No local runtime tests: only README.md changed.
Copilot reviewed the final commit and reported no open issues. Both Technical Writer revisions are included.

Follow-ups

Registry/submission metadata (mcp-name: or server.json) is deliberately excluded. If the submission requires it, confirm the requirements with Ian before adding it. Technical Writer review precedes Ian's review.

Link to Devin session: https://app.devin.ai/sessions/d3fb43d855774e3f9009ce7d99cfdae9
Open in Devin Desktop: https://app.devin.ai/desktop/session/d3fb43d855774e3f9009ce7d99cfdae9?variant=devin

devin-ai-integration · 2026-10-30T19:23:01Z

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

Disable automatic comment, CI, and merge conflict monitoring

linear-code · 2026-10-30T19:23:05Z

DOCS-114

octavia-bot · 2026-10-30T19:23:12Z

Note

📝 PR Converted to Draft

More info...

Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy.

As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page.

To skip draft status in future PRs, please include [ready] in your PR title or add the skip-draft-status label when creating your PR.

github-actions · 2026-10-30T19:23:25Z

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

Testing This PyAirbyte Version

You 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/1793388130-docs-114-mcp-readme' pyairbyte --help

# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1793388130-docs-114-mcp-readme'

PR Slash Commands

Airbyte Maintainers can execute the following slash commands on your PR:

/fix-pr - Fixes most formatting and linting issues
/uv-lock - Updates uv.lock file
/test-pr - Runs tests with the updated PyAirbyte
/prerelease - Builds and publishes a prerelease version to PyPI
/evals - Runs the Cloud MCP evals that use the MCP tools this PR changed (/evals full=true runs the full suite)

📚 Show Repo Guidance

Helpful Resources

Community Support

Questions? Join the #pyairbyte channel in our Slack workspace.

📝 Edit this welcome message.

Copilot

🟢 Approval recommended

No active review issues are recorded for the README addition describing Airbyte MCP capabilities and setup guidance.

No open issues 🎉

What changed in this PR

Adds an Airbyte MCP overview to the PyAirbyte README so visitors and submission reviewers can find its capabilities and setup guidance. No runtime behavior changes.

Changes:

Summarizes pipeline management, troubleshooting, direct reads, connector skills, and knowledge lookup.
Explains hosted availability, self-managed caveats, and direct-read restrictions.
Provides the hosted endpoint and absolute links to installation instructions and the tool list.

File	Description
README.md	Adds the Airbyte MCP overview, availability details, access restrictions, and setup links.

_{Review effort: Balanced}

github-code-quality · 2026-10-30T19:28:51Z

Code coverage overview

Languages: Python

Python / code-coverage/pytest-no-creds

main d9f652f	devin/1793388130-doc... ce08b87	+/-
65%	77%	+12%

View coverage of the 10 most impacted files.

File	main d9f652f	devin/1793388130-doc... ce08b87	+/-
`airbyte/mcp/cloud.py`	52%	71%	+19%
`airbyte/_util/api_util.py`	36%	56%	+20%
`airbyte/mcp/_otel.py`	0%	89%	+89%
`airbyte/mcp/int..._registry_ui.py`	0%	92%	+92%
`airbyte/cloud/models.py`	0%	95%	+95%
`airbyte/mcp/_sso_auth.py`	0%	96%	+96%
`airbyte/mcp/int...nc_status_ui.py`	0%	97%	+97%
`airbyte/_direct...nnector_docs.py`	0%	97%	+97%
`airbyte/mcp/agents.py`	0%	98%	+98%
`airbyte/_direct...ctors/models.py`	0%	99%	+99%

Python / code-coverage/pytest

main d9f652f	devin/1793388130-doc... ce08b87	+/-
71%	80%	+9%

View coverage of the 10 most impacted files.

File	main d9f652f	devin/1793388130-doc... ce08b87	+/-
`airbyte/mcp/cloud.py`	52%	71%	+19%
`airbyte/mcp/_otel.py`	0%	89%	+89%
`airbyte/mcp/int..._registry_ui.py`	0%	92%	+92%
`airbyte/_direct...ors/api_util.py`	0%	92%	+92%
`airbyte/mcp/_sso_auth.py`	0%	96%	+96%
`airbyte/cloud/models.py`	0%	96%	+96%
`airbyte/mcp/int...nc_status_ui.py`	0%	97%	+97%
`airbyte/_direct...nnector_docs.py`	0%	97%	+97%
`airbyte/mcp/agents.py`	0%	98%	+98%
`airbyte/_direct...ctors/models.py`	0%	99%	+99%

Python / code-coverage/pytest-unit

main	devin/1793388130-doc... ce08b87	+/-
—	73%	—

Line coverage data for the main branch is not yet available.

View coverage of the 10 most covered files.

File	main	devin/1793388130-doc... ce08b87	+/-
`airbyte/mcp/agents.py`	—	98%	—
`airbyte/mcp/_sso_auth.py`	—	96%	—
`airbyte/cloud/models.py`	—	95%	—
`airbyte/cloud/client.py`	—	91%	—
`airbyte/mcp/_otel.py`	—	89%	—
`airbyte/exceptions.py`	—	84%	—
`airbyte/progress.py`	—	80%	—
`airbyte/mcp/cloud.py`	—	71%	—
`airbyte/shared/...ql_processor.py`	—	68%	—
`airbyte/_util/api_util.py`	—	56%	—

ℹ️ Calculations represent line coverage. Results may change as calculations are updated.

_{Updated October 30, 2026 19:36 UTC}

Copilot

🟢 Approval recommended

No active review issues block the README-only Airbyte MCP documentation update.

No open issues 🎉

_{Review effort: Balanced}

docs(mcp): Add Airbyte MCP overview to README

636a871

octavia-bot Bot marked this pull request as draft October 30, 2026 19:23

Airbyte Support Bot (airbyte-support-bot) requested a balanced review from Copilot October 30, 2026 19:23

Copilot started reviewing on behalf of Airbyte Support Bot (airbyte-support-bot) October 30, 2026 19:23

View session

devin-ai-integration Bot marked this pull request as ready for review October 30, 2026 19:23

docs(mcp): Clarify permissions and direct reads

ce08b87

Copilot AI reviewed Oct 30, 2026

View reviewed changes

Airbyte Support Bot (airbyte-support-bot) requested a balanced review from Copilot October 30, 2026 19:29

Copilot started reviewing on behalf of Airbyte Support Bot (airbyte-support-bot) October 30, 2026 19:29

View session

Copilot AI reviewed Oct 30, 2026

View reviewed changes

Ian Alton (ian-at-airbyte) approved these changes Oct 30, 2026

View reviewed changes

Ian Alton (ian-at-airbyte) merged commit 1182d56 into main Oct 30, 2026
30 checks passed

Ian Alton (ian-at-airbyte) deleted the devin/1793388130-docs-114-mcp-readme branch October 30, 2026 19:58

Navigation Menu

Repository navigation

docs(mcp): Add Airbyte MCP overview to README - #1434

docs(mcp): Add Airbyte MCP overview to README#1434
Ian Alton (ian-at-airbyte) merged 2 commits into
mainfrom
devin/1793388130-docs-114-mcp-readme

devin-ai-integration Bot commented Oct 30, 2026 •

edited

Loading

Uh oh!

devin-ai-integration Bot commented Oct 30, 2026

Uh oh!

linear-code Bot commented Oct 30, 2026

Uh oh!

octavia-bot Bot commented Oct 30, 2026

Uh oh!

github-actions Bot commented Oct 30, 2026

Testing This PyAirbyte Version

PR Slash Commands

Helpful Resources

Community Support

Uh oh!

Copilot AI left a comment

Uh oh!

github-code-quality Bot commented Oct 30, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

devin-ai-integration Bot commented Oct 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Review Spotlight

Target branch: main

Validation

Follow-ups

Uh oh!

devin-ai-integration Bot commented Oct 30, 2026

Uh oh!

linear-code Bot commented Oct 30, 2026

Uh oh!

octavia-bot Bot commented Oct 30, 2026

Uh oh!

github-actions Bot commented Oct 30, 2026

👋 Greetings, Airbyte Team Member!

Testing This PyAirbyte Version

PR Slash Commands

Helpful Resources

Community Support

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

github-code-quality Bot commented Oct 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code coverage overview

Python / code-coverage/pytest-no-creds

Python / code-coverage/pytest

Python / code-coverage/pytest-unit

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

devin-ai-integration Bot commented Oct 30, 2026 •

edited

Loading

github-code-quality Bot commented Oct 30, 2026 •

edited

Loading