Superset MCP Integration

This is an MCP server component designed to facilitate interaction with an Apache Superset instance, allowing AI agents to issue programmatic commands against the platform.

Deployment Procedures

Installation via Smithery

For automated setup using the Smithery CLI tool for Claude Desktop:

bash npx -y @smithery/cli install @aptro/superset-mcp --client claude

Manual Configuration Steps

1. Local Superset Initialization

Launch a local Superset environment using this command structure: bash git clone --branch 4.1.1 --depth 1 https://github.com/apache/superset && \ cd superset && \ docker compose -f docker-compose-image-tag.yml up

Once operational, the interface is reachable at http://localhost:8088. Standard initial credentials are: - User Identifier: admin - Secret Phrase: admin

1. Repository Cloning

Obtain a local copy of this management tool's source code.

1. Credential Configuration

Establish a .env configuration file in the root directory defining access parameters:

SUPERSET_BASE_URL=http://localhost:8088 # Adjust endpoint if necessary SUPERSET_USERNAME=your_username SUPERSET_PASSWORD=your_password

1. Dependency Resolution

Install required Python libraries: bash uv pip install .

1. MCP Agent Registration

Register this service configuration for use with the Claude Desktop application: bash mcp install main.py

Agent Interaction Examples (Via Claude)

Following successful setup, direct operations against your Superset deployment can be achieved via conversational prompts.

Dashboard Administration

• Retrieval: "Enumerate all extant Superset dashboards."
• Detail Fetch: "Provide comprehensive specifications for dashboard identifier 5."
• Creation: "Instantiate a new dashboard labeled 'Quarterly Performance Summary'."
• Modification: "Change the title of dashboard entity 3 to 'Revised Sales Metrics'."
• Destruction: "Decommission dashboard associated with identifier 7."

Chart/Visualization Oversight

• Inventory: "What visualizations are presently registered within the Superset instance?"
• Inspection: "Fetch the configuration details for visualization ID 10."
• Generation: "Construct a new horizontal bar chart referencing data source 3."
• Reconfiguration: "Alter visualization 5 to employ a scatter plot methodology instead of its current bar type."
• Removal: "Eradicate visualization instance 12."

Data Source & Connection Management

• Database Listing: "Display all registered database connections."
• Dataset Listing: "Generate a list of all accessible data sets."
• Schema Retrieval: "What tables reside within the scope of database ID 1?"
• Query Execution: "Execute the subsequent SQL against database 1: SELECT user_id, transaction_date FROM finance_logs WHERE amount > 1000;"
• Dataset Creation: "Forge a new data set definition utilizing the 'user_profiles' table from database 2."
• Connection Modification: "Apply modifications to the connection parameters of database 3."
• Connection Removal: "Sever the database linkage identified as ID 4."
• SQL Syntax Check: "Verify the syntactical correctness of this SQL for database 2: SELECT name, SUM(value) FROM sales_data GROUP BY name HAVING SUM(value) > 500."
• Catalog Fetch: "List available data catalogs within database 1."
• Function Listing: "Identify supported internal functions for database 2."
• Dependency Mapping: "Identify all dashboards and charts referencing database 1."

SQL Lab Utilities

• Query Submission: "Submit this analytic statement for processing: SELECT AVG(load_time) FROM web_traffic_logs."
• Formatting: "Standardize the formatting of this SQL block: SELECT col1, col2 FROM tbl_a INNER JOIN tbl_b ON tbl_a.id=tbl_b.fk_id;"
• Cost Projection: "Estimate the computational expense for query: SELECT * FROM massive_archive_table."
• Saved Query Retrieval: "Enumerate all my previously saved SQL queries."
• Result Retrieval: "Fetch the output corresponding to query identifier 'abc123'."

System & User Context

• Identity Check: "What credentials am I currently employing for access?"
• Privilege Review: "Detail the security roles assigned to my account."
• Audit Trail: "Present a log of recent operational activities."
• Navigation Data: "Retrieve the structure of accessible menu elements."
• Endpoint Discovery: "Report the base connectivity address for the targeted Superset deployment."

Metadata Tagging

• Tag Inventory: "Show all established metadata tags."
• Tag Creation: "Institute a new tag named 'Compliance_Review'."
• Tag Removal: "Erase the metadata tag with internal identifier 5."
• Object Association: "Apply the 'Compliance_Review' tag to dashboard number 3."
• Object Disassociation: "Unlink the 'Compliance_Review' tag from visualization number 7."

Exposable MCP Function Signatures

This plugin exposes the following management primitives for agent utilization:

Authentication

• superset_auth_check_token_validity - Verifies the current session token status
• superset_auth_refresh_token - Obtains a renewed access token
• superset_auth_authenticate_user - Initiates user credential verification

Dashboards

• superset_dashboard_list - Fetches an enumeration of all dashboards
• superset_dashboard_get_by_id - Retrieves a single dashboard via its identifier
• superset_dashboard_create - Provisions a new dashboard entity
• superset_dashboard_update - Modifies an existing dashboard's properties
• superset_dashboard_delete - Removes a specified dashboard

Charts

• superset_chart_list - Lists all available visualizations
• superset_chart_get_by_id - Fetches a specific visualization by its unique ID
• superset_chart_create - Generates a new visualization object
• superset_chart_update - Updates the parameters of an existing visualization
• superset_chart_delete - Eradicates a specified chart

Databases

• superset_database_list - Retrieves a list of configured databases
• superset_database_get_by_id - Fetches database connection details by ID
• superset_database_create - Establishes a new database linkage
• superset_database_get_tables - Lists schema tables associated with a database
• superset_database_schemas - Retrieves schemas for a given database
• superset_database_test_connection - Validates database connectivity
• superset_database_update - Modifies parameters of an existing database connection
• superset_database_delete - Removes a database connection configuration
• superset_database_get_catalogs - Fetches data catalogs accessible by the database driver
• superset_database_get_connection - Retrieves underlying connection metadata
• superset_database_get_function_names - Lists native database functions supported
• superset_database_get_related_objects - Maps charts and dashboards utilizing this database
• superset_database_validate_sql - Checks SQL syntax against the target database dialect
• superset_database_validate_parameters - Confirms the validity of provided connection parameters

Datasets

• superset_dataset_list - Enumerates existing data set definitions
• superset_dataset_get_by_id - Retrieves a data set by its identifier
• superset_dataset_create - Registers a new data set based on schema structure

SQL Lab

• superset_sqllab_execute_query - Submits a raw SQL command for execution
• superset_sqllab_get_saved_queries - Lists user-saved SQL scripts
• superset_sqllab_format_sql - Reformats and beautifies provided SQL code
• superset_sqllab_get_results - Retrieves output data from a completed query job
• superset_sqllab_estimate_query_cost - Provides a projection of resource usage for a query
• superset_sqllab_export_query_results - Exports query output into CSV format
• superset_sqllab_get_bootstrap_data - Gathers initial data required for the SQL Lab interface

Queries

• superset_query_list - Lists all submitted queries (active and historical)
• superset_query_get_by_id - Retrieves details of a specific query job
• superset_query_stop - Cancels a query that is currently processing

Saved Queries

• superset_saved_query_get_by_id - Fetches a specific permanently saved query definition
• superset_saved_query_create - Persists the current query definition for future use

User Information

• superset_user_get_current - Retrieves details of the authenticated user session
• superset_user_get_roles - Lists security roles assigned to the current user

Activity

• superset_activity_get_recent - Accesses recent platform activity logs

System

• superset_menu_get - Fetches metadata necessary for UI navigation construction
• superset_config_get_base_url - Returns the root URL endpoint of the Superset deployment

Tags

• superset_tag_list - Lists all metadata tags present in the system
• superset_tag_create - Establishes a new metadata tag
• superset_tag_get_by_id - Retrieves a tag based on its unique ID
• superset_tag_objects - Identifies which platform objects are associated with a specific tag
• superset_tag_delete - Permanently removes a metadata tag
• superset_tag_object_add - Associates a tag with a platform resource
• superset_tag_object_remove - Detaches a tag from a platform resource

Exploration Tools

• superset_explore_form_data_create - Generates the necessary payload structure for chart exploration settings
• superset_explore_form_data_get - Retrieves existing exploration parameters
• superset_explore_permalink_create - Generates a sharable URL linking directly to an exploration view
• superset_explore_permalink_get - Reconstructs exploration settings from a permalink URL

Advanced Data Types

• superset_advanced_data_type_convert - Converts a given value into a type supported by Superset's advanced typing system
• superset_advanced_data_type_list - Enumerates all supported advanced data formats

Configuration Parameters

Variable Name	Purpose	Default Value
SUPERSET_BASE_URL	Endpoint URL for the Superset server	http://localhost:8088
SUPERSET_USERNAME	Authentication identifier	Undefined
SUPERSET_PASSWORD	Secret authentication phrase	Undefined

Troubleshooting Guide

• Authentication failures usually indicate incorrect entries within the .env file.
• Verify that the Superset service is actively running and reachable at the specified URL.
• Compatibility testing was confirmed against Superset release 4.1.1; newer versions may require minor adjustments.
• Confirm that the TCP port utilized by this MCP server is not currently allocated to another process.

Security Considerations

• Credentials remain isolated within the local .env file.
• Generated access tokens are persisted exclusively in the .superset_token file within the project directory.
• All API interactions are direct communications between the MCP server and the Superset instance.
• Sensitive credentials are never transferred to Claude or any external service provider.
• For high-security production deployments, utilizing OAuth or other enterprise-grade authentication mechanisms is strongly advised.

Contribution Guidelines

We welcome external submissions and improvements! Please submit a Pull Request with your proposed changes.

Licensing

This software is distributed under the MIT License.

WIKIPEDIA: Business management tools encompass the entire spectrum of systems, applications, control mechanisms, calculation methodologies, and organizational frameworks employed by enterprises to effectively navigate dynamic market conditions, maintain competitive positioning, and enhance overall operational efficacy.

== Conceptual Framework == Management tools can be segmented based on departmental applicability and core functional aspects. Categorization by function often addresses fundamental aspects such as:

• Tools facilitating data acquisition and integrity verification across organizational units.
• Solutions dedicated to process oversight and continuous business improvement cycles.
• Mechanisms supporting data aggregation and informed strategic decision-making.

Contemporary management tooling has experienced rapid technological advancement over the past decade, leading to complexity in selecting optimal solutions for specific enterprise contexts. This complexity stems from unrelenting market pressures focused on cost reduction, revenue expansion, deep customer insight acquisition, and precise product fulfillment aligned with stated requirements.

Consequently, management personnel should adopt a strategic methodology for evaluating these tools, prioritizing adaptation to organizational requirements over blindly adopting the newest available technology. Uncritical adoption frequently results in system instability. Proper selection requires careful alignment between the chosen tool's capabilities and the organization's inherent operational needs.

== Prevalent Tools (2013 Survey Insights) == Data from a 2013 Bain & Company global survey indicated the following high-ranking business tools, reflecting regional requirements and prevailing market conditions:

1. Strategic planning frameworks
2. Customer relationship management (CRM) platforms
3. Employee satisfaction measurement instruments
4. Benchmarking methodologies
5. Balanced scorecard implementation
6. Core competency analysis
7. Outsourcing strategy management
8. Organizational change management programs
9. Supply chain optimization
10. Mission and vision articulation
11. Market segmentation analysis
12. Total quality management (TQM)

== Business Software Applications == A business application, or software collection, is utilized by personnel to execute diverse operational tasks, aiming to boost productivity, measure output metrics, and ensure accuracy in execution. The evolution progressed from rudimentary Management Information Systems (MIS) to comprehensive Enterprise Resource Planning (ERP) suites, later integrating CRM capabilities, culminating in the current era of cloud-based business management platforms.

Crucially, while a tangible link exists between IT investment and organizational outcomes, value maximization relies on two critical factors: the efficiency of the implementation process and the judicious selection and necessary customization of the tools themselves.