Skip to content

docs(mcp): Consolidate MCP server docs - #78241

Merged
Ian Alton (ian-at-airbyte) merged 6 commits into
masterfrom
devin/1779221733-agentic-1656-mcp-docs
May 21, 2026
Merged

docs(mcp): Consolidate MCP server docs#78241
Ian Alton (ian-at-airbyte) merged 6 commits into
masterfrom
devin/1779221733-agentic-1656-mcp-docs

Conversation

@ian-at-airbyte

@ian-at-airbyte Ian Alton (ian-at-airbyte) commented May 19, 2026

Copy link
Copy Markdown
Contributor

What

Consolidates the public MCP server docs under the Community docs instance for AGENTIC-1656: https://linear.app/airbyteio/issue/AGENTIC-1656/consolidate-mcp-server-docs-into-one-section

Requested by Ian Alton.

How

  • Moves Airbyte Knowledge MCP and PyAirbyte MCP docs from docs/developers/mcp-servers to docs/community/mcp-servers.
  • Adds a new Community MCP landing page with a prominent Agent MCP section/card linking to /ai-agents/interfaces/mcp/.
  • Keeps Agent MCP nested under the Community MCP servers sidebar category.
  • Replaces the landing page DocCardList with explicit custom cards for Knowledge MCP server and PyAirbyte MCP server, avoiding a duplicate Agent MCP card.
  • Removes the Connector Builder MCP page and Developer sidebar entry.
  • Adds Community sidebar entries and Vercel redirects from the old Developer MCP URLs.
  • Adds a Knowledge MCP sidebar label via page frontmatter.

Review guide

  1. docs/community/mcp-servers/readme.md
  2. docusaurus/sidebar-community.js
  3. docusaurus/sidebar-developers.js
  4. docusaurus/vercel.json

User Impact

Users find MCP server docs under Community, with Agent MCP presented as the primary recommended MCP server. Existing Airbyte Knowledge MCP and PyAirbyte MCP URLs redirect to their new Community locations.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Validation:

  • corepack pnpm install
  • git diff --check
  • /home/ubuntu/.local/bin/pre-commit run --files docusaurus/vercel.json docusaurus/sidebar-community.js docusaurus/sidebar-developers.js docs/community/mcp-servers/readme.md docs/community/mcp-servers/airbyte-knowledge-mcp.md docs/community/mcp-servers/pyairbyte-mcp.md
  • corepack pnpm clear && corepack pnpm build

Link to Devin session: https://app.devin.ai/sessions/aa95e15dbd8c41f891fec61d6f85b53a
Requested by: Ian Alton (@ian-at-airbyte)

@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@linear

linear Bot commented May 19, 2026

Copy link
Copy Markdown

AGENTIC-1656

@github-actions

Copy link
Copy Markdown
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • 🛠️ Quick Fixes
    • /format-fix - Fixes most formatting issues.
    • /bump-version - Bumps connector versions, scraping changelog description from the PR title.
      • Bump types: patch (default), minor, major, major_rc, rc, promote.
      • The rc type is a smart default: applies minor_rc if stable, or bumps the RC number if already RC.
      • The promote type strips the RC suffix to finalize a release.
      • Example: /bump-version type=rc or /bump-version type=minor
    • /bump-progressive-rollout-version - Alias for /bump-version type=rc. Bumps with an RC suffix and enables progressive rollout.
  • ❇️ AI Testing and Review (internal link: AI-SDLC Docs):
    • /ai-prove-fix - Runs prerelease readiness checks, including testing against customer connections.
    • /ai-canary-prerelease - Rolls out prerelease to 5-10 connections for canary testing.
    • /ai-review - AI-powered PR review for connector safety and quality gates.
  • 📝 AI Documentation:
    • /ai-docs-review - AI-powered documentation review for PRs with connector changes.
    • /ai-create-docs-pr - Creates a documentation PR for connector changes, stacked on the current PR.
  • 🚀 Connector Releases:
    • /publish-connectors-prerelease - Publishes pre-release connector builds (tagged as {version}-preview.{git-sha}) for all modified connectors in the PR.
  • ☕️ JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
  • 🐍 Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.
  • ⚙️ Admin commands:
    • /force-merge reason="<REASON>" - Force merges the PR using admin privileges, bypassing CI checks. Requires a reason.
      Example: /force-merge reason="CI is flaky, tests pass locally"
📚 Show Repo Guidance

Helpful Resources

📝 Edit this welcome message.

@github-actions

github-actions Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Deploy preview for airbyte-docs ready!

Project:airbyte-docs
Status: ✅  Deploy successful!
Preview URL:https://airbyte-docs-ir6kw2b0m-airbyte-growth.vercel.app
Latest Commit:f415a34

Deployed with vercel-action

@ian-at-airbyte

Copy link
Copy Markdown
Contributor Author

For the Airbyte knowledge MCP, specify that this is a tool to provide knowledge to agents, but not the primary interface agents should work with. Link to the Agent MCP docs, which is the primary way agents should use Airbyte to work with data.

For the PyAirbyte MCP, specify that this is a tool to manage Airbyte data replication connections, but not the primary interface agents should work with. Link to the Agent MCP, which is the primary way agents should use Airbyte to work with data.

@ian-at-airbyte

Copy link
Copy Markdown
Contributor Author

Also add a link to the Agent MCP in the sidebar in the new Community section.

And remove the link to the public roadmap.

Comment thread docs/community/mcp-servers/airbyte-knowledge-mcp.md Outdated
Comment thread docs/community/mcp-servers/pyairbyte-mcp.md Outdated
},
items: [
{
type: "link",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The DocCardList element is generated because of this. This isn't really necessary because we already fully highlight this MCP above the DocCardList. How likely is it that we can prevent this from rendering a DocCard on the page?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the Agent MCP link outside the MCP servers category in 9fa6860. That keeps it in the Community sidebar but prevents DocCardList on the MCP landing page from rendering a duplicate Agent MCP card.


Devin session

# MCP servers

Airbyte provides MCP (Model Context Protocol) servers for connecting AI assistants to Airbyte and Airbyte-related context.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Agent MCP

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this heading in 9fa6860.


Devin session

@@ -1,8 +1,8 @@
# Airbyte knowledge MCP server

@ian-at-airbyte Ian Alton (ian-at-airbyte) May 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add frontmatter and set the sidebar label to "Knowledge MCP server"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added frontmatter with sidebar_label: Knowledge MCP server in 9fa6860.


Devin session

@ian-at-airbyte

Copy link
Copy Markdown
Contributor Author

Moving the Agent MCP isn't exactly the right solution. I still want it to be a child of the larger MCP section. I just don't want it to appear in the DocCardList, if possible. Present a plan before implementing.

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Plan before changing anything:

  1. Restore Agent MCP as the first child item inside the mcpServers.items array so it stays nested under the larger MCP servers sidebar section.
  2. Stop using default <DocCardList /> on docs/community/mcp-servers/readme.md, because it renders all children of that sidebar category.
  3. Replace that auto-generated list with an explicit “Other Airbyte MCP servers” set containing only Knowledge MCP server and PyAirbyte MCP. I’d use the existing card/grid style if it looks consistent; otherwise a simple two-link list is the fallback.
  4. Run focused pre-commit plus Docusaurus build, then update the PR description if the implementation details changed.

This keeps the sidebar hierarchy you want while avoiding a duplicate Agent MCP card on the landing page.


Devin session

@ian-at-airbyte

Copy link
Copy Markdown
Contributor Author

Using the custom card component we have seems like the right choice.

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Implemented in f415a34 using the custom card component:

  • Restored Agent MCP as a child of the MCP servers sidebar category.
  • Removed the auto DocCardList from the MCP landing page.
  • Added explicit custom cards for only Knowledge MCP server and PyAirbyte MCP server under “Other Airbyte MCP servers.”

Local validation passed: git diff --check, focused pre-commit, and corepack pnpm clear && corepack pnpm build.


Devin session

@ian-at-airbyte
Ian Alton (ian-at-airbyte) marked this pull request as ready for review May 20, 2026 21:00

</Grid>

## Other Airbyte MCP servers

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:chef-kiss:

@ian-at-airbyte
Ian Alton (ian-at-airbyte) merged commit f91f282 into master May 21, 2026
60 of 63 checks passed
@ian-at-airbyte
Ian Alton (ian-at-airbyte) deleted the devin/1779221733-agentic-1656-mcp-docs branch May 21, 2026 02:31
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