test_connection
Verify connectivity to Airflow deployments by testing connection parameters like host, port, and credentials before configuring workflows.
Instructions
Test a connection
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| conn_type | Yes | ||
| host | No | ||
| port | No | ||
| login | No | ||
| password | No | ||
| schema | No | ||
| extra | No |
Implementation Reference
- src/airflow/connection.py:114-140 (handler)The main handler function for the 'test_connection' tool. It constructs a connection request from parameters and calls the Airflow ConnectionApi.test_connection method.
async def test_connection( conn_type: str, host: Optional[str] = None, port: Optional[int] = None, login: Optional[str] = None, password: Optional[str] = None, schema: Optional[str] = None, extra: Optional[str] = None, ) -> List[Union[types.TextContent, types.ImageContent, types.EmbeddedResource]]: connection_request = { "conn_type": conn_type, } if host is not None: connection_request["host"] = host if port is not None: connection_request["port"] = port if login is not None: connection_request["login"] = login if password is not None: connection_request["password"] = password if schema is not None: connection_request["schema"] = schema if extra is not None: connection_request["extra"] = extra response = connection_api.test_connection(connection_request=connection_request) return [types.TextContent(type="text", text=str(response.to_dict()))] - src/airflow/connection.py:11-20 (registration)The get_all_functions in connection.py defines and returns the registration tuple for 'test_connection', which is imported and used in main.py to register the tool.
def get_all_functions() -> list[tuple[Callable, str, str, bool]]: """Return list of (function, name, description, is_read_only) tuples for registration.""" return [ (list_connections, "list_connections", "List all connections", True), (create_connection, "create_connection", "Create a connection", False), (get_connection, "get_connection", "Get a connection by ID", True), (update_connection, "update_connection", "Update a connection by ID", False), (delete_connection, "delete_connection", "Delete a connection by ID", False), (test_connection, "test_connection", "Test a connection", True), ] - src/main.py:90-92 (registration)The generic registration loop in main.py that calls app.add_tool for all functions from modules, including test_connection from connection.py.
for func, name, description, *_ in functions: app.add_tool(func, name=name, description=description)