Superset MCP

🚀 Superset Project Documentation

This is an MCP (Manager Control Plane) server for managing Superset instances. Through this server, users can perform various operations, including creating, reading, updating, and deleting Superset-related resources.

🚀 Quick Start

1. Configure environment variables to specify the URL and credentials of the Superset instance.
2. Start the MCP server.
3. Use the provided API interfaces to interact with Superset.

✨ Features

Authentication

• Support authentication based on username and password.

Database Management

• Allow users to manage database connections, including testing connections and retrieving related objects (such as charts and dashboards).

SQL Lab

• Provide functions to execute SQL queries, format queries, and export results.

Dataset Management

• Support creating and reading datasets.

User Information

• Retrieve detailed information about the current user and their roles.

📦 Installation

1. Clone the code repository:

   git clone [Repository URL]
   cd superset-mcp
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Create a configuration file .env with the following content:

   SUPERSET_BASE_URL=http://localhost:8088
   SUPERSET_USERNAME=your_username
   SUPERSET_PASSWORD=your_password
   

4. Start the server:

   python server.py
   

📚 Documentation

Detailed Explanation of Functional Modules

Authentication

• superset_authenticate: Authenticate using a username and password and return an access token.

Database Management

• superset_database_list: Get a list of all databases.
• superset_database_get_by_id: Get detailed information about a specific database by ID.
• superset_database_create: Create a new database connection.
• superset_database_test_connection: Test the validity of a database connection.

SQL Lab

• superset_sqllab_execute_query: Execute any SQL query.
• superset_sqllab_format_sql: Format and clean SQL code.
• superset_sqllab_export_query_results: Export query results as a CSV file.

Dataset Management

• superset_dataset_list: List all available datasets.
• superset_dataset_get_by_id: Get detailed information about a specific dataset by ID.
• superset_dataset_create: Create a new dataset.

Environment Variables

Troubleshooting

• Authentication issues: Check if the credentials in the .env file are correct.
• Connection issues: Ensure that the Superset instance is running and accessible via the specified URL.
• Version compatibility: It is recommended to use a tested Superset version (e.g., 4.1.1).

Security Precautions

• Usernames and passwords are only stored in the local .env file and are not transmitted to third parties.
• Access tokens are stored in the .superset_token file in the project directory.
• All authentication processes occur directly between the MCP server and the Superset instance.

Contribution Guidelines

Contributions are welcome! Please feel free to submit pull requests.

📄 License

This project is licensed under the MIT License.