e57ab8cb0c
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
# PyAirbyte MCP Server
|
|
|
|
:::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.
|
|
|
|
## Documentation
|
|
|
|
For complete setup instructions, troubleshooting guidance, and detailed documentation, please refer to the authoritative PyAirbyte MCP documentation:
|
|
|
|
**[PyAirbyte MCP Server Documentation](https://airbytehq.github.io/PyAirbyte/airbyte/mcp.html)**
|
|
|
|
The PyAirbyte documentation includes:
|
|
|
|
- Step-by-step setup instructions
|
|
- Environment configuration requirements
|
|
- Security model and safety features
|
|
- Troubleshooting guide with common issues and solutions
|
|
- Architecture overview
|
|
- Prerequisites checklist
|
|
|
|
## Quick Start
|
|
|
|
To get started with the PyAirbyte MCP server:
|
|
|
|
1. Install `uv`: `brew install uv`
|
|
2. Create a dotenv secrets file with your Airbyte Cloud credentials and connector configurations
|
|
3. Register the MCP server with your MCP client using `uvx --python=3.11 --from=airbyte@latest airbyte-mcp`
|
|
4. Test the connection using your MCP client
|
|
|
|
For detailed instructions on each step, see the [PyAirbyte MCP documentation](https://airbytehq.github.io/PyAirbyte/airbyte/mcp.html).
|
|
|
|
## Helpful Prompts
|
|
|
|
Here are some things you can do with the PyAirbyte MCP server, across local and Airbyte Cloud use cases:
|
|
|
|
1. "Use your MCP tools to list all available Airbyte connectors."
|
|
2. "Use your MCP tools to get information about the Airbyte Stripe connector."
|
|
3. "Use your MCP tools to list all variables you have access to in the dotenv secrets file."
|
|
4. "Use your MCP tools to check your connection to your Airbyte Cloud workspace."
|
|
5. "Use your MCP tools to list all available destinations in my Airbyte Cloud workspace."
|
|
|
|
## Contributing to the Airbyte MCP Server
|
|
|
|
- [PyAirbyte Contributing Guide](https://github.com/airbytehq/PyAirbyte/blob/main/docs/CONTRIBUTING.md)
|
|
|
|
### Additional resources
|
|
|
|
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
|
|
|
|
For issues and questions:
|
|
|
|
- [PyAirbyte GitHub Issues](https://github.com/airbytehq/pyairbyte/issues)
|
|
- [PyAirbyte Discussions](https://github.com/airbytehq/pyairbyte/discussions)
|