@revealui/mcp 0.0.1-pre.0 → 0.1.0

package/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3.8'
+services:
+  postgres:
+    image: postgres:15
+    environment:
+      POSTGRES_USER: dev
+      POSTGRES_PASSWORD: dev
+      POSTGRES_DB: revealui_mcp
+    volumes:
+      - ./migrations:/docker-entrypoint-initdb.d
+      - pgdata:/var/lib/postgresql/data
+    ports:
+      - '5432:5432'
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U dev"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 1G
+        reservations:
+          cpus: '0.25'
+          memory: 256M
+    labels:
+      - "com.revealui.service=postgres"
+      - "com.revealui.environment=development"
+
+  # Optional: Electric dev service (pglite/electric) — replace image/name with actual Electric dev image if used
+  # electric:
+  #   image: electricsql/electric:latest
+  #   environment:
+  #     ELECTRIC_API_KEY: ${ELECTRIC_API_KEY}
+  #   ports:
+  #     - '8080:8080'
+
+  # Optional: Loki for logs collection (used by logs-first metrics flow)
+  # loki:
+  #   image: grafana/loki:2.8.2
+  #   ports:
+  #     - '3100:3100'
+
+volumes:
+  pgdata:

package/docs/INDEX.md

@@ -0,0 +1,88 @@
+# MCP Package Documentation Index
+
+Complete documentation for RevealUI's Model Context Protocol integration.
+
+## Quick Links
+
+- **[Main Guide](./README.md)** - Complete MCP overview and setup
+- **[Setup Guide](./SETUP.md)** - Step-by-step configuration
+- **[Configuration Templates](../configs/README.md)** - Config file templates
+
+## MCP Servers
+
+### Code Validator
+- **[Documentation](./servers/code-validator.md)** - Prevents AI-generated technical debt
+- **Server:** `packages/mcp/src/servers/code-validator.ts`
+- **Status:** ✅ Active (installed)
+
+### External Services
+- **Vercel** - Deployment and storage (`src/servers/vercel.ts`)
+- **Stripe** - Payment processing (`src/servers/stripe.ts`)
+- **Neon** - Database operations (`src/servers/neon.ts`)
+- **Supabase** - Project management (`src/servers/supabase.ts`)
+- **Playwright** - Browser automation (`src/servers/playwright.ts`)
+- **Next.js DevTools** - Debugging (`src/servers/next-devtools.ts`)
+
+## Package Structure
+
+```
+packages/mcp/
+├── src/
+│   ├── servers/          # MCP server implementations
+│   ├── config/           # Configuration utilities
+│   └── adapters/         # Database adapters
+├── configs/              # Template configurations
+│   ├── claude-template.json
+│   └── README.md
+├── docs/                 # This documentation
+│   ├── README.md         # Main guide
+│   ├── SETUP.md          # Setup instructions
+│   └── servers/          # Per-server docs
+├── migrations/           # Database migrations
+└── package.json
+```
+
+## Getting Started
+
+1. **[Read the main guide](./README.md)** - Understand MCP in RevealUI
+2. **[Follow setup](./SETUP.md)** - Configure MCP for your IDE
+3. **[Use templates](../configs/README.md)** - Apply config templates
+
+## Common Tasks
+
+### Enable Code Validator
+```bash
+# Already configured at:
+~/.claude/config.json
+```
+
+### Add More Servers
+```bash
+# Edit config and enable servers
+code ~/.claude/config.json
+
+# Set required env vars
+export VERCEL_API_KEY=...
+export STRIPE_SECRET_KEY=...
+```
+
+### Test MCP Server
+```bash
+tsx packages/mcp/src/servers/code-validator.ts
+# Should start and wait for input (Ctrl+C to exit)
+```
+
+## Related Documentation
+
+- [Code Validation](./servers/code-validator.md) - Code validator guide
+- [Main README](../README.md) - Package overview
+- [Root MCP Guide](/docs/MCP.md) - Legacy (will be deprecated)
+
+## Support
+
+- Issues: [GitHub Issues](https://github.com/RevealUIStudio/revealui/issues)
+- MCP Spec: [modelcontextprotocol.io](https://modelcontextprotocol.io/)
+
+---
+
+**Last Updated:** 2026-02-04