Skip to content
Back to search

superset-mcp

connect to 50+ data stores via superset mcp server. Can use with open ai agent sdk, Claude app, cursor, windsurf

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/aptro--superset-mcp/badge.svg)](/listings/aptro--superset-mcp)

HTML

<a href="/listings/aptro--superset-mcp"><img src="/api/listings/aptro--superset-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Installing via Smithery

To install Superset Integration for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@aptro/superset-mcp):

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

Manual Installation

1. **Set Up Superset Locally**

Run this script to start Superset locally:

   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 Superset is running, you should be able to access it at http://localhost:8088 with default credentials: - Username: admin - Password: admin

2. **Clone This Repository**

Clone this repository to your local machine.

3. **Configure Environment Variables**

Create a `.env` file in the root directory with your Superset credentials:

   SUPERSET_BASE_URL=http://localhost:8088  # Change to your Superset URL
   SUPERSET_USERNAME=your_username
   SUPERSET_PASSWORD=your_password

4. **Install Dependencies**

   uv pip install .

5. **Install MCP Config for Claude**

To use with Claude Desktop app:

   mcp install main.py

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 236 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Superset MCP Integration
  2. [![smithery badge](https://smithery.ai/badge/@aptro/superset-mcp)](https://smithery.ai/server/@aptro/superset-mcp)
  3. MCP server for interacting with Apache Superset, enabling AI agents to connect to and control a Superset instance programmatically.
  4. ## Setup Instructions
  5. ### Installing via Smithery
  6. To install Superset Integration for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@aptro/superset-mcp):
  7. ```bash
  8. npx -y @smithery/cli install @aptro/superset-mcp --client claude
  9. ```
  10. ### Manual Installation
  11. 1. **Set Up Superset Locally**
  12. Run this script to start Superset locally:
  13. ```bash
  14. git clone --branch 4.1.1 --depth 1 https://github.com/apache/superset && \
  15. cd superset && \
  16. docker compose -f docker-compose-image-tag.yml up
  17. ```
  18. Once Superset is running, you should be able to access it at http://localhost:8088 with default credentials:
  19. - Username: admin
  20. - Password: admin
  21. 2. **Clone This Repository**
  22. Clone this repository to your local machine.
  23. 3. **Configure Environment Variables**
  24. Create a `.env` file in the root directory with your Superset credentials:
  25. ```
  26. SUPERSET_BASE_URL=http://localhost:8088 # Change to your Superset URL
  27. SUPERSET_USERNAME=your_username
  28. SUPERSET_PASSWORD=your_password
  29. ```
  30. 4. **Install Dependencies**
  31. ```bash
  32. uv pip install .
  33. ```
  34. 5. **Install MCP Config for Claude**
  35. To use with Claude Desktop app:
  36. ```bash
  37. mcp install main.py
  38. ```
  39. ## Usage with Claude
  40. After setup, you can interact with your Superset instance via Claude using natural language requests. Here are some examples:
  41. ### Dashboard Management
  42. - **View dashboards**: "Show me all my Superset dashboards"
  43. - **Get dashboard details**: "Show me the details of dashboard with ID 5"
  44. - **Create dashboard**: "Create a new dashboard titled 'Sales Overview'"
  45. - **Update dashboard**: "Update dashboard 3 to have the title 'Updated Sales Report'"
  46. - **Delete dashboard**: "Delete dashboard with ID 7"
  47. ### Chart Management
  48. - **List all charts**: "What charts do I have in my Superset instance?"
  49. - **View chart details**: "Show me the details of chart with ID 10"
  50. - **Create chart**: "Create a new bar chart using dataset 3"
  51. - **Update chart**: "Update chart 5 to use a line visualization instead of bar"
  52. - **Delete chart**: "Delete chart with ID 12"
  53. ### Database and Dataset Operations
  54. - **List databases**: "Show me all databases connected to Superset"
  55. - **List datasets**: "What datasets are available in my Superset instance?"
  56. - **Get database tables**: "What tables are available in database with ID 1?"
  57. - **Execute SQL**: "Run this SQL query on database 1: SELECT * FROM users LIMIT 10"
  58. - **Create dataset**: "Create a new dataset from table 'customers' in database 2"
  59. - **Update database**: "Update the connection settings for database 3"
  60. - **Delete database**: "Delete database connection with ID 4"
  61. - **Validate SQL**: "Is this SQL valid for database 2: SELECT * FROM customers JOIN orders"
  62. - **Get database catalogs**: "Show me the catalogs available in database 1"
  63. - **Get database functions**: "What functions are available in database 2?"
  64. - **Check related objects**: "What dashboards and charts use database 1?"
  65. ### SQL Lab Features
  66. - **Execute queries**: "Run this SQL query: SELECT COUNT(*) FROM orders"
  67. - **Format SQL**: "Format this SQL query: SELECT id,name,age FROM users WHERE age>21"
  68. - **Estimate query cost**: "Estimate the cost of this query: SELECT * FROM large_table"
  69. - **Get saved queries**: "Show me all my saved SQL queries"
  70. - **Get query results**: "Get the results of query with key 'abc123'"
  71. ### User and System Information
  72. - **View user info**: "Who am I logged in as?"
  73. - **Get user roles**: "What roles do I have in Superset?"
  74. - **View recent activity**: "Show me recent activity in my Superset instance"
  75. - **Get menu data**: "What menu items do I have access to?"
  76. - **Get base URL**: "What is the URL of the Superset instance I'm connected to?"
  77. ### Tag Management
  78. - **List tags**: "Show me all tags in my Superset instance"
  79. - **Create tag**: "Create a new tag called 'Finance'"
  80. - **Delete tag**: "Delete the tag with ID 5"
  81. - **Tag an object**: "Add the tag 'Finance' to dashboard 3"
  82. - **Remove tag**: "Remove the tag 'Finance' from chart 7"
  83. ## Available MCP Tools
  84. This plugin offers the following MCP tools that Claude can use:
  85. ### Authentication
  86. - `superset_auth_check_token_validity` - Check if the current access token is valid
  87. - `superset_auth_refresh_token` - Refresh the access token
  88. - `superset_auth_authenticate_user` - Authenticate with Superset
  89. ### Dashboards
  90. - `superset_dashboard_list` - List all dashboards
  91. - `superset_dashboard_get_by_id` - Get a specific dashboard
  92. - `superset_dashboard_create` - Create a new dashboard
  93. - `superset_dashboard_update` - Update an existing dashboard
  94. - `superset_dashboard_delete` - Delete a dashboard
  95. ### Charts
  96. - `superset_chart_list` - List all charts
  97. - `superset_chart_get_by_id` - Get a specific chart
  98. - `superset_chart_create` - Create a new chart
  99. - `superset_chart_update` - Update an existing chart
  100. - `superset_chart_delete` - Delete a chart
  101. ### Databases
  102. - `superset_database_list` - List all databases
  103. - `superset_database_get_by_id` - Get a specific database
  104. - `superset_database_create` - Create a new database connection
  105. - `superset_database_get_tables` - List tables in a database
  106. - `superset_database_schemas` - Get schemas for a database
  107. - `superset_database_test_connection` - Test a database connection
  108. - `superset_database_update` - Update an existing database connection
  109. - `superset_database_delete` - Delete a database connection
  110. - `superset_database_get_catalogs` - Get catalogs for a database
  111. - `superset_database_get_connection` - Get database connection information
  112. - `superset_database_get_function_names` - Get function names supported by a database
  113. - `superset_database_get_related_objects` - Get charts and dashboards associated with a database
  114. - `superset_database_validate_sql` - Validate arbitrary SQL against a database
  115. - `superset_database_validate_parameters` - Validate database connection parameters
  116. ### Datasets
  117. - `superset_dataset_list` - List all datasets
  118. - `superset_dataset_get_by_id` - Get a specific dataset
  119. - `superset_dataset_create` - Create a new dataset
  120. ### SQL Lab
  121. - `superset_sqllab_execute_query` - Execute a SQL query
  122. - `superset_sqllab_get_saved_queries` - List saved SQL queries
  123. - `superset_sqllab_format_sql` - Format a SQL query
  124. - `superset_sqllab_get_results` - Get query results
  125. - `superset_sqllab_estimate_query_cost` - Estimate query cost
  126. - `superset_sqllab_export_query_results` - Export query results to CSV
  127. - `superset_sqllab_get_bootstrap_data` - Get SQL Lab bootstrap data
  128. ### Queries
  129. - `superset_query_list` - List all queries
  130. - `superset_query_get_by_id` - Get a specific query
  131. - `superset_query_stop` - Stop a running query
  132. ### Saved Queries
  133. - `superset_saved_query_get_by_id` - Get a specific saved query
  134. - `superset_saved_query_create` - Create a new saved query
  135. ### User Information
  136. - `superset_user_get_current` - Get current user info
  137. - `superset_user_get_roles` - Get user roles
  138. ### Activity
  139. - `superset_activity_get_recent` - Get recent activity data
  140. ### System
  141. - `superset_menu_get` - Get menu data
  142. - `superset_config_get_base_url` - Get the base URL of the Superset instance
  143. ### Tags
  144. - `superset_tag_list` - List all tags
  145. - `superset_tag_create` - Create a new tag
  146. - `superset_tag_get_by_id` - Get a specific tag
  147. - `superset_tag_objects` - Get objects associated with tags
  148. - `superset_tag_delete` - Delete a tag
  149. - `superset_tag_object_add` - Add a tag to an object
  150. - `superset_tag_object_remove` - Remove a tag from an object
  151. ### Exploration Tools
  152. - `superset_explore_form_data_create` - Create form data for chart exploration
  153. - `superset_explore_form_data_get` - Get form data for chart exploration
  154. - `superset_explore_permalink_create` - Create a permalink for chart exploration
  155. - `superset_explore_permalink_get` - Get a permalink for chart exploration
  156. ### Advanced Data Types
  157. - `superset_advanced_data_type_convert` - Convert a value to an advanced data type
  158. - `superset_advanced_data_type_list` - List available advanced data types
  159. ## Environment Variables
  160. | Variable | Description | Default |
  161. |----------|-------------|---------|
  162. | SUPERSET_BASE_URL | URL of your Superset instance | http://localhost:8088 |
  163. | SUPERSET_USERNAME | Username for Superset | None |
  164. | SUPERSET_PASSWORD | Password for Superset | None |
  165. ## Troubleshooting
  166. - If you encounter authentication issues, verify your credentials in the `.env` file
  167. - Make sure Superset is running and accessible at the URL specified in your `.env` file
  168. - Check that you're using a compatible version of Superset (tested with version 4.1.1)
  169. - Ensure the port used by the MCP server is not being used by another application
  170. ## Security Notes
  171. - Your Superset credentials are stored only in your local `.env` file
  172. - The access token is stored in `.superset_token` file in the project directory
  173. - All authentication happens directly between the MCP server and your Superset instance
  174. - No credentials are transmitted to Claude or any third parties
  175. - For production use, consider using more secure authentication methods
  176. ## Contributing
  177. Contributions are welcome! Please feel free to submit a Pull Request.
  178. ## License
  179. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.