Skip to content

Modelio-R-D/modelio-doc-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

ModelioDocSkill

Skills de génération de documents Modelio pour chatbots IA (Copilot, Claude)

ModelioDocSkill est un ensemble de skills (fichiers d'instructions .md) qui permettent à un chatbot IA de générer des documents Word (.docx) professionnels à partir d'un modèle Modelio, via le protocole MCP.


Principe

┌──────────────────┐                ┌──────────────────┐
│  Utilisateur      │    demande    │  Chatbot IA       │
│  "Génère le doc   │──────────────▶│  (Copilot/Claude) │
│   Requirements"   │               │                   │
└──────────────────┘               └────────┬──────────┘
                                            │
                               ┌────────────┼────────────┐
                               │            │            │
                               ▼            ▼            ▼
                        ┌──────────┐  ┌──────────┐  ┌──────────┐
                        │ Skill.md │  │ MCP      │  │ Template │
                        │(consignes│  │ Modelio  │  │ .docx    │
                        │ plan,    │  │ (données │  │ (styles) │
                        │ règles)  │  │ modèle)  │  │          │
                        └──────────┘  └──────────┘  └──────────┘
  1. L'utilisateur demande un document au chatbot
  2. Le chatbot lit le skill correspondant pour connaître la structure exacte à produire
  3. Le chatbot interroge le Modelio MCP Server pour extraire les données du modèle
  4. Le chatbot génère un script python-docx et l'exécute pour produire le .docx

Structure du projet

ModelioDocSkill/
├── skills/
│   └── modelio-doc/
│       ├── SKILL.md                       # Skill maître (dispatch + règles)
│       └── doc-types/
│           ├── requirements.md            # Cahier des exigences
│           ├── class-reference.md         # Référence des classes UML
│           ├── use-cases.md               # Cas d'utilisation
│           ├── analysis-and-design.md     # Analyse et conception
│           ├── goals.md                   # Objectifs
│           ├── risks.md                   # Risques
│           └── business-rules.md          # Règles métier
├── examples/                              # Templates .docx Modelio (source de styles)
├── output/                                # Documents générés
└── _archive/                              # Ancien code Python (référence)

Types de documents supportés

Type Description Données MCP
Requirements Cahier des exigences modelio://analyst/requirements/catalog
ClassReference Référence des classes UML modelio://uml/elements/catalog + tools
UseCases Cas d'utilisation modelio://uml/elements/catalog (Actor, UseCase)
AnalysisAndDesign Analyse et conception modelio://uml/packages/catalog + tools
Goals Objectifs modelio://analyst/goals/catalog
Risks Risques modelio://analyst/risks/catalog
BusinessRules Règles métier modelio://analyst/businessrules/catalog

Prérequis

  1. Modelio lancé avec le module MCP Server actif sur http://localhost:8080/sse
  2. python-docx installé : pip install python-docx
  3. Chatbot avec accès MCP : Copilot (VS Code), Claude Desktop, ou Claude Code

Configuration

VS Code (Copilot)

Fichier .vscode/mcp.json à la racine du workspace :

{
  "servers": {
    "modelio": {
      "type": "sse",
      "url": "http://localhost:8080/sse",
      "description": "Modelio MCP Server"
    }
  }
}

Claude Desktop

Fichier %APPDATA%\Claude\claude_desktop_config.json :

{
  "mcpServers": {
    "modelio": {
      "command": "npx",
      "args": ["mcp-remote", "http://localhost:8080/sse"]
    }
  }
}

Claude Code

claude mcp add modelio --transport sse http://localhost:8080/sse

Utilisation

Dans le chat du chatbot, demandez simplement :

  • "Génère le document Requirements de mon modèle Modelio"
  • "Produis la référence des classes UML"
  • "Crée le document des cas d'utilisation"
  • "Génère le document des risques"

Le chatbot :

  1. Lit les consignes du skill correspondant
  2. Appelle les resources/tools MCP pour extraire les données
  3. Génère et exécute un script python-docx
  4. Produit le .docx dans output/

Personnalisation

Les skills sont des fichiers texte éditables. L'utilisateur peut :

Ce que vous pouvez changer Fichier à modifier
Ajouter/supprimer des sections skills/modelio-doc/doc-types/{type}.md
Changer les colonnes d'un tableau skills/modelio-doc/doc-types/{type}.md
Modifier les styles/couleurs skills/modelio-doc/SKILL.md
Utiliser un autre template Word Remplacer le .docx dans examples/
Ajouter un nouveau type de document Créer un fichier dans doc-types/ + l'ajouter au tableau dans SKILL.md

Reste A Faire (Plan-Types)

Le tableau ci-dessous recapitule les plan-types restants, leur statut, et la raison quand ils ne sont pas faisables aujourd'hui.

Plan-Type Etat Faisabilite actuelle Raison principale
Requirements Implemente Oui Catalog Analyst disponible
ClassReference Implemente Oui Catalog UML + tools classes disponibles
UseCases Partiel Oui (partiel) Certaines donnees UC manquent dans MCP
AnalysisAndDesign Partiel Oui (partiel) Export diagrammes et state machines indisponibles
Goals Partiel Oui (partiel) Catalog limite a name + definition
Risks Partiel Oui (partiel) Catalog limite a name + definition
BusinessRules Partiel Oui (partiel) Catalog limite a name + definition
DiagramNotebook Non faisable Non Pas d'export image/diagramme cote MCP
BPMN Non faisable Non Aucune resource/tool BPMN exposee
SimpleDictionary A faire A evaluer Mapping MCP non finalise
ArchiMateViewPoint A faire A evaluer Resources/outils ArchiMate non valides
Book A faire A evaluer Agregation multi-documents a definir
TraceabilityMatrix A faire A evaluer Links de tracabilite incomplets/non exposes

Lacunes Actuelles Du Modelio MCP Server

Le tableau ci-dessous liste les ecarts qui empechent une generation 100% conforme sur certains types.

Plan-Type Donnee manquante Impact
UseCases Pre-conditions / Post-conditions Champs vides dans le document
UseCases Description complete et scenarios detailles Sections partiellement remplies
UseCases Export de diagramme de cas d'utilisation Placeholder textuel au lieu d'image
AnalysisAndDesign Export de diagrammes classes/packages Images non generees
AnalysisAndDesign State machines Section absente
AnalysisAndDesign Distinction elements importes vs locaux Section incomplete
ClassReference Description des attributs/operations Colonne Description vide
ClassReference Export diagramme detaille de classe Figure absente
ClassReference Cycle de vie (state machine) Section absente
ClassReference Chemin de package multi-niveaux fiable Sous-titre simplifie
Requirements Proprietes Analyst (origin, benefit, cost, risk, stability, target release) Colonnes souvent vides/par defaut
Requirements Typage des liens (satisfy/verify/refine) Relations non typees finement
Goals Proprietes metier (Scope, IsCorporate, Kind, etc.) 10 colonnes sur 12 vides
Goals Relations d'objectifs (fait partie de, garanti par, etc.) Relations non affichees
Goals Export diagramme d'objectifs Image absente
Risks Proprietes metier (Impact, Probability, Impact Level, etc.) 5 colonnes sur 6 vides
BusinessRules Proprietes metier (Identifier, Example, Exception, Source, Rationale) 5 colonnes sur 7 vides
DiagramNotebook Export de toutes les images de diagrammes Non faisable sans export image
BPMN Toutes les donnees BPMN (processus, taches, passerelles, evenements, roles) Non faisable

Priorites Proposees Cote MCP

  1. Ajouter un tool d'export de diagramme (PNG/SVG)
  2. Enrichir les catalogs Analyst (requirements, goals, risks, businessrules) avec les proprietes metier
  3. Exposer les scenarios/pre/post-conditions des UseCases
  4. Exposer les state machines
  5. Exposer les liens de tracabilite avec leur type (satisfy/verify/refine/derive)

Licence

Projet interne Softeam / Modelio.

About

A Claude Code skill (modelio-doc) that automates the generation of structured Word documents from Modelio models using the MCP protocol. Supports requirements, class references, use cases, analysis & design, goals, risks, and business rules documents — with Modelio's exact visual styles (fonts, colors, table headers).

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors