aminghadersohi commented on code in PR #33976: URL: https://github.com/apache/superset/pull/33976#discussion_r2208978590
########## superset/mcp_service/README_SCHEMAS.md: ########## @@ -0,0 +1,477 @@ +# Superset MCP Service: Tool Schemas Reference + +This document provides a reference for the input and output parameters of all MCP tools in the Superset MCP service. Each section lists the tool name, its input parameters (with type), and its output schema. + +## Dashboards + +### list_dashboards + +**Inputs:** +- `filters`: `Optional[List[DashboardFilter]]` — List of filter objects +- `columns`: `Optional[List[str]]` — Columns to include in the response +- `keys`: `Optional[List[str]]` — Keys to include in the response +- `order_column`: `Optional[str]` — Column to order results by +- `order_direction`: `Optional[Literal['asc', 'desc']]` — Order direction +- `page`: `int` — Page number (1-based) +- `page_size`: `int` — Number of items per page +- `select_columns`: `Optional[List[str]]` — Columns to select (overrides columns/keys) +- `search`: `Optional[str]` — Free-text search string + +**Returns:** `DashboardListResponse` +- `dashboards`: `List[DashboardListItem]` +- `count`: `int` +- `total_count`: `int` +- `page`: `int` +- `page_size`: `int` +- `total_pages`: `int` +- `has_previous`: `bool` +- `has_next`: `bool` +- `columns_requested`: `List[str]` +- `columns_loaded`: `List[str]` +- `filters_applied`: `Dict[str, Any]` +- `pagination`: `PaginationInfo` +- `timestamp`: `datetime` + +### list_dashboards_simple + +**Inputs:** +- `filters`: `Optional[DashboardSimpleFilters]` — Simple filter object +- `order_column`: `Optional[str]` — Column to order results by +- `order_direction`: `Literal['asc', 'desc']` — Order direction +- `page`: `int` — Page number (1-based) +- `page_size`: `int` — Number of items per page +- `search`: `Optional[str]` — Free-text search string + +**Returns:** `DashboardListResponse` (see above) + +### get_dashboard_info + +**Inputs:** +- `dashboard_id`: `int` — Dashboard ID Review Comment: I think for dashboard it makes sense, would we need both id and slug? Although for dataset and chart there is no slug right? -- 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]
