overmind-mcp 2.3.4 → 2.4.1

package/README.md

@@ -1,60 +1,44 @@
-<p align="center">
-  <img src="assets/overmind.png" alt="OverMind-MCP Banner" width="293" height="253">
-</p>
-
-<div align="center">
-
 # 🧠 OverMind-MCP
 
-</div>
+_Orchestrateur universel agents IA multi-modeles via MCP pour piloter Claude-Code, Gemini-cli, Qwen, Kilo/Cline, OpenClaw, GLM, Minimax, Kimi, Ollama et plus sans limite._
 
-_Orchestrateur universel agents IA multi-modeles via MCP pour piloter Claude-Code, Gemini-cli, QwenCli, Nous Hermes, Kilo/Cline, OpenClaw, GLM, Minimax, Kimi, Ollama et plus sans limite._
+![OverMind-MCP Banner](assets/overmind_mcp_banner_slim.png)
 
 <p align="center">
   <a href="https://discord.gg/4AR82phtBz"><img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"></a>
   <a href="https://deamondev888.github.io/overmind-mcp/"><img src="https://img.shields.io/badge/Documentation-Live-00fff5?style=for-the-badge&logo=google-chrome&logoColor=white" alt="Live Doc"></a>
 </p>
 
-**OverMind-MCP** est une conscience supérieure conçue pour orchestrer, commander et automatiser une flotte illimitée d'agents IA. Compatible avec **Claude-Code, Gemini-cli, QwenCli, Nous Hermes, Kilo/Cline, OpenClaw**, et prêt pour **GLM, Minimax, Kimi, Ollama** et bien d'autres. Plus qu'un simple runner, c'est le **Cortex Central** de votre infrastructure IA.
+## 👋 C'est quoi ?
+
+**OverMind-MCP** est une conscience supérieure conçue pour orchestrer, commander et automatiser une flotte illimitée d'agents IA. Compatible avec **Claude-Code, Gemini-cli, Qwen-cli, Kilo/Cline, OpenClaw**, et prêt pour **GLM, Minimax, Kimi, Ollama** et bien d'autres. Plus qu'un simple runner, c'est le **Cortex Central** de votre infrastructure IA.
 
 Il transforme les outils CLI isolés en une force coordonnée, pilotable par API ou par MCP, capable d'exécuter des missions complexes en 2 secondes chrono. de creer et d orchestrer des pipeline de plusieurs agent. il est expert en outils MCP et peu etre scripté pour les faire fonctionner ensemble et les mettre en productions
 
-- 🔌 **Contrôle Total** : Lancez des missions complexes via MCP ou directement via le code (Claude, Gemini, QwenCli, Hermes).
-- 🏗️ **Architecture Pro** : Basé sur des services (`AgentManager`, `ClaudeRunner`, `PromptManager`) pour une stabilité maximale.
-- 🧠 **Mémoire Haute-Performance (4096D)** : Système RAG intégré via PostgreSQL + `pgvector` supportant les embeddings SOTA (Qwen 8B).
-- 🕵️ **Auto-Diagnostic CLI** : Détecte automatiquement les runners manquants et fournit les instructions/liens officiels pour l'installation.
-- 🛡️ **Mémoire Ségréguée** : Chaque agent peut posséder ses propres souvenirs isolés tout en ayant accès au socle de connaissances global.
-- 🛠️ **Capacités Étendues** : L'agent piloté peut utiliser VOS outils (Base de données, Scrapers, etc.).
-- 🤖 **Multi-Agents** : Créez, configurez et gérez des personnalités d'agents isolées (Prompts & Settings dédiés).
-- 📦 **Prêt pour l'Intégration** : Importable comme un module NPM dans vos autres projets.
+## ✨ Ce que ça fait
+
+- **🔌 Contrôle Total** : Lancez des missions complexes via MCP ou directement via le code.
+- **🏗️ Architecture Pro** : Basé sur des services (`AgentManager`, `ClaudeRunner`, `PromptManager`) pour une stabilité maximale.
+- **🧠 Mémoire Haute-Performance (4096D)** : Système RAG intégré via PostgreSQL + `pgvector` supportant les embeddings SOTA (Qwen 8B).
+- **🛡️ Mémoire Ségréguée** : Chaque agent peut posséder ses propres souvenirs isolés tout en ayant accès au socle de connaissances global.
+- **🛠️ Capacités Étendues** : L'agent piloté peut utiliser VOS outils (Base de données, Scrapers, etc.).
+- **🤖 Multi-Agents** : Créez, configurez et gérez des personnalités d'agents isolées (Prompts & Settings dédiés).
+- **📦 Prêt pour l'Intégration** : Importable comme un module NPM dans vos autres projets.
 
 ---
 
-## 🚀 Installation
+## 🚀 Commencer (Guide Facile)
+
+### Option 1 : Utilisation Globale ou Package distant NPM
 
-### Globale via NPM (Recommandé)
+Si vous souhaitez l'installer globalement sans cloner de repo, vous pouvez utiliser :
 
 ```bash
-npm install -g overmind-mcp@latest
+npm install -g overmind-mcp
 ```
 
-**🎯 Ce qui est installé automatiquement :**
-
-1. **Détection Docker** - Compatible avec Docker Desktop, Podman, Rancher Desktop, Colima, OrbStack
-2. **PostgreSQL + pgvector** - Container Docker avec extension vectorielle (si absent)
-3. **overmind-postgres-mcp** - Serveur MCP PostgreSQL vectoriel installé automatiquement
-4. **Configuration complète** - Fichiers .env et .mcp.json générés automatiquement
-5. **Base de données initialisée** - Tables OverMind créées automatiquement
-
-**✅ Installation ultra-simplifiée :**
-- 📦 **Taille** : 1-5 GB (au lieu de 8 GB)
-- ⚡ **Rapide** : ~15 secondes chrono
-- 🎯 **Automatique** : Tout configuré pour vous
-- 🛡️ **Sécurisé** - Vos containers personnels sont protégés
-
-### Configuration MCP
-
-Pour utiliser OverMind dans votre IDE ou CLI préféré :
+**Configuration MCP (Client) pour l'Option 1 :**
+Pour connecter l'orchestrateur distant à un client ou à Cursor,Antigravity ou Claude Code, pointez simplement via `npx` :
 
 ```json
 {
@@ -69,27 +53,69 @@ Pour utiliser OverMind dans votre IDE ou CLI préféré :
 
 ---
 
-## 🔧 Installation Locale (Dev)
-
-Si vous souhaitez contribuer au projet :
+### Option 2 : Installation Locale (Développement ou hébergement précis)
 
 ```bash
-# Cloner le repo
-git clone https://github.com/DeamonDev888/overmind-mcp.git
+# 1. Cloner le repo localement
+git clone https://github.com/DeamonDev888/overmind-mcp overmind-mcp
 cd overmind-mcp
 
-# Installer les dépendances
+# 2. Installer les dépendances
 pnpm install
 
-# Builder le projet
+# 3. Build le projet
 pnpm run build
 ```
 
+Pour que l'agent puisse voir vos autres serveurs MCP locaux, copiez le fichier d'exemple :
+
+```bash
+cp .mcp.json.example .mcp.json
+```
+
+**Configuration MCP (Client) pour l'Option 2 :**
+Pour connecter ce runner à un client en pointant vers votre version locale compilée :
+
+```json
+{
+  "mcpServers": {
+    "overmind": {
+      "command": "node",
+      "args": ["/LE_CHEMIN_ABSOLU_VERS_LE_DOSSIER_CLONE/dist/bin/cli.js"]
+    }
+  }
+}
+```
+
 ---
 
-### Utilisation comme Bibliothèque
+## 🔐 Configuration Credentials (.env)
 
-Vous pouvez utiliser OverMind-MCP comme un module dans vos propres projets TypeScript/JavaScript :
+Créez un fichier `.env` à la racine du projet avec vos credentials :
+
+```env
+# PostgreSQL (requis)
+POSTGRES_HOST=localhost
+POSTGRES_PORT=5432
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=votre_password
+POSTGRES_DATABASE=financial_analyst
+
+# OpenRouter Embeddings (optionnel)
+OPENROUTER_API_KEY=sk-or-v1-votre_clef_openrouter
+OPENROUTER_MODEL=qwen/qwen3-embedding-8b
+EMBEDDING_DIMENSIONS=4096
+
+# LLM Providers (optionnel)
+MINIMAX_API_KEY=votre_clef_minimax
+Z_API_KEY=votre_clef_z_ai
+```
+
+> ⚠️ Le serveur MCP `serveur_PostGreSQL` utilise automatiquement les credentials depuis ce `.env` s'il ne trouve pas son propre `.env` local.
+
+---
+
+Vous pouvez désormais importer le moteur du runner dans vos propres scripts :
 
 ```typescript
 import { runAgent, AgentManager, updateConfig } from 'overmind-mcp';
@@ -99,9 +125,9 @@ updateConfig('./settings.json', './mcp.local.json');
 
 // 2. Gestion des agents
 const manager = new AgentManager();
-await manager.createAgent('expert-seo', 'Tu es un expert SEO...', 'claude');
+await manager.createAgent('expert-seo', 'Tu es un expert SEO...', 'claude-3-5-sonnet');
 
-// 3. Lancer une exécution
+// 3. Lancer une exécution via l'Orchestrateur Unifié
 const { content, isError } = await runAgent({
   runner: 'claude',
   agentName: 'expert-seo',
@@ -118,65 +144,12 @@ if (!isError) {
 
 ## 📂 Structure du Projet
 
-OverMind-MCP est organisé de manière modulaire pour faciliter la navigation et la maintenance.
-
-```
-Workflow/
-├── 📦 bin/                    # Scripts d'installation
-├── 📋 changelog/             # Historique des versions
-├── 🐳 docker/                # Configuration Docker
-├── 🗄️ db/                    # Scripts base de données
-├── ⚙️ config/               # Configurations MCP
-├── 📚 docs/                  # Documentation complète
-├── 💻 src/                   # Code source
-│   ├── bin/                  # Points d'entrée CLI
-│   ├── lib/                  # Bibliothèques partagées
-│   ├── services/             # Services métier
-│   └── tools/                # Outils MCP
-├── 🧪 tests/                 # Tests unitaires
-└── 🔧 scripts/              # Scripts de maintenance
-```
-
-**📖 Documentation détaillée** : Voir [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) pour une explication complète de chaque dossier.
-
-**Points clés :**
-- `src/services/` : Le cœur du système (Logique métier isolée en services)
-- `src/tools/` : Les outils MCP qui appellent les services
-- `src/bin/cli.ts` : Le point d'entrée exécutable pour le terminal
-- `src/server.ts` : La définition du serveur FastMCP
-- `.claude/` : Stockage des agents (Prompts `.md` et Settings `.json`)
-
----
-
-## ⚙️ Configuration MCP (après installation globale)
-
-Après `npm install -g overmind-mcp`, voici la configuration MCP recommandée pour votre client (Claude Code, Cline, etc.) :
-
-```json
-{
-  "mcpServers": {
-    "overmind": {
-      "command": "overmind",
-      "description": "OverMind-MCP principal - Orchestration d'agents IA"
-    },
-    "memory": {
-      "command": "overmind",
-      "args": ["--memory-only"],
-      "description": "OverMind-MCP mémoire - Gestion mémoire vectorielle"
-    },
-    "overmind-postgres": {
-      "command": "overmind-postgres-mcp",
-      "description": "OverMind-PostgreSQL-MCP - Serveur PostgreSQL vectoriel optimisé pour OverMind"
-    }
-  },
-  "description": "Configuration MCP OverMind-MCP optimisée pour installation globale npm",
-  "version": "2.2.6",
-  "installation": "npm install -g overmind-mcp",
-  "note": "Après installation globale, les commandes 'overmind' et 'overmind-postgres-mcp' sont disponibles directement dans le système. Cette configuration utilise les binaires globaux installés par npm."
-}
-```
-
-**📖 Exemples de configuration détaillée** : Voir `config/README.md` pour plus de scénarios d'utilisation.
+- `src/services/` : Le cœur du système (Logique métier isolée en services).
+- `src/tools/` : Les outils MCP qui appellent les services.
+- `src/bin/cli.ts` : Le point d'entrée exécutable pour le terminal.
+- `src/server.ts` : La définition du serveur FastMCP.
+- `src/index.ts` : Les exports publics (API de la bibliothèque).
+- `.claude/` : Stockage des agents (Prompts `.md` et Settings `.json`).
 
 ---