From 9837afe13aa38717a032a36b7cba816d7ed5d60b Mon Sep 17 00:00:00 2001 From: abhishekbhakat Date: Sun, 4 May 2025 09:24:04 +0000 Subject: [PATCH] fix: update README to reflect changes in environment variable usage and authentication requirements --- README.md | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 557d4d2..037be68 100644 --- a/README.md +++ b/README.md @@ -19,25 +19,25 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705 ```json { - "mcpServers": { - "airflow-mcp-server": { - "command": "uvx", - "args": [ - "airflow-mcp-server" - ], - "env": { - "AIRFLOW_BASE_URL": "http://", - "AUTH_TOKEN": "" - } + "mcpServers": { + "airflow-mcp-server": { + "command": "uvx", + "args": [ + "airflow-mcp-server", + "--base-url", + "http://localhost:8080", + "--auth-token", + "", + ] + } } - } } ``` > **Note:** -> - Set `AIRFLOW_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`. -> - Only `AUTH_TOKEN` (JWT) is required for authentication. Cookie and basic auth are no longer supported in Airflow 3.0. +> - 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 `${base_url}/openapi.json`. +> - Only JWT token is required for authentication. Cookie and basic auth are no longer supported in Airflow 3.0. ### Operation Modes @@ -58,10 +58,6 @@ airflow-mcp-server --unsafe ### 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** - Only JWT authentication is supported in Airflow 3.0. You must provide a valid `AUTH_TOKEN`.