superset_database_get_connection
Retrieve detailed connection information for a specific database by its ID, enabling users to access and verify database configuration settings within Superset.
Instructions
Get database connection information
Makes a request to the /api/v1/database/{id}/connection endpoint to retrieve connection details for a specific database.
Args: database_id: ID of the database
Returns: A dictionary with detailed connection information
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| database_id | Yes |
Implementation Reference
- main.py:971-992 (handler)The main handler function decorated with @mcp.tool() that implements the superset_database_get_connection tool. It calls the make_api_request helper to GET the database connection details from the Superset API.@mcp.tool() @requires_auth @handle_api_errors async def superset_database_get_connection( ctx: Context, database_id: int ) -> Dict[str, Any]: """ Get database connection information Makes a request to the /api/v1/database/{id}/connection endpoint to retrieve connection details for a specific database. Args: database_id: ID of the database Returns: A dictionary with detailed connection information """ return await make_api_request( ctx, "get", f"/api/v1/database/{database_id}/connection" )
- main.py:271-330 (helper)Core helper function used by all Superset API tools, including superset_database_get_connection, to make authenticated HTTP requests to the Superset API with automatic token refresh and error handling.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()
- main.py:154-169 (helper)Decorator applied to the tool handler that ensures the user is authenticated before executing the tool logic.def requires_auth( func: Callable[..., Awaitable[Dict[str, Any]]], ) -> Callable[..., Awaitable[Dict[str, Any]]]: """Decorator to check authentication before executing a function""" @wraps(func) async def wrapper(ctx: Context, *args, **kwargs) -> Dict[str, Any]: superset_ctx: SupersetContext = ctx.request_context.lifespan_context if not superset_ctx.access_token: return {"error": "Not authenticated. Please authenticate first."} return await func(ctx, *args, **kwargs) return wrapper
- main.py:171-186 (helper)Decorator applied to the tool handler that catches exceptions and returns formatted error messages.def handle_api_errors( func: Callable[..., Awaitable[Dict[str, Any]]], ) -> Callable[..., Awaitable[Dict[str, Any]]]: """Decorator to handle API errors in a consistent way""" @wraps(func) async def wrapper(ctx: Context, *args, **kwargs) -> Dict[str, Any]: try: return await func(ctx, *args, **kwargs) except Exception as e: # Extract function name for better error context function_name = func.__name__ return {"error": f"Error in {function_name}: {str(e)}"} return wrapper