mirror of
https://github.com/apache/superset.git
synced 2026-07-20 05:36:00 +00:00
120 lines
4.0 KiB
Python
120 lines
4.0 KiB
Python
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
"""
|
|
Get dashboard layout FastMCP tool
|
|
|
|
Companion to get_dashboard_info: returns the parsed dashboard layout
|
|
(tabs and chart positions) extracted from position_json. Use this
|
|
when get_dashboard_info's omitted_fields hint indicates position_json
|
|
was stripped and structured layout data is needed for analysis.
|
|
"""
|
|
|
|
import logging
|
|
from datetime import datetime, timezone
|
|
|
|
from fastmcp import Context
|
|
from superset_core.mcp.decorators import tool, ToolAnnotations
|
|
|
|
from superset.extensions import event_logger
|
|
from superset.mcp_service.dashboard.schemas import (
|
|
dashboard_layout_serializer,
|
|
DashboardError,
|
|
DashboardLayout,
|
|
GetDashboardLayoutRequest,
|
|
)
|
|
from superset.mcp_service.mcp_core import ModelGetInfoCore
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@tool(
|
|
tags=["discovery"],
|
|
class_permission_name="Dashboard",
|
|
annotations=ToolAnnotations(
|
|
title="Get dashboard layout",
|
|
readOnlyHint=True,
|
|
destructiveHint=False,
|
|
),
|
|
)
|
|
async def get_dashboard_layout(
|
|
request: GetDashboardLayoutRequest, ctx: Context
|
|
) -> DashboardLayout | DashboardError:
|
|
"""
|
|
Get parsed dashboard layout by ID, UUID, or slug.
|
|
|
|
Returns the tabs and chart positions extracted from the dashboard's
|
|
position_json. get_dashboard_info omits position_json to keep responses
|
|
small; call this tool when you need the structured layout (e.g. to
|
|
explain which charts live under which tab, or to locate a chart by
|
|
its parent tab).
|
|
|
|
Example usage:
|
|
```json
|
|
{
|
|
"identifier": 123
|
|
}
|
|
```
|
|
"""
|
|
await ctx.info("Retrieving dashboard layout: identifier=%s" % (request.identifier,))
|
|
|
|
try:
|
|
from superset.daos.dashboard import DashboardDAO
|
|
|
|
# No eager loading: the layout serializer only reads position_json
|
|
# (plus id/title/uuid), so Dashboard.slices is never accessed.
|
|
with event_logger.log_context(action="mcp.get_dashboard_layout.lookup"):
|
|
core = ModelGetInfoCore(
|
|
dao_class=DashboardDAO,
|
|
output_schema=DashboardLayout,
|
|
error_schema=DashboardError,
|
|
serializer=dashboard_layout_serializer,
|
|
supports_slug=True,
|
|
logger=logger,
|
|
)
|
|
result = core.run_tool(request.identifier)
|
|
|
|
if isinstance(result, DashboardLayout):
|
|
await ctx.info(
|
|
"Dashboard layout retrieved: id=%s, tab_count=%s, chart_count=%s, "
|
|
"has_layout=%s"
|
|
% (
|
|
result.id,
|
|
len(result.tabs),
|
|
len(result.charts),
|
|
result.has_layout,
|
|
)
|
|
)
|
|
else:
|
|
await ctx.warning(
|
|
"Dashboard layout retrieval failed: error_type=%s, error=%s"
|
|
% (result.error_type, result.error)
|
|
)
|
|
|
|
return result
|
|
|
|
except Exception as e:
|
|
await ctx.error(
|
|
"Dashboard layout retrieval failed: identifier=%s, error=%s, "
|
|
"error_type=%s" % (request.identifier, str(e), type(e).__name__)
|
|
)
|
|
return DashboardError(
|
|
error=f"Failed to get dashboard layout: {str(e)}",
|
|
error_type="InternalError",
|
|
timestamp=datetime.now(timezone.utc),
|
|
)
|