aminghadersohi commented on code in PR #40342: URL: https://github.com/apache/superset/pull/40342#discussion_r3313028283
########## superset/mcp_service/annotation_layer/tool/list_annotation_layers.py: ########## @@ -0,0 +1,123 @@ +# 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. + +"""List annotation layers FastMCP tool.""" + +import logging + +from fastmcp import Context +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.extensions import event_logger +from superset.mcp_service.annotation_layer.schemas import ( + AnnotationLayerError, + AnnotationLayerFilter, + AnnotationLayerInfo, + AnnotationLayerList, + DEFAULT_LAYER_COLUMNS, + ListAnnotationLayersRequest, + serialize_annotation_layer, +) +from superset.mcp_service.mcp_core import ModelListCore + +logger = logging.getLogger(__name__) + +_DEFAULT_REQUEST = ListAnnotationLayersRequest() + +_ALL_LAYER_COLUMNS = ["id", "name", "descr", "changed_on", "created_on"] +_SORTABLE_LAYER_COLUMNS = ["id", "name", "changed_on", "created_on"] + + +@tool( + tags=["core"], + class_permission_name="Annotation", + annotations=ToolAnnotations( + title="List annotation layers", + readOnlyHint=True, + destructiveHint=False, + ), +) +async def list_annotation_layers( + request: ListAnnotationLayersRequest | None = None, + ctx: Context | None = None, +) -> AnnotationLayerList | AnnotationLayerError: + """List annotation layers with filtering, search, and pagination. + + Returns annotation layer metadata including name and description. + + Sortable columns for order_column: id, name, changed_on, created_on + """ + if ctx is None: + raise RuntimeError("FastMCP context is required for list_annotation_layers") + + request = request or _DEFAULT_REQUEST.model_copy(deep=True) + + await ctx.info( + "Listing annotation layers: page=%s, page_size=%s, search=%s" + % (request.page, request.page_size, request.search) + ) + + try: + from superset.daos.annotation_layer import AnnotationLayerDAO + + def _serialize( + obj: object, cols: list[str] | None + ) -> AnnotationLayerInfo | None: + return serialize_annotation_layer(obj) Review Comment: The `cols` argument controls which columns `AnnotationLayerDAO.list` fetches from the database (DB-level projection). The serializer produces a fixed Pydantic schema (`AnnotationLayerInfo`) which is the stable API contract — `select_columns` is a DB read optimization, not a response-field filter. This is consistent with how all other MCP list tools in the codebase are designed. ########## superset/mcp_service/annotation_layer/tool/list_layer_annotations.py: ########## @@ -0,0 +1,149 @@ +# 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. + +"""List annotations within a layer FastMCP tool.""" + +import logging +from datetime import datetime, timezone + +from fastmcp import Context +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.daos.base import ColumnOperator, ColumnOperatorEnum +from superset.extensions import event_logger +from superset.mcp_service.annotation_layer.schemas import ( + AnnotationFilter, + AnnotationInfo, + AnnotationLayerError, + AnnotationList, + DEFAULT_ANNOTATION_COLUMNS, + ListLayerAnnotationsRequest, + serialize_annotation, +) +from superset.mcp_service.mcp_core import ModelListCore + +logger = logging.getLogger(__name__) + +_ALL_ANNOTATION_COLUMNS = [ + "id", + "short_descr", + "long_descr", + "start_dttm", + "end_dttm", + "json_metadata", + "layer_id", +] +_SORTABLE_ANNOTATION_COLUMNS = ["id", "short_descr", "start_dttm", "end_dttm"] + + +@tool( + tags=["core"], + class_permission_name="Annotation", + annotations=ToolAnnotations( + title="List annotations in a layer", + readOnlyHint=True, + destructiveHint=False, + ), +) +async def list_layer_annotations( + request: ListLayerAnnotationsRequest, + ctx: Context, +) -> AnnotationList | AnnotationLayerError: + """List annotations within a specific annotation layer. + + The layer_id parameter is required and scopes all results to that layer. + + Sortable columns for order_column: id, short_descr, start_dttm, end_dttm + + Example: + ```json + {"layer_id": 1, "page": 1, "page_size": 25} + ``` + """ + await ctx.info( + "Listing annotations: layer_id=%s, page=%s, page_size=%s, search=%s" + % (request.layer_id, request.page, request.page_size, request.search) + ) + + try: + from superset.daos.annotation_layer import AnnotationDAO, AnnotationLayerDAO + + # Verify the layer exists before listing + layer = AnnotationLayerDAO.find_by_id(request.layer_id) + if layer is None: + await ctx.warning("Annotation layer not found: id=%s" % (request.layer_id,)) + return AnnotationLayerError.create( + error=f"Annotation layer with id '{request.layer_id}' not found", + error_type="not_found", + ) + + # Prepend the layer_id filter so results are scoped to this layer + layer_filter = ColumnOperator( + col="layer_id", opr=ColumnOperatorEnum.eq, value=request.layer_id + ) + combined_filters: list[ColumnOperator] = [layer_filter] + list(request.filters) + + def _serialize(obj: object, cols: list[str] | None) -> AnnotationInfo | None: + return serialize_annotation(obj) Review Comment: Same design — `cols` drives DB-level column projection (which fields `AnnotationDAO.list` fetches), not response-field filtering. The Pydantic output schema (`AnnotationInfo`) is a fixed API contract. The substantive DB-level fix is the `layer_id` addition to `DEFAULT_ANNOTATION_COLUMNS` landed in commit 2b0f320af34451d84aca39259bf6546301fe409d. -- 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]
