Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion airbyte/_util/meta.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ def set_mcp_mode() -> None:
proper detection and prevent interactive prompts.
"""
print(
f"Running in MCP mode: PyAirbyte MCP v{get_version()} (Python v{python_version()})",
"Running in MCP mode: "
f"Airbyte Replication MCP v{get_version()} (Python v{python_version()})",
file=sys.stderr,
)
global _MCP_MODE_ENABLED
Expand Down
20 changes: 10 additions & 10 deletions airbyte/mcp/__init__.py
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.

r"""***PyAirbyte MCP Server - Model Context Protocol Integration***
r"""***Airbyte Replication MCP Server - Model Context Protocol Integration***

> **NOTE:**
> This MCP server implementation is experimental and may change without notice between minor
> versions of PyAirbyte. The API may be modified or entirely refactored in future versions.

The PyAirbyte MCP (Model Context Protocol) server provides a standardized interface for
managing Airbyte connectors through MCP-compatible clients. This experimental feature
allows you to list connectors, validate configurations, and run sync operations using
the MCP protocol.
The Airbyte Replication MCP (Model Context Protocol) server provides a standardized interface
for managing Airbyte connectors through MCP-compatible clients. This PyAirbyte-powered
experimental feature allows you to list connectors, validate configurations, and run sync
operations using the MCP protocol.

## Getting Started with PyAirbyte MCP
## Getting Started with Airbyte Replication MCP

To get started with the PyAirbyte MCP server, follow these steps:
To get started with the Airbyte Replication MCP server, follow these steps:

1. Create a Dotenv secrets file.
2. Register the MCP server with your MCP client.
3. Test the MCP server connection using your MCP client.

### Step 1: Generate a Dotenv Secrets File

To get started with the PyAirbyte MCP server, you will need to create a dotenv
To get started with the Airbyte Replication MCP server, you will need to create a dotenv
file containing your Airbyte Cloud credentials, as well as credentials for any
third-party services you wish to connect to via Airbyte.

Expand Down Expand Up @@ -113,8 +113,8 @@

## Airbyte Cloud MCP Server Safety

The PyAirbyte MCP server supports environment variables to control safety and access levels for
Airbyte Cloud operations.
The Airbyte Replication MCP server supports environment variables to control safety and access
levels for Airbyte Cloud operations.

**Important:** The below settings only affect Cloud operations; local operations are not affected.

Expand Down
2 changes: 1 addition & 1 deletion airbyte/mcp/prompts.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
"""MCP prompt definitions for the PyAirbyte MCP server.
"""MCP prompt definitions for the Airbyte Replication MCP server.

This module defines prompts that can be invoked by MCP clients to perform
common workflows.
Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ To pin your GitHub actions, you can use the [pinact](https://github.com/suzuki-s
pinact run [optional_file]
```

## Contributing to the PyAirbyte MCP Server
## Contributing to the Airbyte Replication MCP Server

The Airbyte MCP server is part of the PyAirbyte project. Contributions are welcome!

Expand Down Expand Up @@ -118,7 +118,7 @@ In your MCP config, you can test your development updates using `uv` as the entr

### Testing MCP Tools

The easiest way to test PyAirbyte MCP tools during development is using the built-in Poe tasks.
The easiest way to test Airbyte Replication MCP tools during development is using the built-in Poe tasks.

```bash
poe mcp-tool-test <tool_name> '<json_args>'
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate_mcp_markdown.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
# Copyright (c) 2026 Airbyte, Inc., all rights reserved.
"""Generate Markdown documentation for the PyAirbyte MCP server.
"""Generate Markdown documentation for the Airbyte Replication MCP server.

Runs `fastmcp inspect` against the default `airbyte/mcp/server.py:app` spec
(override with `--server-spec`) to obtain the full FastMCP protocol surface
Expand Down
Loading