fix: update README to reflect changes in environment variable usage and authentication requirements
This commit is contained in:
32
README.md
32
README.md
@@ -19,25 +19,25 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"airflow-mcp-server": {
|
"airflow-mcp-server": {
|
||||||
"command": "uvx",
|
"command": "uvx",
|
||||||
"args": [
|
"args": [
|
||||||
"airflow-mcp-server"
|
"airflow-mcp-server",
|
||||||
],
|
"--base-url",
|
||||||
"env": {
|
"http://localhost:8080",
|
||||||
"AIRFLOW_BASE_URL": "http://<host:port>",
|
"--auth-token",
|
||||||
"AUTH_TOKEN": "<jwt_access_token>"
|
"<jwt_token>",
|
||||||
}
|
]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:**
|
> **Note:**
|
||||||
> - Set `AIRFLOW_BASE_URL` to the root Airflow URL (e.g., `http://localhost:8080`).
|
> - Set `base_url` to the root Airflow URL (e.g., `http://localhost:8080`).
|
||||||
> - Do **not** include `/api/v2` in the base URL. The server will automatically fetch the OpenAPI spec from `${AIRFLOW_BASE_URL}/openapi.json`.
|
> - Do **not** include `/api/v2` in the base URL. The server will automatically fetch the OpenAPI spec from `${base_url}/openapi.json`.
|
||||||
> - Only `AUTH_TOKEN` (JWT) is required for authentication. Cookie and basic auth are no longer supported in Airflow 3.0.
|
> - Only JWT token is required for authentication. Cookie and basic auth are no longer supported in Airflow 3.0.
|
||||||
|
|
||||||
### Operation Modes
|
### Operation Modes
|
||||||
|
|
||||||
@@ -58,10 +58,6 @@ airflow-mcp-server --unsafe
|
|||||||
|
|
||||||
### Considerations
|
### Considerations
|
||||||
|
|
||||||
The MCP Server expects environment variables to be set:
|
|
||||||
- `AIRFLOW_BASE_URL`: The root URL of the Airflow instance (e.g., `http://localhost:8080`)
|
|
||||||
- `AUTH_TOKEN`: The JWT access token for authentication
|
|
||||||
|
|
||||||
**Authentication**
|
**Authentication**
|
||||||
|
|
||||||
- Only JWT authentication is supported in Airflow 3.0. You must provide a valid `AUTH_TOKEN`.
|
- Only JWT authentication is supported in Airflow 3.0. You must provide a valid `AUTH_TOKEN`.
|
||||||
|
|||||||
Reference in New Issue
Block a user