13 Commits

14 changed files with 152 additions and 94 deletions

View File

@@ -22,7 +22,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[test]
pip install .[dev]
- name: Run pytest
run: |

View File

@@ -29,7 +29,10 @@ https://github.com/user-attachments/assets/f3e60fff-8680-4dd9-b08e-fa7db655a705
],
"env": {
"AIRFLOW_BASE_URL": "http://<host:port>/api/v1",
"AUTH_TOKEN": "<base64_encoded_username_password>"
// Either use AUTH_TOKEN for basic auth
"AUTH_TOKEN": "<base64_encoded_username_password>",
// Or use COOKIE for cookie-based auth
"COOKIE": "<session_cookie>"
}
}
}
@@ -57,10 +60,17 @@ airflow-mcp-server --unsafe
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_)
- `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_)
*Currently, only Basic Auth is supported.*
**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.
**Page Limit**
@@ -71,6 +81,7 @@ The default is 100 items, but you can change it using `maximum_page_limit` optio
- [x] First API
- [x] 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_)

View File

@@ -1,6 +1,6 @@
[project]
name = "airflow-mcp-server"
version = "0.3.0"
version = "0.5.0"
description = "MCP Server for Airflow"
readme = "README.md"
requires-python = ">=3.11"

View File

@@ -1,9 +1,11 @@
import asyncio
import logging
import os
import sys
import click
from airflow_mcp_server.config import AirflowConfig
from airflow_mcp_server.server_safe import serve as serve_safe
from airflow_mcp_server.server_unsafe import serve as serve_unsafe
@@ -12,7 +14,11 @@ from airflow_mcp_server.server_unsafe import serve as serve_unsafe
@click.option("-v", "--verbose", count=True, help="Increase verbosity")
@click.option("--safe", "-s", is_flag=True, help="Use only read-only tools")
@click.option("--unsafe", "-u", is_flag=True, help="Use all tools (default)")
def main(verbose: int, safe: bool, unsafe: bool) -> None:
@click.option("--base-url", help="Airflow API base URL")
@click.option("--spec-path", help="Path to OpenAPI spec file")
@click.option("--auth-token", help="Authentication token")
@click.option("--cookie", help="Session cookie")
def main(verbose: int, safe: bool, unsafe: bool, base_url: str = None, spec_path: str = None, auth_token: str = None, cookie: str = None) -> None:
"""MCP server for Airflow"""
logging_level = logging.WARN
if verbose == 1:
@@ -22,13 +28,30 @@ def main(verbose: int, safe: bool, unsafe: bool) -> None:
logging.basicConfig(level=logging_level, stream=sys.stderr)
if safe and unsafe:
raise click.UsageError("Options --safe and --unsafe are mutually exclusive")
# Read environment variables with proper precedence
# Environment variables take precedence over CLI arguments
config_base_url = os.environ.get("AIRFLOW_BASE_URL") or base_url
config_spec_path = os.environ.get("OPENAPI_SPEC") or spec_path
config_auth_token = os.environ.get("AUTH_TOKEN") or auth_token
config_cookie = os.environ.get("COOKIE") or cookie
if safe:
asyncio.run(serve_safe())
else: # Default to unsafe mode
asyncio.run(serve_unsafe())
# Initialize configuration
try:
config = AirflowConfig(base_url=config_base_url, spec_path=config_spec_path, auth_token=config_auth_token, cookie=config_cookie)
except ValueError as e:
click.echo(f"Configuration error: {e}", err=True)
sys.exit(1)
# Determine server mode with proper precedence
if safe and unsafe:
# CLI argument validation
raise click.UsageError("Options --safe and --unsafe are mutually exclusive")
elif safe:
# CLI argument for safe mode
asyncio.run(serve_safe(config))
else:
# Default to unsafe mode
asyncio.run(serve_unsafe(config))
if __name__ == "__main__":

View File

@@ -102,11 +102,11 @@ class AirflowClient:
self.base_url = base_url.rstrip("/")
self.headers = {"Accept": "application/json"}
# Set authentication header based on what was provided
if auth_token:
self.headers["Authorization"] = f"Basic {auth_token}"
elif cookie:
# Set authentication header based on precedence (cookie > auth_token)
if cookie:
self.headers["Cookie"] = cookie
elif auth_token:
self.headers["Authorization"] = f"Basic {auth_token}"
except Exception as e:
logger.error("Failed to initialize AirflowClient: %s", e)

View File

@@ -0,0 +1,25 @@
class AirflowConfig:
"""Centralized configuration for Airflow MCP server."""
def __init__(self, base_url: str | None = None, spec_path: str | None = None, auth_token: str | None = None, cookie: str | None = None) -> None:
"""Initialize configuration with provided values.
Args:
base_url: Airflow API base URL
spec_path: Path to OpenAPI spec file
auth_token: Authentication token
cookie: Session cookie
Raises:
ValueError: If required configuration is missing
"""
self.base_url = base_url
if not self.base_url:
raise ValueError("Missing required configuration: base_url")
self.spec_path = spec_path
self.auth_token = auth_token
self.cookie = cookie
if not self.auth_token and not self.cookie:
raise ValueError("Either auth_token or cookie must be provided")

View File

@@ -20,6 +20,7 @@ class OperationDetails:
method: str
parameters: dict[str, Any]
input_model: type[BaseModel]
description: str
class OperationParser:
@@ -104,6 +105,7 @@ class OperationParser:
operation["path"] = path
operation["path_item"] = path_item
description = operation.get("description") or operation.get("summary") or operation_id
parameters = self.extract_parameters(operation)
@@ -119,7 +121,7 @@ class OperationParser:
# Create unified input model
input_model = self._create_input_model(operation_id, parameters, body_schema)
return OperationDetails(operation_id=operation_id, path=str(path), method=method, parameters=parameters, input_model=input_model)
return OperationDetails(operation_id=operation_id, path=str(path), method=method, parameters=parameters, description=description, input_model=input_model)
raise ValueError(f"Operation {operation_id} not found in spec")

View File

@@ -1,11 +1,11 @@
import logging
import os
from typing import Any
from mcp.server import Server
from mcp.server.stdio import stdio_server
from mcp.types import TextContent, Tool
from airflow_mcp_server.config import AirflowConfig
from airflow_mcp_server.tools.tool_manager import get_airflow_tools, get_tool
# ===========THIS IS FOR DEBUGGING WITH MCP INSPECTOR===================
@@ -20,25 +20,18 @@ from airflow_mcp_server.tools.tool_manager import get_airflow_tools, get_tool
logger = logging.getLogger(__name__)
async def serve() -> None:
"""Start MCP server."""
# Check for AIRFLOW_BASE_URL which is always required
if "AIRFLOW_BASE_URL" not in os.environ:
raise ValueError("Missing required environment variable: AIRFLOW_BASE_URL")
# Check for either AUTH_TOKEN or COOKIE
has_auth_token = "AUTH_TOKEN" in os.environ
has_cookie = "COOKIE" in os.environ
if not has_auth_token and not has_cookie:
raise ValueError("Either AUTH_TOKEN or COOKIE environment variable must be provided")
async def serve(config: AirflowConfig) -> None:
"""Start MCP server.
Args:
config: Configuration object with auth and URL settings
"""
server = Server("airflow-mcp-server")
@server.list_tools()
async def list_tools() -> list[Tool]:
try:
return await get_airflow_tools()
return await get_airflow_tools(config)
except Exception as e:
logger.error("Failed to list tools: %s", e)
raise
@@ -46,7 +39,7 @@ async def serve() -> None:
@server.call_tool()
async def call_tool(name: str, arguments: dict[str, Any]) -> list[TextContent]:
try:
tool = await get_tool(name)
tool = await get_tool(config, name)
async with tool.client:
result = await tool.run(body=arguments)
return [TextContent(type="text", text=str(result))]

View File

@@ -1,35 +1,28 @@
import logging
import os
from typing import Any
from mcp.server import Server
from mcp.server.stdio import stdio_server
from mcp.types import TextContent, Tool
from airflow_mcp_server.config import AirflowConfig
from airflow_mcp_server.tools.tool_manager import get_airflow_tools, get_tool
logger = logging.getLogger(__name__)
async def serve() -> None:
"""Start MCP server in safe mode (read-only operations)."""
# Check for AIRFLOW_BASE_URL which is always required
if "AIRFLOW_BASE_URL" not in os.environ:
raise ValueError("Missing required environment variable: AIRFLOW_BASE_URL")
# Check for either AUTH_TOKEN or COOKIE
has_auth_token = "AUTH_TOKEN" in os.environ
has_cookie = "COOKIE" in os.environ
if not has_auth_token and not has_cookie:
raise ValueError("Either AUTH_TOKEN or COOKIE environment variable must be provided")
async def serve(config: AirflowConfig) -> None:
"""Start MCP server in safe mode (read-only operations).
Args:
config: Configuration object with auth and URL settings
"""
server = Server("airflow-mcp-server-safe")
@server.list_tools()
async def list_tools() -> list[Tool]:
try:
return await get_airflow_tools(mode="safe")
return await get_airflow_tools(config, mode="safe")
except Exception as e:
logger.error("Failed to list tools: %s", e)
raise
@@ -39,7 +32,7 @@ async def serve() -> None:
try:
if not name.startswith("get_"):
raise ValueError("Only GET operations allowed in safe mode")
tool = await get_tool(name)
tool = await get_tool(config, name)
async with tool.client:
result = await tool.run(body=arguments)
return [TextContent(type="text", text=str(result))]

View File

@@ -1,35 +1,28 @@
import logging
import os
from typing import Any
from mcp.server import Server
from mcp.server.stdio import stdio_server
from mcp.types import TextContent, Tool
from airflow_mcp_server.config import AirflowConfig
from airflow_mcp_server.tools.tool_manager import get_airflow_tools, get_tool
logger = logging.getLogger(__name__)
async def serve() -> None:
"""Start MCP server in unsafe mode (all operations)."""
# Check for AIRFLOW_BASE_URL which is always required
if "AIRFLOW_BASE_URL" not in os.environ:
raise ValueError("Missing required environment variable: AIRFLOW_BASE_URL")
# Check for either AUTH_TOKEN or COOKIE
has_auth_token = "AUTH_TOKEN" in os.environ
has_cookie = "COOKIE" in os.environ
if not has_auth_token and not has_cookie:
raise ValueError("Either AUTH_TOKEN or COOKIE environment variable must be provided")
async def serve(config: AirflowConfig) -> None:
"""Start MCP server in unsafe mode (all operations).
Args:
config: Configuration object with auth and URL settings
"""
server = Server("airflow-mcp-server-unsafe")
@server.list_tools()
async def list_tools() -> list[Tool]:
try:
return await get_airflow_tools(mode="unsafe")
return await get_airflow_tools(config, mode="unsafe")
except Exception as e:
logger.error("Failed to list tools: %s", e)
raise
@@ -37,7 +30,7 @@ async def serve() -> None:
@server.call_tool()
async def call_tool(name: str, arguments: dict[str, Any]) -> list[TextContent]:
try:
tool = await get_tool(name)
tool = await get_tool(config, name)
async with tool.client:
result = await tool.run(body=arguments)
return [TextContent(type="text", text=str(result))]

View File

@@ -1,6 +1,7 @@
from abc import ABC, abstractmethod
from typing import Any
class BaseTools(ABC):
"""Abstract base class for tools."""

View File

@@ -1,10 +1,10 @@
import logging
import os
from importlib import resources
from mcp.types import Tool
from airflow_mcp_server.client.airflow_client import AirflowClient
from airflow_mcp_server.config import AirflowConfig
from airflow_mcp_server.parser.operation_parser import OperationParser
from airflow_mcp_server.tools.airflow_tool import AirflowTool
@@ -13,16 +13,19 @@ logger = logging.getLogger(__name__)
_tools_cache: dict[str, AirflowTool] = {}
def _initialize_client() -> AirflowClient:
"""Initialize Airflow client with environment variables or embedded spec.
def _initialize_client(config: AirflowConfig) -> AirflowClient:
"""Initialize Airflow client with configuration.
Args:
config: Configuration object with auth and URL settings
Returns:
AirflowClient instance
Raises:
ValueError: If required environment variables are missing or default spec is not found
ValueError: If default spec is not found
"""
spec_path = os.environ.get("OPENAPI_SPEC")
spec_path = config.spec_path
if not spec_path:
# Fallback to embedded v1.yaml
try:
@@ -32,39 +35,33 @@ def _initialize_client() -> AirflowClient:
except Exception as e:
raise ValueError("Default OpenAPI spec not found in package resources") from e
# Check for base URL
if "AIRFLOW_BASE_URL" not in os.environ:
raise ValueError("Missing required environment variable: AIRFLOW_BASE_URL")
# Check for either AUTH_TOKEN or COOKIE
has_auth_token = "AUTH_TOKEN" in os.environ
has_cookie = "COOKIE" in os.environ
if not has_auth_token and not has_cookie:
raise ValueError("Either AUTH_TOKEN or COOKIE environment variable must be provided")
# Initialize client with appropriate authentication method
client_args = {"spec_path": spec_path, "base_url": os.environ["AIRFLOW_BASE_URL"]}
client_args = {"spec_path": spec_path, "base_url": config.base_url}
if has_auth_token:
client_args["auth_token"] = os.environ["AUTH_TOKEN"]
elif has_cookie:
client_args["cookie"] = os.environ["COOKIE"]
# Apply cookie auth first if available (highest precedence)
if config.cookie:
client_args["cookie"] = config.cookie
# Otherwise use auth token if available
elif config.auth_token:
client_args["auth_token"] = config.auth_token
return AirflowClient(**client_args)
async def _initialize_tools() -> None:
async def _initialize_tools(config: AirflowConfig) -> None:
"""Initialize tools cache with Airflow operations.
Args:
config: Configuration object with auth and URL settings
Raises:
ValueError: If initialization fails
"""
global _tools_cache
try:
client = _initialize_client()
spec_path = os.environ.get("OPENAPI_SPEC")
client = _initialize_client(config)
spec_path = config.spec_path
if not spec_path:
with resources.files("airflow_mcp_server.resources").joinpath("v1.yaml").open("rb") as f:
spec_path = f.name
@@ -82,10 +79,11 @@ async def _initialize_tools() -> None:
raise ValueError(f"Failed to initialize tools: {e}") from e
async def get_airflow_tools(mode: str = "unsafe") -> list[Tool]:
async def get_airflow_tools(config: AirflowConfig, mode: str = "unsafe") -> list[Tool]:
"""Get list of available Airflow tools based on mode.
Args:
config: Configuration object with auth and URL settings
mode: "safe" for GET operations only, "unsafe" for all operations (default)
Returns:
@@ -95,7 +93,7 @@ async def get_airflow_tools(mode: str = "unsafe") -> list[Tool]:
ValueError: If initialization fails
"""
if not _tools_cache:
await _initialize_tools()
await _initialize_tools(config)
tools = []
for operation_id, tool in _tools_cache.items():
@@ -107,7 +105,7 @@ async def get_airflow_tools(mode: str = "unsafe") -> list[Tool]:
tools.append(
Tool(
name=operation_id,
description=tool.operation.operation_id,
description=tool.operation.description,
inputSchema=schema,
)
)
@@ -118,10 +116,11 @@ async def get_airflow_tools(mode: str = "unsafe") -> list[Tool]:
return tools
async def get_tool(name: str) -> AirflowTool:
async def get_tool(config: AirflowConfig, name: str) -> AirflowTool:
"""Get specific tool by name.
Args:
config: Configuration object with auth and URL settings
name: Tool/operation name
Returns:
@@ -132,7 +131,7 @@ async def get_tool(name: str) -> AirflowTool:
ValueError: If tool initialization fails
"""
if not _tools_cache:
await _initialize_tools()
await _initialize_tools(config)
if name not in _tools_cache:
raise KeyError(f"Tool {name} not found")

View File

@@ -31,6 +31,24 @@ def test_parse_operation_basic(parser: OperationParser) -> None:
assert operation.operation_id == "get_dags"
assert operation.path == "/dags"
assert operation.method == "get"
assert (
operation.description
== """List DAGs in the database.
`dag_id_pattern` can be set to match dags of a specific pattern
"""
)
assert isinstance(operation.parameters, dict)
def test_parse_operation_with_no_description_but_summary(parser: OperationParser) -> None:
"""Test parsing operation with no description but summary."""
operation = parser.parse_operation("get_connections")
assert isinstance(operation, OperationDetails)
assert operation.operation_id == "get_connections"
assert operation.path == "/connections"
assert operation.method == "get"
assert operation.description == "List connections"
assert isinstance(operation.parameters, dict)

2
uv.lock generated
View File

@@ -111,7 +111,7 @@ wheels = [
[[package]]
name = "airflow-mcp-server"
version = "0.2.0"
version = "0.4.0"
source = { editable = "." }
dependencies = [
{ name = "aiofiles" },