From 681e0b94b662488feef699c0826df5ef6566d3b6 Mon Sep 17 00:00:00 2001
From: abhishekbhakat <abhishek.bhakat@hotmail.com>
Date: Fri, 14 Feb 2025 11:55:46 +0000
Subject: [PATCH] Update README with install instructions

---
 airflow-mcp-server/README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/airflow-mcp-server/README.md b/airflow-mcp-server/README.md
index 125177c..baf3015 100644
--- a/airflow-mcp-server/README.md
+++ b/airflow-mcp-server/README.md
@@ -5,11 +5,36 @@
 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
 
 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 authorization (_This should be base64 encoded username:password_)
+- `OPENAPI_SPEC`: The path to the OpenAPI spec file
 
 *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] Parse OpenAPI Spec
-- [ ] Parse proper description with listing tools.
+- [ ] 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_)