You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ai-agents/pyairbyte-mcp.md
+19-68Lines changed: 19 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,84 +9,35 @@ products: embedded
9
9
10
10
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.
11
11
12
-
## Getting Started with PyAirbyte MCP
12
+
## Documentation
13
13
14
-
To get started with the PyAirbyte MCP server, follow these steps:
14
+
For complete setup instructions, troubleshooting guidance, and detailed documentation, please refer to the authoritative PyAirbyte MCP documentation:
15
15
16
-
1. Create a Dotenv secrets file.
17
-
2. Register the MCP server with your MCP client.
18
-
3. Test the MCP server connection using your MCP client.
16
+
**[PyAirbyte MCP Server Documentation](https://airbytehq.github.io/PyAirbyte/airbyte/mcp.html)**
19
17
20
-
### Step 1: Generate a Dotenv Secrets File
18
+
The PyAirbyte documentation includes:
21
19
22
-
To get started with the PyAirbyte 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.
20
+
- Step-by-step setup instructions
21
+
- Environment configuration requirements
22
+
- Security model and safety features
23
+
- Troubleshooting guide with common issues and solutions
24
+
- Architecture overview
25
+
- Prerequisites checklist
23
26
24
-
Create a file named `~/.mcp/airbyte_mcp.env` with the following content:
1. You can add more environment variables to this file as needed for different connectors. To start, you only need to create the file and pass it to the MCP server.
53
-
2. Ensure that this file is kept secure, as it contains sensitive information. Your LLM *should never* be given direct access to this file or its contents.
54
-
3. The MCP tools will give your LLM the ability to view *which* variables are available, but it does not give access to their values.
55
-
4. The `AIRBYTE_PROJECT_DIR` variable specifies a directory where the MCP server can store temporary project files. Ensure this directory is writable by the user running the MCP server.
56
-
57
-
### Step 2: Registering the MCP Server
58
-
59
-
First install `uv` (`brew install uv`).
60
-
61
-
Then, create a file named `server_config.json` (or the file name required by your MCP client) with the following content. This uses `uvx` (from `brew install uv`) to run the MCP server. If a matching version Python is not yet installed, a `uv`-managed Python version will be installed automatically. This will also auto-update to use the "latest" Airbyte MCP release at time of launch. You can alternatively pin to a specific version of Python and/or of the Airbyte library if you have special requirements.
0 commit comments