Spec Workflow MCP

Un serveur Model Context Protocol (MCP) pour le développement structuré basé sur les spécifications avec tableau de bord en temps réel et extension VSCode.

☕ Soutenez ce projet

📺 Démonstration

🔄 Système d'approbation en action

Découvrez comment fonctionne le système d'approbation : créez des documents, demandez l'approbation via le tableau de bord, fournissez des commentaires et suivez les révisions.

📊 Tableau de bord et gestion des spécifications

Explorez le tableau de bord en temps réel : visualisez les spécifications, suivez la progression, naviguez dans les documents et surveillez votre flux de développement.

✨ Fonctionnalités principales

• Flux de développement structuré - Création séquentielle de spécifications (Exigences → Conception → Tâches)
• Tableau de bord web en temps réel - Surveillez les spécifications, les tâches et la progression avec des mises à jour en direct
• Extension VSCode - Tableau de bord intégré dans la barre latérale pour les utilisateurs de VSCode
• Flux d'approbation - Processus d'approbation complet avec révisions
• Suivi de la progression des tâches - Barres de progression visuelles et statut détaillé
• Journaux d'implémentation - Journaux consultables de toutes les implémentations de tâches avec statistiques de code
• Support multilingue - Disponible en 11 langues

🌍 Langues prises en charge

🇺🇸 English • 🇯🇵 日本語 • 🇨🇳 中文 • 🇪🇸 Español • 🇧🇷 Português • 🇩🇪 Deutsch • 🇫🇷 Français • 🇷🇺 Русский • 🇮🇹 Italiano • 🇰🇷 한국어 • 🇸🇦 العربية

🚀 Démarrage rapide

Étape 1 : Ajoutez à votre outil IA

Ajoutez à votre configuration MCP (voir la configuration spécifique au client ci-dessous) :

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

Étape 2 : Choisissez votre interface

Option A : Tableau de bord web (Requis pour les utilisateurs CLI) Démarrez le tableau de bord (s'exécute sur le port 5000 par défaut) :

npx -y @pimzino/spec-workflow-mcp@latest --dashboard

Le tableau de bord sera accessible à : http://localhost:5000

Remarque : Une seule instance du tableau de bord est nécessaire. Tous vos projets se connecteront au même tableau de bord.

Option B : Extension VSCode (Recommandée pour les utilisateurs de VSCode)

Installez l'Extension Spec Workflow MCP depuis le marketplace VSCode.

📝 Comment utiliser

Mentionnez simplement spec-workflow dans votre conversation :

• "Créer une spécification pour l'authentification utilisateur" - Crée un flux de spécification complet
• "Lister mes spécifications" - Affiche toutes les spécifications et leur statut
• "Exécuter la tâche 1.2 dans la spécification user-auth" - Exécute une tâche spécifique

Voir plus d'exemples →

🔧 Configuration du client MCP

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

claude mcp add spec-workflow npx @pimzino/spec-workflow-mcp@latest -- /chemin/vers/votre/projet

claude mcp add spec-workflow cmd.exe /c "npx @pimzino/spec-workflow-mcp@latest /chemin/vers/votre/projet"

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "spec-workflow": {
      "type": "local",
      "command": ["npx", "-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"],
      "enabled": true
    }
  }
}

{
  "mcpServers": {
    "spec-workflow": {
      "command": "npx",
      "args": ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]
    }
  }
}

[mcp_servers.spec-workflow]
command = "npx"
args = ["-y", "@pimzino/spec-workflow-mcp@latest", "/chemin/vers/votre/projet"]

🐳 Déploiement Docker

Exécutez le tableau de bord dans un conteneur Docker pour un déploiement isolé :

# Utilisation de Docker Compose (recommandé)
cd containers
docker-compose up --build

# Ou utilisation de Docker CLI
docker build -f containers/Dockerfile -t spec-workflow-mcp .
docker run -p 5000:5000 -v "./workspace/.spec-workflow:/workspace/.spec-workflow:rw" spec-workflow-mcp

Le tableau de bord sera disponible à : http://localhost:5000

Voir le guide de configuration Docker →

🔒 Environnements isolés

Pour les environnements isolés (par exemple, Codex CLI avec sandbox_mode=workspace-write) où $HOME est en lecture seule, utilisez la variable d'environnement SPEC_WORKFLOW_HOME pour rediriger les fichiers d'état globaux vers un emplacement accessible en écriture :

SPEC_WORKFLOW_HOME=/workspace/.spec-workflow-mcp npx -y @pimzino/spec-workflow-mcp@latest /workspace

Voir le guide de configuration →

📚 Documentation

• Guide de configuration - Options de ligne de commande, fichiers de configuration
• Guide utilisateur - Exemples d'utilisation complets
• Processus de flux de travail - Flux de développement et bonnes pratiques
• Guide des interfaces - Détails du tableau de bord et de l'extension VSCode
• Guide de prompting - Exemples avancés de prompting
• Référence des outils - Documentation complète des outils
• Développement - Configuration de contribution et de développement
• Dépannage - Problèmes courants et solutions

📁 Structure du projet

votre-projet/
  .spec-workflow/
    approvals/
    archive/
    specs/
    steering/
    templates/
    user-templates/
    config.example.toml

🛠️ Développement

# Installer les dépendances
npm install

# Compiler le projet
npm run build

# Exécuter en mode développement
npm run dev

Voir le guide de développement →

📄 Licence

GPL-3.0

⭐ Historique des étoiles