Spaces:

nothingworry
/

IntegraChat

Sleeping

App Files Files Community

nothingworry commited on 28 days ago

Commit

9a99098

1 Parent(s): ba6735b

first commit

Browse files

Files changed (1) hide show

README.md +226 -159

README.md CHANGED Viewed

@@ -1,163 +1,188 @@
-# **IntegraChat — Multi-Tenant Autonomous MCP Platform**
-### **Enterprise-grade AI with autonomous agents, secure multi-tenant RAG, real-time web search, red-flag governance, and analytics.**
 ---
-## **📌 Overview**
 **IntegraChat** is an enterprise-ready, multi-tenant AI platform built to demonstrate the full capabilities of the **Model Context Protocol (MCP)** in a real production-style environment.
 It combines **autonomous tool-using agents**, **RAG retrieval**, **live web search**, and **admin governance** under strict **tenant isolation**, powered by Groq's **Llama-3.1-8B**.
-IntegraChat is a complete "**MCP in Action**" ecosystem — ideal for enterprise demos, research, production scaffolds, and governance-focused AI deployments.
 ---
-# **🎯 Purpose**
 IntegraChat showcases how MCP can power **intelligent, governed, multi-tenant AI systems** with real-world requirements:
-* Isolation & access control
-* Compliance & red-flag detection
-* Tool-aware autonomous reasoning
-* RAG + web search hybrid AI
-* Analytics & observability
-* Admin governance workflows
 ---
-# **🧩 Key Features**
-## **1. Autonomous MCP Agents**
-Agents can:
-* Analyze user intent
-* Detect sensitive or unsafe content
-* Dynamically select tools (RAG, Web, Admin, etc.)
-* Retrieve tenant-private knowledge
-* Pull real-time data from the internet
-* Trigger admin alerts
-* Respond using Groq's **Llama-3.1-8B**
-## **2. Enterprise RAG System**
-* MiniLM embeddings
-* Supabase + pgvector
-* Strict multi-tenant RLS enforcement
-* PDF / DOCX / TXT / URL ingestion
-* Chunking + semantic search
-## **3. Live Web Search Tool**
-* Real-time news
-* General web search
-* Fact-checking & fresh data retrieval
-## **4. Red-Flag Governance Engine**
 Admins configure rules to:
-* Block unsafe queries
-* Log violations
-* Trigger admin alerts
-Examples: `salary`, `delete all data`, `confidential client info`.
-## **5. Analytics Dashboard**
-Includes insights for:
-* Query volume
-* Tool usage
-* RAG performance
-* Red-flag violations
-* Agent reasoning traces
-* Tenant activity
-## **6. Multi-Tenant Isolation**
 Each tenant gets:
-* Private agents
-* Private knowledge base
-* Private admin rules
-* Private analytics
-Isolation is guaranteed via **Supabase RLS**.
 ---
-# **🛠 Technology Stack**
-## **Backend**
-* FastAPI
-* MCP Client + MCP Servers
-* Supabase (Auth + Storage + pgvector)
-* MiniLM Embeddings
-* Groq Llama-3.1-8B
-* DuckDuckGo Search
-* Slack / Email alerting
-## **Frontend**
-* React 18
-* TailwindCSS
-* Zustand
-* WebSocket streaming
-* Admin dashboard + analytics
 ---
-# **🧱 System Architecture**
 ```
-Frontend (React)
- - Chat UI
- - Admin Panel
- - Analytics / Insights
- - WebSocket streaming
-MCP Client (FastAPI)
- - Intent handling
- - Red-flag scanning
- - Tool selection logic
- - Calls Groq Llama-3.1
- - Event logging
-MCP Servers:
- - RAG Server (private knowledge)
- - Web Search Server (live data)
- - Admin Server (alerts / governance)
-Database:
- - Supabase (Auth + Storage + pgvector + RLS)
 ```
 ---
-# **📁 Project Structure**
 ```
 IntegraChat/
@@ -244,14 +269,17 @@ IntegraChat/
 ├── frontend/
 │   ├── src/
 │   │   ├── components/
-│   │   │   ├── chat/ChatWindow.jsx
-│   │   │   ├── chat/MessageBubble.jsx
-│   │   │   ├── chat/ToolTraces.jsx
-│   │   │   ├── admin/RedFlagEditor.jsx
-│   │   │   ├── admin/TenantManager.jsx
-│   │   │   ├── analytics/QueryStats.jsx
-│   │   │   ├── analytics/ToolUsageChart.jsx
-│   │   │   └── analytics/RagEffectiveness.jsx
 │   │   ├── pages/
 │   │   │   ├── ChatPage.jsx
 │   │   │   ├── AdminPage.jsx
@@ -306,80 +334,119 @@ IntegraChat/
 ---
-# **🚀 Getting Started**
-## **Prerequisites**
-* Python 3.10+
-* Node.js 18+
-* Supabase project
-* Groq API key
-* DuckDuckGo Search key (if configured)
-* Slack/Email webhook for alerts (optional)
----
-## **Backend Setup**
-```sh
-cd backend
-pip install -r requirements.txt
-cp .env.example .env   # Fill in Supabase + Groq keys
-uvicorn app:app --reload
-```
-## **Frontend Setup**
-```sh
-cd frontend
-npm install
-npm run dev
-```
----
-# **✨ Why IntegraChat Stands Out**
-* **True MCP-native autonomous agents** (not static prompts)
-* **Enterprise governance system** with regex-based red-flag rules
-* **Hybrid RAG + web search** reasoning
-* **Production-grade multi-tenant design** with strict Supabase RLS
-* **Full observability**: logs, analytics, tool events, violations
-* **Demo-ready**: perfect for enterprise presentations
 ---
-# **🏷 Submission Metadata**
-**Track:** MCP in Action
-**Category:** Enterprise
-**Tag:** `mcp-in-action-track-enterprise`
-**Project Name:** **IntegraChat**
-### **Short Summary**
 > IntegraChat is a multi-tenant AI platform where autonomous MCP-powered agents retrieve private knowledge using RAG, access live web information, and enforce admin-defined safety rules via a red-flag compliance system. It includes an analytics dashboard, tool-selection engine, and strict tenant isolation.
 ---
-# **📄 License**
-Add your license here (MIT recommended).
 ---
-# **📬 Contact**
-If you'd like, I can generate:
-* ✔ Pitch deck
-* ✔ Notion documentation
-* ✔ Demo video script
-* ✔ Architecture diagram SVG
-* ✔ Full API reference
 ---

+<div align="center">
+# 🚀 IntegraChat
+### Multi-Tenant Autonomous MCP Platform
+**Enterprise-grade AI with autonomous agents, secure multi-tenant RAG, real-time web search, red-flag governance, and analytics.**
+[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)](https://www.python.org/)
+[![React](https://img.shields.io/badge/React-18-blue.svg)](https://reactjs.org/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-Latest-green.svg)](https://fastapi.tiangolo.com/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![MCP](https://img.shields.io/badge/MCP-In%20Action-purple.svg)](https://modelcontextprotocol.io/)
+</div>
+---
+## 📑 Table of Contents
+- [Overview](#-overview)
+- [Purpose](#-purpose)
+- [Key Features](#-key-features)
+- [Technology Stack](#-technology-stack)
+- [System Architecture](#-system-architecture)
+- [Project Structure](#-project-structure)
+- [Getting Started](#-getting-started)
+- [Why IntegraChat Stands Out](#-why-integrachat-stands-out)
+- [Submission Metadata](#-submission-metadata)
+- [License](#-license)
 ---
+## 📌 Overview
 **IntegraChat** is an enterprise-ready, multi-tenant AI platform built to demonstrate the full capabilities of the **Model Context Protocol (MCP)** in a real production-style environment.
 It combines **autonomous tool-using agents**, **RAG retrieval**, **live web search**, and **admin governance** under strict **tenant isolation**, powered by Groq's **Llama-3.1-8B**.
+IntegraChat is a complete **"MCP in Action"** ecosystem — ideal for enterprise demos, research, production scaffolds, and governance-focused AI deployments.
 ---
+## 🎯 Purpose
 IntegraChat showcases how MCP can power **intelligent, governed, multi-tenant AI systems** with real-world requirements:
+- 🔒 **Isolation & Access Control** - Strict tenant separation
+- 🛡️ **Compliance & Red-Flag Detection** - Automated safety monitoring
+- 🤖 **Tool-Aware Autonomous Reasoning** - Dynamic tool selection
+- 🔍 **RAG + Web Search Hybrid AI** - Best of both worlds
+- 📊 **Analytics & Observability** - Full system insights
+- ⚙️ **Admin Governance Workflows** - Enterprise-ready controls
 ---
+## 🧩 Key Features
+### 1. 🤖 Autonomous MCP Agents
+Agents can intelligently:
+- ✅ Analyze user intent and context
+- ✅ Detect sensitive or unsafe content
+- ✅ Dynamically select tools (RAG, Web, Admin, etc.)
+- ✅ Retrieve tenant-private knowledge
+- ✅ Pull real-time data from the internet
+- ✅ Trigger admin alerts when needed
+- ✅ Respond using Groq's **Llama-3.1-8B**
+### 2. 📚 Enterprise RAG System
+- **MiniLM embeddings** for semantic search
+- **Supabase + pgvector** for vector storage
+- **Strict multi-tenant RLS enforcement** for security
+- **Multiple format support**: PDF / DOCX / TXT / URL ingestion
+- **Intelligent chunking** + semantic search
+### 3. 🌐 Live Web Search Tool
+- Real-time news and information
+- General web search capabilities
+- Fact-checking & fresh data retrieval
+- Multiple provider support (DuckDuckGo, SerpAPI, Bing)
+### 4. 🚨 Red-Flag Governance Engine
 Admins configure rules to:
+- ⛔ Block unsafe queries automatically
+- 📝 Log violations for audit trails
+- 🔔 Trigger admin alerts in real-time
+**Example rules**: `salary`, `delete all data`, `confidential client info`
+### 5. 📊 Analytics Dashboard
+Comprehensive insights for:
+- 📈 Query volume and trends
+- 🔧 Tool usage statistics
+- 🎯 RAG performance metrics
+- 🚨 Red-flag violation tracking
+- 🧠 Agent reasoning traces
+- 👥 Tenant activity monitoring
+### 6. 🏢 Multi-Tenant Isolation
 Each tenant gets:
+- 🔐 Private agents
+- 📦 Private knowledge base
+- ⚙️ Private admin rules
+- 📊 Private analytics
+Isolation is guaranteed via **Supabase Row-Level Security (RLS)**.
 ---
+## 🛠 Technology Stack
+### Backend
+| Technology | Purpose |
+|------------|---------|
+| **FastAPI** | High-performance API framework |
+| **MCP Client + Servers** | Model Context Protocol implementation |
+| **Supabase** | Auth + Storage + pgvector database |
+| **MiniLM Embeddings** | Semantic search embeddings |
+| **Groq Llama-3.1-8B** | LLM inference engine |
+| **DuckDuckGo Search** | Web search provider |
+| **Slack / Email** | Alerting system |
+### Frontend
+| Technology | Purpose |
+|------------|---------|
+| **React 18** | Modern UI framework |
+| **TailwindCSS** | Utility-first styling |
+| **Zustand** | State management |
+| **WebSocket** | Real-time streaming |
+| **Admin Dashboard** | Analytics & governance UI |
 ---
+## 🧱 System Architecture
 ```
+┌─────────────────────────────────────────────────────────────┐
+│                    Frontend (React)                         │
+│  ┌──────────┐  ┌──────────┐  ┌──────────┐  ┌──────────┐  │
+│  │ Chat UI  │  │  Admin   │  │Analytics │  │WebSocket │  │
+│  │          │  │  Panel   │  │ Dashboard│  │Streaming │  │
+│  └──────────┘  └──────────┘  └──────────┘  └──────────┘  │
+└─────────────────────────────────────────────────────────────┘
+                            ↕ HTTP/WebSocket
+┌─────────────────────────────────────────────────────────────┐
+│              MCP Client (FastAPI)                           │
+│  • Intent handling                                          │
+│  • Red-flag scanning                                        │
+│  • Tool selection logic                                     │
+│  • Groq Llama-3.1 integration                              │
+│  • Event logging                                            │
+└─────────────────────────────────────────────────────────────┘
+                            ↕ MCP Protocol
+┌─────────────────────────────────────────────────────────────┐
+│                    MCP Servers                              │
+│  ┌──────────────┐  ┌──────────────┐  ┌──────────────┐     │
+│  │ RAG Server   │  │ Web Search   │  │ Admin Server │     │
+│  │ (Knowledge)  │  │   (Live)     │  │ (Governance) │     │
+│  └──────────────┘  └──────────────┘  └──────────────┘     │
+└─────────────────────────────────────────────────────────────┘
+                            ↕
+┌────────────────────────────────────────────────────���────────┐
+│              Supabase Database                              │
+│  • Authentication                                           │
+│  • pgvector (embeddings)                                    │
+│  • Row-Level Security (RLS)                                 │
+│  • Storage                                                  │
+└─────────────────────────────────────────────────────────────┘
 ```
 ---
+## 📁 Project Structure
 ```
 IntegraChat/
 ├── frontend/
 │   ├── src/
 │   │   ├── components/
+│   │   │   ├── chat/
+│   │   │   │   ├── ChatWindow.jsx
+│   │   │   │   ├── MessageBubble.jsx
+│   │   │   │   └── ToolTraces.jsx
+│   │   │   ├── admin/
+│   │   │   │   ├── RedFlagEditor.jsx
+│   │   │   │   └── TenantManager.jsx
+│   │   │   └── analytics/
+│   │   │       ├── QueryStats.jsx
+│   │   │       ├── ToolUsageChart.jsx
+│   │   │       └── RagEffectiveness.jsx
 │   │   ├── pages/
 │   │   │   ├── ChatPage.jsx
 │   │   │   ├── AdminPage.jsx
 ---
+## 🚀 Getting Started
+### Prerequisites
+Before you begin, ensure you have the following installed:
+- ✅ **Python 3.10+**
+- ✅ **Node.js 18+**
+- ✅ **Supabase project** (with pgvector extension)
+- ✅ **Groq API key**
+- ✅ **DuckDuckGo Search key** (optional, if configured)
+- ✅ **Slack/Email webhook** for alerts (optional)
+### Backend Setup
+1. **Navigate to backend directory**
+   ```bash
+   cd backend
+   ```
+2. **Install dependencies**
+   ```bash
+   pip install -r requirements.txt
+   ```
+3. **Configure environment variables**
+   ```bash
+   cp .env.example .env
+   # Edit .env and fill in your Supabase + Groq keys
+   ```
+4. **Run the development server**
+   ```bash
+   uvicorn api.main:app --reload
+   ```
+### Frontend Setup
+1. **Navigate to frontend directory**
+   ```bash
+   cd frontend
+   ```
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
+3. **Start the development server**
+   ```bash
+   npm run dev
+   ```
+### Quick Start with Docker
+```bash
+docker-compose up -d
+```
 ---
+## ✨ Why IntegraChat Stands Out
+| Feature | Description |
+|---------|-------------|
+| 🤖 **True MCP-Native** | Autonomous agents (not static prompts) |
+| 🛡️ **Enterprise Governance** | Regex-based red-flag rules system |
+| 🔍 **Hybrid Intelligence** | RAG + web search reasoning |
+| 🏢 **Production-Grade** | Multi-tenant design with strict Supabase RLS |
+| 📊 **Full Observability** | Logs, analytics, tool events, violations |
+| 🎯 **Demo-Ready** | Perfect for enterprise presentations |
+---
+## 🏷 Submission Metadata
+| Field | Value |
+|-------|-------|
+| **Track** | MCP in Action |
+| **Category** | Enterprise |
+| **Tag** | `mcp-in-action-track-enterprise` |
+| **Project Name** | **IntegraChat** |
+### Short Summary
 > IntegraChat is a multi-tenant AI platform where autonomous MCP-powered agents retrieve private knowledge using RAG, access live web information, and enforce admin-defined safety rules via a red-flag compliance system. It includes an analytics dashboard, tool-selection engine, and strict tenant isolation.
 ---
+## �� License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 ---
+## 📬 Contributing
+Contributions are welcome! Please feel free to submit a Pull Request.
+---
+## 🙏 Acknowledgments
+- Built with [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
+- Powered by [Groq](https://groq.com/) for LLM inference
+- Database powered by [Supabase](https://supabase.com/)
 ---
+<div align="center">
+**Made with ❤️ for the MCP community**
+[⬆ Back to Top](#-integrachat)
+</div>