abhishekbhakat/airflow-mcp-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme with latest options

Browse Source
This commit is contained in:
abhishekbhakat
2025-02-23 17:33:05 +00:00
parent 6e4e3279fc
commit e5d4ba7ddf
2 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -21,7 +21,6 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
"airflow-mcp-server" "airflow-mcp-server"
], ],
"env": { "env": {
"OPENAPI_SPEC": "<path_to_spec.yaml>",
"AIRFLOW_BASE_URL": "http://<host:port>/api/v1", "AIRFLOW_BASE_URL": "http://<host:port>/api/v1",
"AUTH_TOKEN": "<base64_encoded_username_password>" "AUTH_TOKEN": "<base64_encoded_username_password>"
} }
@@ -30,12 +29,13 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
} }
``` ```
> You can download the openapi spec from [Airflow REST API](https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html)
# Scope # Scope
2 different streams in which Airflow MCP Server can be used: 2 different streams in which Airflow MCP Server can be used:
- Adding Airflow to AI (_complete access to an Airflow deployment_) - Adding Airflow to AI (_complete access to an Airflow deployment_)
- This will enable AI to be able to write DAGs and just do things in a schedule on its own. - This will enable AI to be able to write DAGs and just do things in a schedule on its own.
- Use command `airflow-mcp-server` or `airflow-mcp-server --unsafe`.
- Adding AI to Airflow (_read-only access using Airflow Plugin_) - Adding AI to Airflow (_read-only access using Airflow Plugin_)
- This stream can enable Users to be able to get a better understanding about their deployment. Specially in cases where teams have hundreds, if not thousands of dags. - This stream can enable Users to be able to get a better understanding about their deployment. Specially in cases where teams have hundreds, if not thousands of dags.
- Use command `airflow-mcp-server --safe`.

20
airflow-mcp-server/README.md
View File

@@ -18,7 +18,6 @@ A [Model Context Protocol](https://modelcontextprotocol.io/) server for controll
"airflow-mcp-server" "airflow-mcp-server"
], ],
"env": { "env": {
"OPENAPI_SPEC": "<path_to_spec.yaml>",
"AIRFLOW_BASE_URL": "http://<host:port>/api/v1", "AIRFLOW_BASE_URL": "http://<host:port>/api/v1",
"AUTH_TOKEN": "<base64_encoded_username_password>" "AUTH_TOKEN": "<base64_encoded_username_password>"
} }
@@ -27,13 +26,29 @@ A [Model Context Protocol](https://modelcontextprotocol.io/) server for controll
} }
``` ```
### Operation Modes
The server supports two operation modes:
- **Safe Mode** (`--safe`): Only allows read-only operations (GET requests). This is useful when you want to prevent any modifications to your Airflow instance.
- **Unsafe Mode** (`--unsafe`): Allows all operations including modifications. This is the default mode.
To start in safe mode:
```bash
airflow-mcp-server --safe
```
To explicitly start in unsafe mode (though this is default):
```bash
airflow-mcp-server --unsafe
```
### Considerations ### Considerations
The MCP Server expects environment variables to be set: The MCP Server expects environment variables to be set:
- `AIRFLOW_BASE_URL`: The base URL of the Airflow API - `AIRFLOW_BASE_URL`: The base URL of the Airflow API
- `AUTH_TOKEN`: The token to use for authorization (_This should be base64 encoded username:password_) - `AUTH_TOKEN`: The token to use for authorization (_This should be base64 encoded username:password_)
- `OPENAPI_SPEC`: The path to the OpenAPI spec file - `OPENAPI_SPEC`: The path to the OpenAPI spec file (_Optional_) (_defaults to latest stable release_)
*Currently, only Basic Auth is supported.* *Currently, only Basic Auth is supported.*
@@ -45,6 +60,7 @@ The default is 100 items, but you can change it using `maximum_page_limit` optio
- [x] First API - [x] First API
- [x] Parse OpenAPI Spec - [x] Parse OpenAPI Spec
- [x] Safe/Unsafe mode implementation
- [ ] Parse proper description with list_tools. - [ ] Parse proper description with list_tools.
- [ ] Airflow config fetch (_specifically for page limit_) - [ ] Airflow config fetch (_specifically for page limit_)
- [ ] Env variables optional (_env variables might not be ideal for airflow plugins_) - [ ] Env variables optional (_env variables might not be ideal for airflow plugins_)