Update README with install instructions

This commit is contained in:
2025-02-14 11:55:46 +00:00
parent a0c50a8690
commit 681e0b94b6

View File

@@ -5,11 +5,36 @@
A [Model Context Protocol](https://modelcontextprotocol.io/) server for controlling Airflow via Airflow APIs. A [Model Context Protocol](https://modelcontextprotocol.io/) server for controlling Airflow via Airflow APIs.
## Setup
### Usage with Claude Desktop
```json
{
"mcpServers": {
"airflow-mcp-server": {
"command": "uv",
"args": [
"run",
"airflow-mcp-server"
],
"env": {
"OPENAPI_SPEC": "<path_to_spec.yaml>",
"AIRFLOW_BASE_URL": "http://<host:port>/api/v1",
"AUTH_TOKEN": "<base64_encoded_username_password>"
}
}
}
}
```
### 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
*Currently, only Basic Auth is supported.* *Currently, only Basic Auth is supported.*
@@ -21,6 +46,6 @@ 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
- [ ] Parse proper description with listing 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_)