superset_database_test_connection
Test database connection details in Apache Superset to verify connectivity before configuration.
Instructions
Test a database connection
Makes a request to the /api/v1/database/test_connection endpoint to verify if the provided connection details can successfully connect to the database.
Args: database_data: Database connection details including sqlalchemy_uri and other parameters
Returns: A dictionary with connection test results
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| database_data | Yes |
Implementation Reference
- main.py:877-898 (handler)The handler function for the 'superset_database_test_connection' tool. It tests database connections by POSTing to Superset's /api/v1/database/test_connection endpoint via the make_api_request helper. Includes decorators for registration (@mcp.tool()), authentication (@requires_auth), and error handling (@handle_api_errors).@mcp.tool() @requires_auth @handle_api_errors async def superset_database_test_connection( ctx: Context, database_data: Dict[str, Any] ) -> Dict[str, Any]: """ Test a database connection Makes a request to the /api/v1/database/test_connection endpoint to verify if the provided connection details can successfully connect to the database. Args: database_data: Database connection details including sqlalchemy_uri and other parameters Returns: A dictionary with connection test results """ return await make_api_request( ctx, "post", "/api/v1/database/test_connection", data=database_data )
- main.py:271-330 (helper)Core helper function used by the superset_database_test_connection handler (and all other tools) to perform authenticated API requests to Superset, handling CSRF tokens, auto token refresh on 401, and standardized error responses.async def make_api_request( ctx: Context, method: str, endpoint: str, data: Dict[str, Any] = None, params: Dict[str, Any] = None, auto_refresh: bool = True, ) -> Dict[str, Any]: """ Helper function to make API requests to Superset Args: ctx: MCP context method: HTTP method (get, post, put, delete) endpoint: API endpoint (without base URL) data: Optional JSON payload for POST/PUT requests params: Optional query parameters auto_refresh: Whether to auto-refresh token on 401 """ superset_ctx: SupersetContext = ctx.request_context.lifespan_context client = superset_ctx.client # For non-GET requests, make sure we have a CSRF token if method.lower() != "get" and not superset_ctx.csrf_token: await get_csrf_token(ctx) async def make_request() -> httpx.Response: headers = {} # Add CSRF token for non-GET requests if method.lower() != "get" and superset_ctx.csrf_token: headers["X-CSRFToken"] = superset_ctx.csrf_token if method.lower() == "get": return await client.get(endpoint, params=params) elif method.lower() == "post": return await client.post( endpoint, json=data, params=params, headers=headers ) elif method.lower() == "put": return await client.put(endpoint, json=data, headers=headers) elif method.lower() == "delete": return await client.delete(endpoint, headers=headers) else: raise ValueError(f"Unsupported HTTP method: {method}") # Use auto_refresh if requested response = ( await with_auto_refresh(ctx, make_request) if auto_refresh else await make_request() ) if response.status_code not in [200, 201]: return { "error": f"API request failed: {response.status_code} - {response.text}" } return response.json()