Skip to content

Commit bece287

Browse files
docs: Link to PyAirbyte MCP docs instead of duplicating content (#69186)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 855dc52 commit bece287

File tree

1 file changed

+19
-68
lines changed

1 file changed

+19
-68
lines changed

docs/ai-agents/pyairbyte-mcp.md

Lines changed: 19 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -9,84 +9,35 @@ products: embedded
99
1010
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.
1111

12-
## Getting Started with PyAirbyte MCP
12+
## Documentation
1313

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:
1515

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)**
1917

20-
### Step 1: Generate a Dotenv Secrets File
18+
The PyAirbyte documentation includes:
2119

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
2326

24-
Create a file named `~/.mcp/airbyte_mcp.env` with the following content:
27+
## Quick Start
2528

26-
```ini
27-
# Airbyte Project Artifacts Directory
28-
AIRBYTE_PROJECT_DIR=/path/to/any/writeable/project-dir
29+
To get started with the PyAirbyte MCP server:
2930

30-
# Airbyte Cloud Credentials (Required for Airbyte Cloud Operations)
31-
AIRBYTE_CLOUD_CLIENT_ID=your_api_key
32-
AIRBYTE_CLOUD_CLIENT_SECRET=your_api_secret
33-
AIRBYTE_CLOUD_WORKSPACE_ID=your_workspace_id
31+
1. Install `uv`: `brew install uv`
32+
2. Create a dotenv secrets file with your Airbyte Cloud credentials and connector configurations
33+
3. Register the MCP server with your MCP client using `uvx --python=3.11 --from=airbyte@latest airbyte-mcp`
34+
4. Test the connection using your MCP client
3435

35-
# API-Specific Credentials (Optional, depending on your connectors)
36+
For detailed instructions on each step, see the [PyAirbyte MCP documentation](https://airbytehq.github.io/PyAirbyte/airbyte/mcp.html).
3637

37-
# For example, for a PostgreSQL source connector:
38-
# POSTGRES_HOST=your_postgres_host
39-
# POSTGRES_PORT=5432
40-
# POSTGRES_DB=your_database_name
41-
# POSTGRES_USER=your_database_user
42-
# POSTGRES_PASSWORD=your_database_password
38+
## Helpful Prompts
4339

44-
# For example, for a Stripe source connector:
45-
# STRIPE_API_KEY=your_stripe_api_key
46-
# STRIPE_API_SECRET=your_stripe_api_secret
47-
# STRIPE_WEBHOOK_SECRET=your_stripe_webhook_secret
48-
```
49-
50-
Note:
51-
52-
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.
62-
63-
```json
64-
{
65-
"mcpServers": {
66-
"airbyte": {
67-
"command": "uvx",
68-
"args": [
69-
"--python=3.11",
70-
"--from=airbyte@latest",
71-
"airbyte-mcp"
72-
],
73-
"env": {
74-
"AIRBYTE_MCP_ENV_FILE": "/path/to/my/.mcp/airbyte_mcp.env"
75-
}
76-
}
77-
}
78-
}
79-
```
80-
81-
Note:
82-
83-
- Replace `/path/to/my/.mcp/airbyte_mcp.env` with the absolute path to your dotenv file created in Step 1.
84-
85-
### Step 3: Testing the MCP Server Connection
86-
87-
You can test the MCP server connection using your MCP client.
88-
89-
Helpful prompts to try:
40+
Here are some things you can do with the PyAirbyte MCP server, across local and Airbyte Cloud use cases:
9041

9142
1. "Use your MCP tools to list all available Airbyte connectors."
9243
2. "Use your MCP tools to get information about the Airbyte Stripe connector."

0 commit comments

Comments
 (0)