superset

This MCP server provides a bridge to Apache Superset via the MCP interface, enabling a large language model to perform basic query operations against a Superset instance. It supports capabilities such as querying the database, listing tables, inspecting fields, and executing SQL through natural language prompts processed by the MCP layer. You can run the server with npx and then leverage the MCP endpoints to compose queries that are translated into Superset API calls. The configuration expects Superset connection details to be supplied via environment variables, including the Superset URL and credentials, so the MCP layer can authenticate and perform the requested queries.

Prerequisites:

• Node.js >= 14.0.0
• npm (comes with Node.js)

Install and run via npx (quick start):

npx -y https://github.com/LiusCraft/superset-mcp-server

Set required environment variables when starting the service:

• SUPERSET_URL: URL of your Superset instance
• SUPERSET_USERNAME: username for Superset
• SUPERSET_PASSWORD: password for Superset
• AUTH_METHOD: authentication method (e.g., ladp as indicated in the README)

Alternative local installation (clone and install):

git clone https://github.com/LiusCraft/superset-mcp-server.git
cd superset-mcp-server
npm install
# Run (adjust environment variables as needed)
SUPERSET_URL=http://your-superset-host.com SUPERSET_USERNAME=youruser SUPERSET_PASSWORD=yourpass AUTH_METHOD=ladp npm start

Usage commands during development:

• api client testing:

npm run src/examples/superset-example.ts

• debug mode (inspector):

npm run inspector

• build for production and start:

npm run build
npm start

Tips and notes:

• Ensure Node.js version compatibility (>= 14).
• The MCP server relies on environment variables for Superset connection; securely manage credentials.
• If you encounter authentication errors, verify the AUTH_METHOD and that the Superset user has the necessary permissions for the queries you intend to run.
• The README references an upstream npx URL; using the direct URL ensures you are pulling the MCP server as described for this project.
• For production, use the build output and the production start script as indicated in the deployment steps.
• If you need to extend capabilities, you can add more API wrappers around Superset REST API calls in the src/services directory and expose them through the MCP interface.