test_connection
Test connectivity to external systems by validating connection parameters such as host, port, and credentials before deploying workflows.
Instructions
Test a connection
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| conn_type | Yes | ||
| extra | No | ||
| host | No | ||
| login | No | ||
| password | No | ||
| port | No | ||
| schema | No |
Input Schema (JSON Schema)
{
"properties": {
"conn_type": {
"title": "Conn Type",
"type": "string"
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Extra"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"login": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Login"
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Password"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Schema"
}
},
"required": [
"conn_type"
],
"type": "object"
}
Implementation Reference
- src/airflow/connection.py:114-140 (handler)The main handler function for the 'test_connection' tool. It accepts connection parameters, builds a connection_request dictionary, calls the underlying Airflow ConnectionApi.test_connection, and returns the response as MCP TextContent.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 includes the registration tuple for 'test_connection' (handler, name, description, read_only=True), which is imported and used in src/main.py for overall tool registration.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/airflow/connection.py:8-8 (helper)Initialization of the connection_api instance used by the test_connection handler.connection_api = ConnectionApi(api_client)