project-state-manager 1.0.1

package/README.md

@@ -0,0 +1,51 @@
+# Project State Manager (PSM)
+
+Project State Manager est un serveur **Model Context Protocol (MCP)** couplé à une **GUI de supervision** conçue pour sécuriser et structurer le travail des agents IA (comme Cursor ou Windsurf) sur des fonctionnalités complexes.
+
+## 🚀 Installation & Utilisation Rapide
+
+Vous pouvez lancer PSM directement sans installation globale via `npx` :
+
+```bash
+npx project-state-manager
+```
+
+Une fois lancé, PSM :
+1. Démarre un serveur MCP sur `stdio`.
+2. Lance automatiquement une interface graphique de supervision.
+3. Se synchronise avec vos fichiers YAML locaux dans le dossier `.psm/`.
+
+## 🛠️ Configuration
+
+PSM utilise des variables d'environnement que vous pouvez définir dans un fichier `.env` à la racine de votre projet ou passer directement à la commande.
+
+| Variable | Description | Défaut |
+|----------|-------------|---------|
+| `FIXED_GUI_PORT` | Port utilisé pour l'interface graphique en mode local | `4000` |
+| `PROXY_URL` | URL du Dynamic Proxy pour l'exposition de la GUI | `undefined` |
+
+Exemple avec variables :
+```bash
+FIXED_GUI_PORT=5000 npx project-state-manager
+```
+
+## 📋 Fonctionnement
+
+L'agent IA interagit avec PSM via les outils MCP fournis :
+- `discover_process` : Identifie le processus métier.
+- `define_process` : Crée une nouvelle cartographie.
+- `scan_node` : Guide l'analyse technique (Entrée, Flux, Sortie).
+- `submit_node_data` : Soumet les découvertes avec validation.
+- `check_readiness` : Vérifie si le signal `is_executable` est au vert.
+
+L'utilisateur peut superviser l'avancement sur le Dashboard et corriger manuellement le YAML si l'agent fait fausse route.
+
+## 🏗️ Structure du Projet
+
+- `.psm/` : Stockage des états de processus au format YAML.
+- `shared/` : Schémas Zod partagés pour une intégrité totale des données.
+- `gui/` : Interface de supervision React.
+- `src/` : Cœur du serveur MCP (Node.js).
+
+## 📄 Licence
+ISC