aminghadersohi commented on code in PR #40957:
URL: https://github.com/apache/superset/pull/40957#discussion_r3424795152
##########
superset/mcp_service/dashboard/schemas.py:
##########
@@ -708,6 +708,113 @@ class GenerateDashboardResponse(BaseModel):
)
+class UpdateDashboardRequest(BaseModel):
+ """Request schema for partially updating dashboard metadata.
+
+ All fields except ``dashboard_id`` are optional — only the fields that
+ are provided are changed. ``None`` means "leave unchanged"; to clear a
+ text field (e.g. ``certified_by``) pass an empty string.
+ """
+
+ model_config = ConfigDict(populate_by_name=True)
Review Comment:
Fixed the stale docstring: the clear-a-text-field example now references
`css` (a current field) instead of the removed `certified_by`.
On `extra="forbid"`: keeping the default `extra="ignore"` here is deliberate
and consistent with the rest of the MCP service schemas. A call containing only
unknown keys already falls through to the "No fields provided to update" guard,
so there is no silent privilege expansion or data path that `forbid` would
close. Switching this one schema to `forbid` would diverge from the
service-wide convention without a concrete safety gain.
##########
superset/mcp_service/dashboard/tool/update_dashboard.py:
##########
@@ -0,0 +1,340 @@
+# 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.
+
+"""
+MCP tool: update_dashboard
+
+This tool performs a partial update of dashboard metadata (title, slug,
+published state, tags, CSS, and selected json_metadata settings).
+"""
+
+import logging
+from typing import Any
+
+from fastmcp import Context
+from sqlalchemy.exc import SQLAlchemyError
+from superset_core.mcp.decorators import tool, ToolAnnotations
+
+from superset.commands.exceptions import CommandException
+from superset.extensions import event_logger
+from superset.mcp_service.dashboard.schemas import (
+ DashboardInfo,
+ UpdateDashboardRequest,
+ UpdateDashboardResponse,
+)
+from superset.mcp_service.utils.url_utils import get_superset_base_url
+from superset.utils import json
+
+logger = logging.getLogger(__name__)
+
+# Direct dashboard columns accepted by UpdateDashboardCommand
+# (subset of DashboardPutSchema).
+_DIRECT_FIELDS = (
+ "dashboard_title",
+ "slug",
+ "published",
+ "css",
+ "tags",
+)
+
+# Convenience fields stored inside the dashboard's json_metadata blob.
+_METADATA_FIELDS = (
+ "cross_filters_enabled",
+ "refresh_frequency",
+ "filter_bar_orientation",
+)
+
+
+def _build_update_properties(
+ request: UpdateDashboardRequest, dashboard: Any
+) -> tuple[dict[str, Any], list[str]]:
+ """Build the UpdateDashboardCommand properties dict from the request.
+
+ Returns ``(properties, updated_fields)`` where *updated_fields* lists
+ the request fields that will be changed.
+
+ json_metadata is a stringified JSON blob and
+ ``DashboardDAO.set_dash_metadata`` resets absent keys to defaults
+ (e.g. ``expanded_slices`` -> {}). To avoid silently destroying state,
+ the dashboard's FULL current json_metadata is read, the requested
+ changes are merged in, and the complete blob is written back.
+ """
+ properties: dict[str, Any] = {}
+ updated_fields: list[str] = []
+
+ for field in _DIRECT_FIELDS:
+ value = getattr(request, field)
+ if value is not None:
+ properties[field] = value
+ updated_fields.append(field)
Review Comment:
Fixed. Added a `normalize_slug` field validator to `UpdateDashboardRequest`
that mirrors the REST `BaseDashboardSchema.post_load` cleaning (strip, replace
spaces with hyphens, drop characters outside `[\w-]`), so the tool can no
longer persist a slug the REST update path would have normalized or rejected.
Covered by `test_request_slug_is_normalized`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
