gkneighb commented on code in PR #41497: URL: https://github.com/apache/superset/pull/41497#discussion_r3545835920
########## superset/mcp_service/theme/tool/create_theme.py: ########## @@ -0,0 +1,157 @@ +# 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. + +""" +Create theme FastMCP tool + +Creates a reusable Superset theme from an antd design-token configuration. +The supplied json_data is sanitized and validated with the same routine the +REST API uses before the theme is persisted via ThemeDAO. +""" + +import logging +from typing import Any + +from fastmcp import Context +from marshmallow import ValidationError +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.extensions import db, event_logger +from superset.mcp_service.theme.schemas import CreateThemeRequest, CreateThemeResponse +from superset.mcp_service.utils.sanitization import sanitize_for_llm_context +from superset.themes.schemas import _sanitize_and_validate_theme_config +from superset.utils import json + +logger = logging.getLogger(__name__) + + +@tool( + tags=["mutate"], + class_permission_name="Theme", + method_permission_name="write", + annotations=ToolAnnotations( + title="Create theme", + readOnlyHint=False, + destructiveHint=False, + ), +) +async def create_theme( + request: CreateThemeRequest, ctx: Context +) -> CreateThemeResponse: + """Create a reusable theme from antd design tokens. + + Accepts a theme name and an antd design-token configuration (json_data), + supplied either as a JSON object or a JSON string. The configuration is + sanitized and validated the same way the REST API validates themes before + the theme is persisted. + + Required fields: + - theme_name: Human-readable name for the theme + - json_data: The antd design-token configuration (dict or JSON string) + + Example: + ```json + { + "theme_name": "Corporate Blue", + "json_data": {"token": {"colorPrimary": "#1d4ed8"}} + } + ``` + + Returns CreateThemeResponse with the new theme's id and uuid on success, + or an error response (error_type="ValidationError") if the configuration + is invalid. + """ + await ctx.info("Creating theme: theme_name=%s" % (request.theme_name,)) + + # Parse json_data into a dict (accept dict or JSON string) + config_dict: dict[str, Any] + if isinstance(request.json_data, str): + try: + parsed = json.loads(request.json_data) + except (TypeError, json.JSONDecodeError) as exc: + await ctx.warning("Invalid JSON in json_data: %s" % (str(exc),)) + return CreateThemeResponse( + success=False, + error=f"json_data is not valid JSON: {exc}", + error_type="ValidationError", + ) + if not isinstance(parsed, dict): + await ctx.warning("json_data did not parse to an object") + return CreateThemeResponse( + success=False, + error="json_data must be a JSON object", + error_type="ValidationError", + ) + config_dict = parsed + else: + config_dict = request.json_data + + # Sanitize and validate using the same routine as the REST API + try: + sanitized = _sanitize_and_validate_theme_config(config_dict) + except ValidationError as exc: + await ctx.warning("Theme validation failed: %s" % (exc.messages,)) + return CreateThemeResponse( + success=False, + error=str(exc.messages), + error_type="ValidationError", + ) + + try: + from superset.daos.theme import ThemeDAO + + with event_logger.log_context(action="mcp.create_theme"): + theme = ThemeDAO.create( + attributes={ + "theme_name": request.theme_name, + "json_data": json.dumps(sanitized), + "is_system": False, + } + ) Review Comment: Declining: locals with types inferable from the assignment are not annotated anywhere in this codebase; mypy passes without them. Keeping repo convention. ########## superset/mcp_service/theme/schemas.py: ########## @@ -0,0 +1,301 @@ +# 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. + +""" +Pydantic schemas for theme-related responses +""" + +from __future__ import annotations + +from datetime import datetime +from typing import Annotated, Any, Dict, List, Literal + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + field_validator, + model_serializer, + model_validator, + PositiveInt, +) + +from superset.daos.base import ColumnOperator, ColumnOperatorEnum +from superset.mcp_service.constants import DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE +from superset.mcp_service.system.schemas import PaginationInfo +from superset.mcp_service.utils.response_utils import humanize_timestamp +from superset.mcp_service.utils.sanitization import sanitize_for_llm_context +from superset.mcp_service.utils.schema_utils import ( + parse_json_or_list, + parse_json_or_model_list, +) + + +class ThemeFilter(ColumnOperator): + """ + Filter object for theme listing. + col: The column to filter on. Must be one of the allowed filter fields. + opr: The operator to use. Must be one of the supported operators. + value: The value to filter by (type depends on col and opr). + """ + + col: Literal["theme_name"] = Field( + ..., + description="Column to filter on. Supported: 'theme_name' (string match).", + ) + opr: ColumnOperatorEnum = Field( + ..., + description="Operator to use. Common operators: 'eq' (equals), " + "'ct' (contains), 'sw' (starts with), 'ew' (ends with).", + ) + value: str | int | float | bool | List[str | int | float | bool] = Field( + ..., description="Value to filter by (type depends on col and opr)" + ) + + +class ThemeInfo(BaseModel): + """Theme metadata returned by MCP list/get tools.""" + + id: int | None = None + theme_name: str | None = None + json_data: str | None = Field( + None, description="Raw antd design-token JSON configuration as a string" + ) + uuid: str | None = None + is_system: bool | None = None + is_system_default: bool | None = None + is_system_dark: bool | None = None + changed_on: str | datetime | None = Field( + None, description="Last modification timestamp" + ) + changed_on_humanized: str | None = Field( + None, description="Humanized modification time" + ) + created_on: str | datetime | None = Field(None, description="Creation timestamp") + created_on_humanized: str | None = Field( + None, description="Humanized creation time" + ) + model_config = ConfigDict( + from_attributes=True, + ser_json_timedelta="iso8601", + populate_by_name=True, + ) + + @model_serializer(mode="wrap") + def _filter_fields_by_context(self, serializer: Any, info: Any) -> Dict[str, Any]: + """Filter serialized fields to those requested via select_columns context.""" + data: Dict[str, Any] = serializer(self) + if info.context and isinstance(info.context, dict): + select_columns = info.context.get("select_columns") + if select_columns: + requested_fields = set(select_columns) + return {k: v for k, v in data.items() if k in requested_fields} + return data + + +class ThemeList(BaseModel): + themes: List[ThemeInfo] + count: int + total_count: int + page: int + page_size: int + total_pages: int + has_previous: bool + has_next: bool + columns_requested: List[str] = Field(default_factory=list) + columns_loaded: List[str] = Field(default_factory=list) + columns_available: List[str] = Field(default_factory=list) + sortable_columns: List[str] = Field(default_factory=list) + filters_applied: List[ThemeFilter] = Field(default_factory=list) + pagination: PaginationInfo | None = None + timestamp: datetime | None = None + model_config = ConfigDict(ser_json_timedelta="iso8601") + + +class ListThemesRequest(BaseModel): + """Request schema for list_themes.""" + + filters: Annotated[ + List[ThemeFilter], + Field( + default_factory=list, + description="List of filter objects (column, operator, value). Each " + "filter has 'col', 'opr', and 'value' properties. Cannot be used " + "together with 'search'.", + ), + ] + select_columns: Annotated[ + List[str], + Field( + default_factory=list, + description="List of columns to select. Defaults to common columns if not " + "specified.", + ), + ] + search: Annotated[ + str | None, + Field( + default=None, + description="Text search string to match against theme name. Cannot be " + "used together with 'filters'.", + ), + ] + order_column: Annotated[ + str | None, Field(default=None, description="Column to order results by") + ] + order_direction: Annotated[ + Literal["asc", "desc"], + Field( + default="desc", + description="Direction to order results ('asc' or 'desc')", + ), + ] + page: Annotated[ + PositiveInt, + Field(default=1, description="Page number for pagination (1-based)"), + ] + page_size: Annotated[ + int, + Field( + default=DEFAULT_PAGE_SIZE, + gt=0, + le=MAX_PAGE_SIZE, + description=f"Number of items per page (max {MAX_PAGE_SIZE})", + ), + ] + + @field_validator("filters", mode="before") + @classmethod + def parse_filters(cls, v: Any) -> List[ThemeFilter]: + return parse_json_or_model_list(v, ThemeFilter, "filters") + + @field_validator("select_columns", mode="before") + @classmethod + def parse_columns(cls, v: Any) -> List[str]: + return parse_json_or_list(v, "select_columns") + + @model_validator(mode="after") + def validate_search_and_filters(self) -> "ListThemesRequest": + if self.search and self.filters: + raise ValueError( + "Cannot use both 'search' and 'filters' parameters simultaneously. " + "Use either 'search' for text-based searching or 'filters' for " + "precise column-based filtering, but not both." + ) + return self + + +class ThemeError(BaseModel): + error: str = Field(..., description="Error message") + error_type: str = Field(..., description="Type of error") + timestamp: str | datetime | None = Field(None, description="Error timestamp") + model_config = ConfigDict(ser_json_timedelta="iso8601") Review Comment: Accurate observation, wrong scope: the not-found text comes from the shared ModelGetInfoCore.run_tool (superset/mcp_service/mcp_core.py), so it applies identically to every get_*_info tool — chart, dashboard, dataset, database — and predates this PR. It also reflects the caller's own input back to the same caller, so it is defense-in-depth rather than a cross-user injection channel. Worth a core-level follow-up applying escape_llm_context_delimiters (as delete/restore tools do for identifiers), but changing shared core is out of scope for the theme PR. ########## superset/mcp_service/theme/schemas.py: ########## @@ -0,0 +1,301 @@ +# 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. + +""" +Pydantic schemas for theme-related responses +""" + +from __future__ import annotations + +from datetime import datetime +from typing import Annotated, Any, Dict, List, Literal + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + field_validator, + model_serializer, + model_validator, + PositiveInt, +) + +from superset.daos.base import ColumnOperator, ColumnOperatorEnum +from superset.mcp_service.constants import DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE +from superset.mcp_service.system.schemas import PaginationInfo +from superset.mcp_service.utils.response_utils import humanize_timestamp +from superset.mcp_service.utils.sanitization import sanitize_for_llm_context +from superset.mcp_service.utils.schema_utils import ( + parse_json_or_list, + parse_json_or_model_list, +) + + +class ThemeFilter(ColumnOperator): + """ + Filter object for theme listing. + col: The column to filter on. Must be one of the allowed filter fields. + opr: The operator to use. Must be one of the supported operators. + value: The value to filter by (type depends on col and opr). + """ + + col: Literal["theme_name"] = Field( + ..., + description="Column to filter on. Supported: 'theme_name' (string match).", + ) + opr: ColumnOperatorEnum = Field( + ..., + description="Operator to use. Common operators: 'eq' (equals), " + "'ct' (contains), 'sw' (starts with), 'ew' (ends with).", + ) + value: str | int | float | bool | List[str | int | float | bool] = Field( + ..., description="Value to filter by (type depends on col and opr)" + ) + + +class ThemeInfo(BaseModel): + """Theme metadata returned by MCP list/get tools.""" + + id: int | None = None + theme_name: str | None = None + json_data: str | None = Field( + None, description="Raw antd design-token JSON configuration as a string" + ) + uuid: str | None = None + is_system: bool | None = None + is_system_default: bool | None = None + is_system_dark: bool | None = None + changed_on: str | datetime | None = Field( + None, description="Last modification timestamp" + ) + changed_on_humanized: str | None = Field( + None, description="Humanized modification time" + ) + created_on: str | datetime | None = Field(None, description="Creation timestamp") + created_on_humanized: str | None = Field( + None, description="Humanized creation time" + ) + model_config = ConfigDict( + from_attributes=True, + ser_json_timedelta="iso8601", + populate_by_name=True, + ) + + @model_serializer(mode="wrap") + def _filter_fields_by_context(self, serializer: Any, info: Any) -> Dict[str, Any]: + """Filter serialized fields to those requested via select_columns context.""" + data: Dict[str, Any] = serializer(self) + if info.context and isinstance(info.context, dict): + select_columns = info.context.get("select_columns") + if select_columns: + requested_fields = set(select_columns) + return {k: v for k, v in data.items() if k in requested_fields} + return data + + +class ThemeList(BaseModel): + themes: List[ThemeInfo] + count: int + total_count: int + page: int + page_size: int + total_pages: int + has_previous: bool + has_next: bool + columns_requested: List[str] = Field(default_factory=list) + columns_loaded: List[str] = Field(default_factory=list) + columns_available: List[str] = Field(default_factory=list) + sortable_columns: List[str] = Field(default_factory=list) + filters_applied: List[ThemeFilter] = Field(default_factory=list) + pagination: PaginationInfo | None = None + timestamp: datetime | None = None + model_config = ConfigDict(ser_json_timedelta="iso8601") + + +class ListThemesRequest(BaseModel): + """Request schema for list_themes.""" + + filters: Annotated[ + List[ThemeFilter], + Field( + default_factory=list, + description="List of filter objects (column, operator, value). Each " + "filter has 'col', 'opr', and 'value' properties. Cannot be used " + "together with 'search'.", + ), + ] + select_columns: Annotated[ + List[str], + Field( + default_factory=list, + description="List of columns to select. Defaults to common columns if not " + "specified.", + ), + ] + search: Annotated[ + str | None, + Field( + default=None, + description="Text search string to match against theme name. Cannot be " + "used together with 'filters'.", + ), + ] + order_column: Annotated[ + str | None, Field(default=None, description="Column to order results by") + ] + order_direction: Annotated[ + Literal["asc", "desc"], + Field( + default="desc", + description="Direction to order results ('asc' or 'desc')", + ), + ] + page: Annotated[ + PositiveInt, + Field(default=1, description="Page number for pagination (1-based)"), + ] + page_size: Annotated[ + int, + Field( + default=DEFAULT_PAGE_SIZE, + gt=0, + le=MAX_PAGE_SIZE, + description=f"Number of items per page (max {MAX_PAGE_SIZE})", + ), + ] + + @field_validator("filters", mode="before") + @classmethod + def parse_filters(cls, v: Any) -> List[ThemeFilter]: + return parse_json_or_model_list(v, ThemeFilter, "filters") + + @field_validator("select_columns", mode="before") + @classmethod + def parse_columns(cls, v: Any) -> List[str]: + return parse_json_or_list(v, "select_columns") + + @model_validator(mode="after") + def validate_search_and_filters(self) -> "ListThemesRequest": + if self.search and self.filters: + raise ValueError( + "Cannot use both 'search' and 'filters' parameters simultaneously. " + "Use either 'search' for text-based searching or 'filters' for " + "precise column-based filtering, but not both." + ) + return self + + +class ThemeError(BaseModel): + error: str = Field(..., description="Error message") + error_type: str = Field(..., description="Type of error") + timestamp: str | datetime | None = Field(None, description="Error timestamp") + model_config = ConfigDict(ser_json_timedelta="iso8601") + + @classmethod + def create(cls, error: str, error_type: str) -> "ThemeError": + from datetime import timezone + + return cls( + error=error, error_type=error_type, timestamp=datetime.now(timezone.utc) + ) + + +class GetThemeInfoRequest(BaseModel): + """Request schema for get_theme_info with numeric ID or UUID string.""" + + identifier: Annotated[ + int | str, + Field(description="Theme identifier — numeric ID or UUID string"), + ] + + +class CreateThemeRequest(BaseModel): + """Request schema for create_theme.""" + + theme_name: Annotated[ + str, + Field(description="Human-readable name for the theme"), + ] + json_data: Annotated[ + dict[str, Any] | str, + Field( + description="The antd design-token configuration. Accepts either a JSON " + "object (dict) or a JSON string." + ), + ] + + @field_validator("theme_name") + @classmethod + def reject_blank_theme_name(cls, value: str) -> str: + """Mirror the REST ThemePostSchema check: no empty/whitespace names.""" + if not value or not value.strip(): + raise ValueError("Theme name cannot be empty.") + return value + + +class CreateThemeResponse(BaseModel): + success: bool = Field(..., description="Whether the theme was created") + id: int | None = Field(None, description="ID of the created theme") + uuid: str | None = Field(None, description="UUID of the created theme") + theme_name: str | None = Field(None, description="Name of the created theme") + message: str | None = Field(None, description="Human-readable success message") + error: str | None = Field(None, description="Error message if creation failed") + error_type: str | None = Field(None, description="Type of error if creation failed") + + +def _sanitize_theme_info_for_llm_context(theme_info: ThemeInfo) -> ThemeInfo: + """Wrap user-controlled theme fields before LLM exposure. + + ``theme_name`` is user-supplied free text. ``json_data`` is structured + configuration, but its token values (font families, URLs, arbitrary antd + tokens) are equally user-controlled and pass ``is_valid_theme`` / + ``sanitize_theme_tokens`` untouched, so the whole JSON string is wrapped + as one untrusted block — the JSON stays parseable inside the delimiters, + and embedded delimiter tokens are escaped so a hostile value cannot close + the wrapper early. + """ + payload = theme_info.model_dump(mode="python") + payload["theme_name"] = sanitize_for_llm_context( + payload.get("theme_name"), + field_path=("theme_name",), + ) + payload["json_data"] = sanitize_for_llm_context( + payload.get("json_data"), + field_path=("json_data",), + ) Review Comment: Declining: the wrapping was explicitly requested in the round-3 maintainer review (corroborating an earlier finding in this thread class) — json_data token values are user-controlled and were reaching LLM context raw. The tradeoff is deliberate: the UNTRUSTED-CONTENT delimiters are the server-wide documented data-boundary convention (see DEFAULT_INSTRUCTIONS), the JSON inside the block remains valid once the client strips the markers, and there is no automated get-to-create round-trip in this PR (no update_theme tool). If a different shape is preferred (e.g. a parallel unwrapped-but-escaped field), happy to defer to @aminghadersohi. -- 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]
