@onmartech/metabase-ai-assistant 4.0.0

package/.env.example

@@ -0,0 +1,38 @@
+# Metabase Configuration
+METABASE_URL=http://localhost:3000
+METABASE_USERNAME=your_username
+METABASE_PASSWORD=your_password
+METABASE_API_KEY=
+
+# Database Configuration (for direct SQL execution)
+DATABASE_TYPE=postgres
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_NAME=your_database
+DATABASE_USER=your_user
+DATABASE_PASSWORD=your_password
+
+# Metabase Metadata Database Configuration (for analytics and insights)
+# This is Metabase's own application database, not your business data
+MB_METADATA_ENABLED=false
+MB_METADATA_ENGINE=postgres
+MB_METADATA_HOST=localhost
+MB_METADATA_PORT=5432
+MB_METADATA_DATABASE=metabase
+MB_METADATA_USER=metabase_user
+MB_METADATA_PASSWORD=metabase_password
+MB_METADATA_SSL=false
+
+# AI Configuration
+OPENAI_API_KEY=your_openai_key
+ANTHROPIC_API_KEY=your_anthropic_key
+
+# Security Settings
+# Read-only mode blocks write operations (INSERT, UPDATE, DELETE, DROP, etc.)
+# Set to 'false' to allow write operations (use with caution)
+METABASE_READ_ONLY_MODE=true
+
+# Application Settings
+PORT=3001
+LOG_LEVEL=info
+ENVIRONMENT=development

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024-2026 ONMARTECH LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,364 @@
+<div align="center">
+
+# 🚀 Metabase AI Assistant
+
+### **The Most Powerful MCP Server for Metabase**
+
+**111+ Tools** • **AI-Powered SQL** • **Enterprise Security** • **Zero Config**
+
+[![npm version](https://img.shields.io/npm/v/metabase-ai-assistant.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/metabase-ai-assistant)
+[![npm downloads](https://img.shields.io/npm/dm/metabase-ai-assistant.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/metabase-ai-assistant)
+[![GitHub stars](https://img.shields.io/github/stars/enessari/metabase-ai-assistant?style=for-the-badge&logo=github)](https://github.com/enessari/metabase-ai-assistant/stargazers)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
+
+[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-blueviolet.svg?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0id2hpdGUiIGQ9Ik0xMiAyTDIgN2wxMCA1IDEwLTV6Ii8+PC9zdmc+)](https://modelcontextprotocol.io/)
+[![Claude](https://img.shields.io/badge/Claude-Ready-orange.svg?style=flat-square)](https://claude.ai)
+[![Cursor](https://img.shields.io/badge/Cursor-Ready-green.svg?style=flat-square)](https://cursor.sh)
+[![Node.js](https://img.shields.io/badge/Node.js-18+-brightgreen.svg?style=flat-square&logo=node.js)](https://nodejs.org/)
+
+---
+
+**Turn your AI assistant into a Metabase power user.**  
+Generate SQL from natural language, create dashboards, manage users, and automate BI workflows.
+
+[**📦 Install Now**](#-quick-start) • [**📖 Documentation**](#-available-tools) • [**🎯 Features**](#-why-this-project) • [**⭐ Star Us**](https://github.com/enessari/metabase-ai-assistant)
+
+</div>
+
+---
+
+## ⭐ Why This Project?
+
+> **"I analyzed every Metabase MCP server on the market. This one has 4x more tools and features than any competitor."**
+
+| Feature | **This Project** | Other MCP Servers |
+|---------|:----------------:|:-----------------:|
+| **Total Tools** | **111+** ✅ | 6-30 |
+| **AI SQL Generation** | ✅ | ❌ |
+| **AI SQL Optimization** | ✅ | ❌ |
+| **Dashboard Templates** | ✅ | ❌ |
+| **User Management** | ✅ | ❌ |
+| **Workspace Export/Import** | ✅ | ❌ |
+| **Read-Only Security Mode** | ✅ | ✅ |
+| **Response Caching** | ✅ | ✅ |
+| **Activity Logging** | ✅ | ❌ |
+| **Metadata Analytics** | ✅ | ❌ |
+| **Parametric Questions** | ✅ | ❌ |
+| **Environment Comparison** | ✅ | ❌ |
+
+---
+
+## 🚀 Quick Start
+
+### One-Line Install
+
+```bash
+npx metabase-ai-assistant
+```
+
+### Add to Claude Desktop / Cursor
+
+```json
+{
+  "mcpServers": {
+    "metabase": {
+      "command": "npx",
+      "args": ["-y", "metabase-ai-assistant"],
+      "env": {
+        "METABASE_URL": "https://your-metabase.com",
+        "METABASE_API_KEY": "mb_your_api_key"
+      }
+    }
+  }
+}
+```
+
+That's it! Your AI assistant now has full Metabase superpowers. 🦸
+
+---
+
+## 🎯 What Can You Do?
+
+### 💬 Natural Language → SQL
+
+```
+You: "Show me total revenue by product category for the last 30 days"
+AI: Uses ai_sql_generate → Runs query → Returns formatted results
+```
+
+### 📊 Instant Dashboard Creation
+
+```
+You: "Create an executive dashboard for our e-commerce sales"
+AI: Uses mb_dashboard_template_executive → Creates fully configured dashboard
+```
+
+### 🔍 Deep Database Exploration
+
+```
+You: "What tables are related to 'orders' and show their relationships"
+AI: Uses db_relationships_detect → Returns complete ER diagram info
+```
+
+### 🛡️ Enterprise-Grade Security
+
+```
+You: "DROP TABLE users" 
+AI: 🔒 Blocked - Read-only mode active
+```
+
+---
+
+## 🔧 Complete Tool List (111+)
+
+<details>
+<summary><b>📊 Database Operations (25 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `db_list` | List all databases |
+| `db_schemas` | Get schemas in a database |
+| `db_tables` | Get tables with fields |
+| `sql_execute` | Execute SQL queries |
+| `db_table_create` | Create tables (AI-prefixed) |
+| `db_view_create` | Create views |
+| `db_matview_create` | Create materialized views |
+| `db_index_create` | Create indexes |
+| `db_vacuum_analyze` | VACUUM and ANALYZE |
+| `db_query_explain` | EXPLAIN query plans |
+| `db_table_stats` | Table statistics |
+| `db_index_usage` | Index usage analysis |
+| `db_schema_explore` | Fast schema exploration |
+| `db_schema_analyze` | Deep schema analysis |
+| `db_relationships_detect` | Detect foreign keys |
+| ...and more |
+
+</details>
+
+<details>
+<summary><b>🤖 AI-Powered Features (5 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `ai_sql_generate` | Natural language → SQL |
+| `ai_sql_optimize` | Query optimization suggestions |
+| `ai_sql_explain` | Explain SQL in plain English |
+| `ai_relationships_suggest` | Suggest table relationships |
+| `mb_auto_describe` | Auto-generate descriptions |
+
+</details>
+
+<details>
+<summary><b>📋 Question/Card Management (12 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `mb_question_create` | Create new questions |
+| `mb_questions` | List all questions |
+| `mb_question_create_parametric` | Parametric questions |
+| `mb_card_get` | Get card details |
+| `mb_card_update` | Update cards |
+| `mb_card_delete` | Delete cards |
+| `mb_card_archive` | Archive cards |
+| `mb_card_data` | Get card data as JSON |
+| `mb_card_copy` | Copy cards |
+| `mb_card_clone` | Clone cards |
+| ...and more |
+
+</details>
+
+<details>
+<summary><b>📈 Dashboard Management (14 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `mb_dashboard_create` | Create dashboards |
+| `mb_dashboards` | List all dashboards |
+| `mb_dashboard_get` | Get dashboard details |
+| `mb_dashboard_update` | Update dashboards |
+| `mb_dashboard_delete` | Delete dashboards |
+| `mb_dashboard_add_card` | Add cards to dashboard |
+| `mb_dashboard_add_filter` | Add filters |
+| `mb_dashboard_layout_optimize` | Optimize layout |
+| `mb_dashboard_template_executive` | Executive templates |
+| ...and more |
+
+</details>
+
+<details>
+<summary><b>👥 User & Permission Management (10 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `mb_user_list` | List users |
+| `mb_user_get` | Get user details |
+| `mb_user_create` | Create users |
+| `mb_user_update` | Update users |
+| `mb_user_disable` | Disable users |
+| `mb_permission_group_list` | List groups |
+| `mb_permission_group_create` | Create groups |
+| ...and more |
+
+</details>
+
+<details>
+<summary><b>📊 Metadata Analytics (14 tools)</b></summary>
+
+| Tool | Description |
+|------|-------------|
+| `mb_meta_overview` | Instance health check |
+| `mb_meta_query_performance` | Query analytics |
+| `mb_meta_content_usage` | Content usage stats |
+| `mb_meta_user_activity` | User activity |
+| `mb_meta_table_dependencies` | Table dependencies |
+| `mb_meta_impact_analysis` | Breaking change analysis |
+| `mb_meta_optimization_recommendations` | Index suggestions |
+| `mb_meta_export_workspace` | Backup to JSON |
+| `mb_meta_import_preview` | Import dry-run |
+| `mb_meta_compare_environments` | Dev vs Prod diff |
+| `mb_meta_auto_cleanup` | Safe cleanup |
+| ...and more |
+
+</details>
+
+---
+
+## 🛡️ Security Features
+
+| Feature | Description |
+|---------|-------------|
+| **🔒 Read-Only Mode** | Blocks INSERT, UPDATE, DELETE, DROP (default: enabled) |
+| **🏷️ AI Prefix** | All AI-created objects use `claude_ai_` prefix |
+| **✅ Explicit Approval** | Destructive operations require confirmation |
+| **📝 Activity Logging** | Full audit trail of all operations |
+| **🔐 Env Validation** | Zod-validated environment variables |
+| **💾 Auto-Backup** | Prompts for backup before destructive ops |
+
+```bash
+# Enable/disable read-only mode
+METABASE_READ_ONLY_MODE=true  # Default: blocks write ops
+METABASE_READ_ONLY_MODE=false # Allow write operations
+```
+
+---
+
+## ⚙️ Configuration
+
+Create a `.env` file:
+
+```bash
+# Required
+METABASE_URL=https://your-metabase.com
+METABASE_API_KEY=mb_your_api_key
+
+# Or use username/password
+# METABASE_USERNAME=admin@example.com
+# METABASE_PASSWORD=your_password
+
+# Security (defaults to true)
+METABASE_READ_ONLY_MODE=true
+
+# AI Features (optional)
+ANTHROPIC_API_KEY=sk-ant-...
+OPENAI_API_KEY=sk-...
+
+# Performance (optional)
+CACHE_TTL_MS=600000  # 10 minutes
+```
+
+---
+
+## 📦 Installation Options
+
+### npm (Recommended)
+
+```bash
+npm install -g metabase-ai-assistant
+```
+
+### Docker
+
+```bash
+docker run -e METABASE_URL=... -e METABASE_API_KEY=... ghcr.io/enessari/metabase-ai-assistant
+```
+
+### From Source
+
+```bash
+git clone https://github.com/enessari/metabase-ai-assistant.git
+cd metabase-ai-assistant
+npm install
+npm run mcp
+```
+
+---
+
+## 🏗️ Architecture
+
+```
+metabase-ai-assistant/
+├── src/
+│   ├── mcp/
+│   │   ├── server.js          # Main MCP server (111+ tools)
+│   │   └── handlers/          # Modular handlers
+│   │       ├── database.js    # DB operations
+│   │       ├── dashboard.js   # Dashboard ops
+│   │       ├── questions.js   # Question ops
+│   │       └── ai.js          # AI features
+│   ├── utils/
+│   │   ├── cache.js           # TTL-based caching
+│   │   ├── config.js          # Zod validation
+│   │   └── response-optimizer.js
+│   └── metabase/
+│       └── client.js          # Metabase API client
+```
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+```bash
+# Fork, clone, install
+git clone https://github.com/YOUR_USERNAME/metabase-ai-assistant.git
+npm install
+
+# Create feature branch
+git checkout -b feature/amazing-feature
+
+# Test and submit PR
+npm test
+git push origin feature/amazing-feature
+```
+
+---
+
+## 📚 Resources
+
+- [📖 Full Documentation](https://github.com/enessari/metabase-ai-assistant/wiki)
+- [🐛 Report Issues](https://github.com/enessari/metabase-ai-assistant/issues)
+- [💬 Discussions](https://github.com/enessari/metabase-ai-assistant/discussions)
+- [📦 npm Package](https://www.npmjs.com/package/metabase-ai-assistant)
+
+---
+
+## 📄 License
+
+Apache License 2.0 - see [LICENSE](LICENSE)
+
+---
+
+<div align="center">
+
+### ⭐ Star this repo if it helps you!
+
+**Built with ❤️ by [Abdullah Enes SARI](https://github.com/enessari) @ [ONMARTECH LLC](https://onmartech.com)**
+
+[![Star History](https://img.shields.io/github/stars/enessari/metabase-ai-assistant?style=social)](https://github.com/enessari/metabase-ai-assistant/stargazers)
+
+---
+
+**Keywords:** Metabase MCP Server, Model Context Protocol, AI SQL Generation, Business Intelligence, Claude AI, Cursor AI, Natural Language SQL, Dashboard Automation, PostgreSQL, Data Analytics, LLM Tools
+
+</div>