superset-mcp-server

# WIP: MCP Server Superset A Model Context Protocol (MCP) server-side application built on the Apache Superset REST API. ## Project Introduction This project implements basic query capabilities through large models on MCP based on the Apache Superset REST API. ## Features - Query databases - Query tables - Query fields - Execute SQL ## Environment Requirements - Node.js >= 14.0.0 ## Quick Start ### Direct Use ```bash npx -y https://github.com/LiusCraft/superset-mcp-server SUPERSET_URL SUPERSET_USERNAME SUPERSET_PASSWORD Authentication method: ldap ``` ### Install Dependencies ```bash # Install Node.js dependencies npm install ``` ### Start the Service ```bash # API client test npm run src/examples/superset-example.ts # Debugging environment npm run inspector # Production environment npm run build npm start ``` ## Configuration Instructions The project configuration file is located in the `config` directory and includes: - Database configuration - API configuration - Security configuration ## API Documentation Refer to the official Swagger documentation of Superset. ## Development Guide ### Directory Structure ``` . ├── src/ # Source code directory ├── src/examples # Encapsulated API client test code ├── src/services # Encapsulated API functions ├── src/utils # Encapsulated Superset baseHttpClient ├── src/index.ts # Defines MCP interfaces ``` ### Development Standards - Follow ESLint standards - Use TypeScript for development - Follow Git Flow workflow ## Deployment ### MCP Deployment 1. Build the project 2. Set MCP configuration: ```bash node currentFolder/build/index.js ``` 3. Use the MCP ## Contribution Guidelines 1. Fork this repository 2. Create a feature branch 3. Submit changes 4. Initiate a Pull Request ## License [Apache License 2.0](LICENSE) ## Contact If you have any questions, please submit an Issue or contact the project maintainer.