Airflow 3 readiness initial commit
This commit is contained in:
31
README.md
31
README.md
@@ -6,7 +6,6 @@
|
||||
<img width="380" height="200" src="https://glama.ai/mcp/servers/6gjq9w80xr/badge" />
|
||||
</a>
|
||||
|
||||
|
||||
## Overview
|
||||
A [Model Context Protocol](https://modelcontextprotocol.io/) server for controlling Airflow via Airflow APIs.
|
||||
|
||||
@@ -14,7 +13,6 @@ A [Model Context Protocol](https://modelcontextprotocol.io/) server for controll
|
||||
|
||||
https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
|
||||
|
||||
|
||||
## Setup
|
||||
|
||||
### Usage with Claude Desktop
|
||||
@@ -28,17 +26,19 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
|
||||
"airflow-mcp-server"
|
||||
],
|
||||
"env": {
|
||||
"AIRFLOW_BASE_URL": "http://<host:port>/api/v1",
|
||||
// Either use AUTH_TOKEN for basic auth
|
||||
"AUTH_TOKEN": "<base64_encoded_username_password>",
|
||||
// Or use COOKIE for cookie-based auth
|
||||
"COOKIE": "<session_cookie>"
|
||||
"AIRFLOW_BASE_URL": "http://<host:port>",
|
||||
"AUTH_TOKEN": "<jwt_access_token>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> **Note:**
|
||||
> - Set `AIRFLOW_BASE_URL` to the root Airflow URL (e.g., `http://localhost:8080`).
|
||||
> - Do **not** include `/api/v1` 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.
|
||||
|
||||
### Operation Modes
|
||||
|
||||
The server supports two operation modes:
|
||||
@@ -59,18 +59,12 @@ airflow-mcp-server --unsafe
|
||||
### Considerations
|
||||
|
||||
The MCP Server expects environment variables to be set:
|
||||
- `AIRFLOW_BASE_URL`: The base URL of the Airflow API
|
||||
- `AUTH_TOKEN`: The token to use for basic auth (_This should be base64 encoded username:password_) (_Optional if COOKIE is provided_)
|
||||
- `COOKIE`: The session cookie to use for authentication (_Optional if AUTH_TOKEN is provided_)
|
||||
- `OPENAPI_SPEC`: The path to the OpenAPI spec file (_Optional_) (_defaults to latest stable release_)
|
||||
- `AIRFLOW_BASE_URL`: The root URL of the Airflow instance (e.g., `http://localhost:8080`)
|
||||
- `AUTH_TOKEN`: The JWT access token for authentication
|
||||
|
||||
**Authentication**
|
||||
|
||||
The server supports two authentication methods:
|
||||
- **Basic Auth**: Using base64 encoded username:password via `AUTH_TOKEN` environment variable
|
||||
- **Cookie**: Using session cookie via `COOKIE` environment variable
|
||||
|
||||
At least one of these authentication methods must be provided.
|
||||
- Only JWT authentication is supported in Airflow 3.0. You must provide a valid `AUTH_TOKEN`.
|
||||
|
||||
**Page Limit**
|
||||
|
||||
@@ -78,10 +72,9 @@ The default is 100 items, but you can change it using `maximum_page_limit` optio
|
||||
|
||||
## Tasks
|
||||
|
||||
- [x] First API
|
||||
- [x] Parse OpenAPI Spec
|
||||
- [ ] Airflow 3 readiness
|
||||
- [ ] Parse OpenAPI Spec
|
||||
- [x] Safe/Unsafe mode implementation
|
||||
- [x] Allow session auth
|
||||
- [ ] Parse proper description with list_tools.
|
||||
- [ ] Airflow config fetch (_specifically for page limit_)
|
||||
- [ ] Env variables optional (_env variables might not be ideal for airflow plugins_)
|
||||
|
||||
Reference in New Issue
Block a user