aminghadersohi commented on code in PR #33976: URL: https://github.com/apache/superset/pull/33976#discussion_r2257587392
########## superset/cli/mcp.py: ########## @@ -0,0 +1,366 @@ +# 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. +"""CLI module for MCP service""" + +import os +import secrets +import sys +from pathlib import Path +from typing import Optional + +import click +from colorama import Fore, Style +from flask import current_app +from flask.cli import with_appcontext + +from superset import db, security_manager +from superset.mcp_service.server import run_server + + [email protected]() +def mcp() -> None: + """Model Context Protocol service commands""" + pass + + [email protected]() [email protected]("--host", default="127.0.0.1", help="Host to bind to") [email protected]("--port", default=5008, help="Port to bind to") [email protected]("--debug", is_flag=True, help="Enable debug mode") [email protected]("--sql-debug", is_flag=True, help="Enable SQL query logging") +def run(host: str, port: int, debug: bool, sql_debug: bool) -> None: + """Run the MCP service""" + if sql_debug: + os.environ["SQLALCHEMY_DEBUG"] = "1" + click.echo("🔍 SQL Debug mode enabled") + + run_server(host=host, port=port, debug=debug) + + [email protected]() [email protected]("--force", is_flag=True, help="Force setup even if configuration exists") [email protected]("--skip-config", is_flag=True, help="Skip configuration file setup") [email protected]("--skip-examples", is_flag=True, help="Skip loading example datasets") [email protected]("--api-key", help="Anthropic API key for MCP service") +@with_appcontext +def setup( + force: bool, skip_config: bool, skip_examples: bool, api_key: Optional[str] +) -> None: + """Set up MCP service for Apache Superset""" + click.echo(f"{Fore.CYAN}=== Apache Superset MCP Service Setup ==={Style.RESET_ALL}") + click.echo() + + # Check if already set up + config_path = Path("superset_config.py") + + # 1. Configuration file setup + if not skip_config: + if config_path.exists() and not force: + click.echo( + f"{Fore.YELLOW}⚠️ superset_config.py already exists{Style.RESET_ALL}" + ) + if click.confirm("Do you want to check/add missing MCP settings?"): + _update_config_file(config_path, api_key) + else: + click.echo("Keeping existing configuration") + else: + _create_config_file(config_path, api_key) + + # 2. Database check + try: + # Check if database is initialized + with db.engine.connect() as conn: + conn.execute("SELECT COUNT(*) FROM ab_user") + click.echo(f"{Fore.GREEN}✓ Database already initialized{Style.RESET_ALL}") + + # Check for admin user + admin_exists = security_manager.find_user(username="admin") + if admin_exists: + click.echo(f"{Fore.GREEN}✓ Admin user already exists{Style.RESET_ALL}") + else: + if click.confirm("Create admin user (admin/admin)?"): + _create_admin_user() + except Exception: + click.echo( + f"{Fore.YELLOW}Database not initialized. " + f"Run 'superset db upgrade' and 'superset init' first.{Style.RESET_ALL}" + ) + sys.exit(1) + + # 3. Example data + if not skip_examples: + if click.confirm("Load example datasets?"): + click.echo("Loading example datasets...") + from superset.cli.examples import load_examples + + load_examples() + click.echo(f"{Fore.GREEN}✓ Example datasets loaded{Style.RESET_ALL}") + + # 4. Verify Superset configuration + _verify_superset_config() + + # 5. Show final instructions + click.echo() + click.echo(f"{Fore.GREEN}=== Setup Complete! ==={Style.RESET_ALL}") + click.echo() + click.echo("To start Superset:") + click.echo( + " 1. In terminal 1: superset run -p 8088 --with-threads --reload --debugger" + ) + click.echo(" 2. In terminal 2: cd superset-frontend && npm run dev-server") + click.echo(" 3. Open http://localhost:8088";) + click.echo(" 4. Login with admin/admin") + click.echo() + click.echo("To start MCP service:") + click.echo(" superset mcp run") + click.echo() + if _check_csrf_issue(): + click.echo( + f"{Fore.YELLOW}Note: If you encounter login loops, " + f"edit superset_config.py and set:{Style.RESET_ALL}" + ) + click.echo(" WTF_CSRF_ENABLED = False") + + +def _create_config_file(config_path: Path, api_key: Optional[str]) -> None: + """Create a new superset_config.py file""" + click.echo("Creating new superset_config.py...") + + config_content = f"""# Apache Superset Configuration +SECRET_KEY = '{secrets.token_urlsafe(42)}' + +# Session configuration for local development +SESSION_COOKIE_HTTPONLY = True +SESSION_COOKIE_SECURE = False +SESSION_COOKIE_SAMESITE = 'Lax' +SESSION_COOKIE_NAME = 'superset_session' +PERMANENT_SESSION_LIFETIME = 86400 + +# CSRF Protection (disable if login loop occurs) +WTF_CSRF_ENABLED = True +WTF_CSRF_TIME_LIMIT = None + +# MCP Service Configuration +MCP_ADMIN_USERNAME = 'admin' +MCP_DEV_USERNAME = 'admin' +SUPERSET_WEBSERVER_ADDRESS = 'http://localhost:8088' + +# WebDriver Configuration for screenshots +WEBDRIVER_BASEURL = 'http://localhost:8088/' +WEBDRIVER_BASEURL_USER_FRIENDLY = WEBDRIVER_BASEURL +""" + + if api_key or click.confirm("Do you have an Anthropic API key for MCP service?"): + if not api_key: + api_key = click.prompt("Enter your Anthropic API key", hide_input=True) + config_content += ( + f"\n# Anthropic API Configuration\nANTHROPIC_API_KEY = '{api_key}'\n" + ) + + config_path.write_text(config_content) + click.echo(f"{Fore.GREEN}✓ Created superset_config.py{Style.RESET_ALL}") + + +def _update_config_file(config_path: Path, api_key: Optional[str]) -> None: + """Update existing config file with missing settings""" + content = config_path.read_text() + updated = False + + # Check for missing settings + if "SECRET_KEY" not in content: + click.echo("Adding SECRET_KEY...") + content = f"SECRET_KEY = '{secrets.token_urlsafe(42)}'\n" + content + updated = True + + if "MCP_ADMIN_USERNAME" not in content: + click.echo("Adding MCP configuration...") + content += "\n# MCP Service Configuration\n" + content += "MCP_ADMIN_USERNAME = 'admin'\n" + content += "MCP_DEV_USERNAME = 'admin'\n" + content += "SUPERSET_WEBSERVER_ADDRESS = 'http://localhost:8088'\n" + updated = True + + if "WEBDRIVER_BASEURL" not in content: + click.echo("Adding WebDriver configuration...") + content += "\n# WebDriver Configuration for screenshots\n" + content += "WEBDRIVER_BASEURL = 'http://localhost:8088/'\n" + content += "WEBDRIVER_BASEURL_USER_FRIENDLY = WEBDRIVER_BASEURL\n" + updated = True + + # Handle API key + if "ANTHROPIC_API_KEY" in content: + click.echo( + f"{Fore.GREEN}✓ Anthropic API key already configured{Style.RESET_ALL}" + ) + if api_key or click.confirm("Update Anthropic API key?"): + if not api_key: + api_key = click.prompt( + "Enter your new Anthropic API key", hide_input=True + ) + # Remove old key + lines = content.split("\n") + content = "\n".join( + line for line in lines if "ANTHROPIC_API_KEY" not in line + ) + content += ( + f"\n# Anthropic API Configuration\nANTHROPIC_API_KEY = '{api_key}'\n" + ) + updated = True + else: + if api_key or click.confirm( + "Do you have an Anthropic API key for MCP service?" + ): + if not api_key: + api_key = click.prompt("Enter your Anthropic API key", hide_input=True) + content += ( + f"\n# Anthropic API Configuration\nANTHROPIC_API_KEY = '{api_key}'\n" + ) + updated = True + + if updated: + config_path.write_text(content) + click.echo(f"{Fore.GREEN}✓ Configuration updated{Style.RESET_ALL}") + + +def _create_admin_user() -> None: + """Create admin user""" + from superset.utils.decorators import transaction + + click.echo("Creating admin user...") + click.echo("Username: admin") + click.echo("Password: admin") + + @transaction() + def create_user() -> bool: + admin_user = security_manager.add_user( + username="admin", + first_name="Admin", + last_name="User", + email="admin@localhost", + role=security_manager.find_role("Admin"), + password="admin", # noqa: S106 + ) + return bool(admin_user) + + if create_user(): + click.echo(f"{Fore.GREEN}✓ Admin user created{Style.RESET_ALL}") + else: + click.echo(f"{Fore.RED}Failed to create admin user{Style.RESET_ALL}") + + +def _check_csrf_issue() -> bool: Review Comment: So this was an issue in dev for me. Didn't happen all the time but yesterday became an issue where superset wouldn't load (locahost:8088) and only this would fix it. Pretty sure its not a production issue and this setup process is only for dev. -- 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]
