|
86 | 86 | ], |
87 | 87 | "env": { |
88 | 88 | "AIRBYTE_MCP_ENV_FILE": "/path/to/my/.mcp/airbyte_mcp.env", |
89 | | - "AIRBYTE_CLOUD_MCP_READONLY_MODE": "0", |
90 | | - "AIRBYTE_CLOUD_MCP_SAFE_MODE": "0" |
| 89 | + "AIRBYTE_CLOUD_MCP_SAFE_MODE": "1", |
| 90 | + "AIRBYTE_CLOUD_MCP_READONLY_MODE": "0" |
91 | 91 | } |
92 | 92 | } |
93 | 93 | } |
|
97 | 97 | Note: |
98 | 98 | - Replace `/path/to/my/.mcp/airbyte_mcp.env` with the absolute path to your dotenv file created in |
99 | 99 | Step 1. |
100 | | -- The `AIRBYTE_CLOUD_MCP_READONLY_MODE` and `AIRBYTE_CLOUD_MCP_SAFE_MODE` environment variables |
101 | | - control safe mode filtering for Airbyte Cloud operations: |
102 | | - - `AIRBYTE_CLOUD_MCP_READONLY_MODE=1`: Only read-only Cloud tools are available. Write and |
103 | | - destructive operations are disabled. Note: This mode does allow running syncs on existing |
104 | | - connectors. |
105 | | - - `AIRBYTE_CLOUD_MCP_SAFE_MODE=1`: Write operations are allowed, but destructive operations |
106 | | - (update, delete) are disabled. |
107 | | - - Both default to `0` (disabled), which means no restrictions are applied. |
108 | | - - These settings only affect Cloud operations; local operations are never restricted. |
109 | 100 |
|
110 | 101 | ### Step 3: Testing the MCP Server Connection |
111 | 102 |
|
|
120 | 111 | 4. "Use your MCP tools to check your connection to your Airbyte Cloud workspace." |
121 | 112 | 5. "Use your MCP tools to list all available destinations in my Airbyte Cloud workspace." |
122 | 113 |
|
| 114 | +## Airbyte Cloud MCP Server Safety |
| 115 | +
|
| 116 | +The PyAirbyte MCP server supports environment variables to control safety and access levels for |
| 117 | +Airbyte Cloud operations. |
| 118 | +
|
| 119 | +**Important:** The below settings only affect Cloud operations; local operations are not affected. |
| 120 | +
|
| 121 | +### Airbyte Cloud Safe Mode |
| 122 | +
|
| 123 | +Safe mode is enabled by default and is controlled by the `AIRBYTE_CLOUD_MCP_SAFE_MODE` environment |
| 124 | +variable. |
| 125 | +
|
| 126 | +When enabled, write operations are allowed but destructive operations (updates, deletions) are |
| 127 | +only allowed for objects created within the same session. For example, you can create a new |
| 128 | +connector and then delete it, but you cannot delete an existing connector that was not created in |
| 129 | +the current session. Modifications to configurations are likewise treated as potentially destructive |
| 130 | +and are only allowed for objects created in the current session. |
| 131 | +
|
| 132 | +Set the environment variable `AIRBYTE_CLOUD_MCP_SAFE_MODE=0` to disable safe mode. |
| 133 | +
|
| 134 | +### Airbyte Cloud Read-Only Mode |
| 135 | +
|
| 136 | +Read-only mode is not enabled by default and is controlled by the |
| 137 | +`AIRBYTE_CLOUD_MCP_READONLY_MODE` environment variable. |
| 138 | +
|
| 139 | +When enabled, only read-only Cloud tools are available. Write and destructive operations are |
| 140 | +disabled. |
| 141 | +
|
| 142 | +This mode does allow running syncs on existing connectors, since sync operations |
| 143 | +are not considered to be modifications of the Airbyte Cloud workspace. |
| 144 | +
|
| 145 | +Set the environment variable `AIRBYTE_CLOUD_MCP_READONLY_MODE=1` to enable read-only mode. |
| 146 | +
|
123 | 147 | ## Contributing to the Airbyte MCP Server |
124 | 148 |
|
125 | 149 | - [PyAirbyte Contributing Guide](https://github.com/airbytehq/PyAirbyte/blob/main/docs/CONTRIBUTING.md) |
|
0 commit comments