sad-mcp 1.1.7 → 1.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sad-mcp",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "MCP server for Software Analysis and Design course materials at BGU",
   "type": "module",
   "bin": {

package/skills/uml-use-case-diagram/SKILL.md

@@ -87,11 +87,29 @@ The shared files prepended to this prompt define the layout recipes, model shape
 
 ---
 
-## 4. Include and Extend — Mandatory Justification Gate
+## 4. Relationship Gates — Mandatory Justifications
 
-**Default to zero.** Treat every «include» and «extend» as guilty until proven innocent. Before drawing ANY such relationship, write the relevant block below in your planning text. **If you cannot fill it in truthfully, the relationship does not exist — do not draw it.**
+Every relationship in the diagram — actor-UC associations, «include», and «extend» — must pass a written justification block BEFORE it is drawn. **If you cannot fill the block in truthfully, the relationship does not exist.** Write these blocks in your planning text (not in the final HTML).
 
-### «include» justification block
+### 4.1 Association justification (actor ↔ UC)
+
+```
+Association: [actor id] ↔ [UC id]
+  Actor role:            initiator / participant / recipient / supplier
+  Does this actor TRIGGER / INITIATE the UC?   yes / no
+  One-line justification: "The actor ___ in order to ___"
+  Description shown on click (Hebrew): ___________________
+
+  → If the actor has no meaningful interaction with the UC → DELETE the association.
+  → Every UC MUST have ≥1 association where "initiates = yes". A UC with no initiator is orphaned — fix it or delete the UC.
+  → A human actor connected only as "recipient" of a notification is usually wrong — the initiator of the notification-sending UC is who you want (see CRITICAL RULE #10, no send-only UCs).
+```
+
+The "Description shown on click" is the text surfaced in the HTML by the `showAssocDesc` popup — see §8. Store it on the connection object under `description`.
+
+### 4.2 «include» justification
+
+**Default to zero.** Treat every «include» as guilty until proven innocent.
 
 ```
 «include» candidate: __________________________________
@@ -109,7 +127,7 @@ Semantics: «include» means the target runs **every single time** the base runs
 
 Arrow: dashed, open arrowhead, `Base UC → Included UC`.
 
-### «extend» justification block
+### 4.3 «extend» justification
 
 ```
 «extend» candidate: __________________________________
@@ -414,9 +432,9 @@ If neither trigger fires, produce a single tab. Do not split on gut feeling.
 
 ---
 
-## 8. Clickable Descriptions for UCs and Actors (Always Include)
+## 8. Clickable Descriptions for UCs, Actors, and Associations (Always Include)
 
-Every UC ellipse **and** every actor must be clickable — click shows a floating panel with name + description. One `showDesc(id, type, event)` function handles both.
+Every UC ellipse, every actor, **and every association line** must be clickable — click shows a floating panel with name + description. One `showDesc(id, type, event)` function handles all three.
 
 ```javascript
 const useCaseDescriptions = {
@@ -427,10 +445,18 @@ const actorDescriptions = {
   'customer': { name: 'לקוח', desc: 'לקוח הרשום במערכת. יוזם הזמנות ועוקב אחר סטטוס.' },
   // ... one entry per actor
 };
+const assocDescriptions = {
+  // keyed by connection id; name = actor-name ↔ UC-name (auto-composed is fine)
+  'a1': { name: 'לקוח ↔ פתיחת הזמנה', desc: 'הלקוח יוזם את פתיחת ההזמנה. תפקיד: Initiator.' },
+  // ... one entry per association line you want described
+};
 
 function showDesc(id, type, event) {
   hideDesc();
-  const data = type === 'uc' ? useCaseDescriptions[id] : actorDescriptions[id];
+  const data = type === 'uc'    ? useCaseDescriptions[id]
+             : type === 'actor' ? actorDescriptions[id]
+             : type === 'assoc' ? assocDescriptions[id]
+             : null;
   if (!data) return;
   const panel = document.createElement('div');
   panel.id = 'desc-panel';
@@ -454,13 +480,50 @@ function showDesc(id, type, event) {
 }
 function hideDesc() { document.getElementById('desc-panel')?.remove(); }
 document.addEventListener('click', e => {
-  if (!e.target.closest('[data-uc-id]') && !e.target.closest('[data-actor-id]')) hideDesc();
+  if (!e.target.closest('[data-uc-id]') &&
+      !e.target.closest('[data-actor-id]') &&
+      !e.target.closest('[data-conn-id]')) hideDesc();
 });
 ```
 
 UC group: `<g id="uc-uc1" data-uc-id="uc1" onclick="showDesc('uc1','uc',event)" style="cursor:pointer">`
 Actor group: `<g id="actor-student" data-actor-id="student" onclick="showDesc('student','actor',event)" style="cursor:pointer">`
 
+### Clickable association lines (required)
+
+A 1.8px line is nearly impossible to click. Every associatable line gets **two** line elements: a visible thin line (the one `fixLayout` already updates via `data-conn-from` / `data-conn-to`) and a transparent thick hitbox on top.
+
+```html
+<!-- Visible line — fixLayout writes x1/y1/x2/y2 here -->
+<line data-conn-from="worker" data-conn-to="uc-receive"
+      x1="0" y1="0" x2="0" y2="0"
+      stroke="#334155" stroke-width="1.8"/>
+
+<!-- Click hitbox — invisible, tracks the same endpoints, carries the id -->
+<line class="conn-hitbox" data-conn-id="a1"
+      data-hitbox-from="worker" data-hitbox-to="uc-receive"
+      x1="0" y1="0" x2="0" y2="0"
+      stroke="transparent" stroke-width="14"
+      style="cursor:pointer"
+      onclick="showDesc('a1','assoc',event)"/>
+```
+
+Inside `fixLayout` Step 8, copy the endpoints from each visible line to its matching hitbox so the clickable region tracks the visible line exactly:
+
+```javascript
+// After writing x1/y1/x2/y2 on the visible line:
+const hitbox = svg.querySelector(
+  `.conn-hitbox[data-hitbox-from="${fId}"][data-hitbox-to="${tId}"]`);
+if (hitbox) {
+  hitbox.setAttribute('x1', x1); hitbox.setAttribute('y1', y1);
+  hitbox.setAttribute('x2', x2); hitbox.setAttribute('y2', y2);
+}
+```
+
+Draw order: visible line first, hitbox second, ellipses/actors last. The hitbox stays under the ellipses and actors but above the thin visible line so clicks on or near the line hit it.
+
+Associations without a meaningful description (e.g., auto-generated from trivially obvious actor-UC pairs) may omit the hitbox and the `assocDescriptions` entry, but they still need to pass the §4.1 justification gate.
+
 ### Timing labels on cron/time-actor associations (required)
 
 When a connection carries a `timing` field (every connection from a system-time actor MUST have one — see §2), inject the label at the line midpoint **after** `fixLayout` has written the endpoints. The helper below is idempotent: it removes any existing `.timing-label` group before re-rendering, so calling it again after another `fixLayout` pass is safe.
@@ -514,6 +577,21 @@ The `connections` entry for a timed link looks like:
 
 Define this variable in every generated HTML `<script>` block, following the `model-shape.md` spec for `kind: 'use-case'`. Every actor, use case, and relationship must be represented. The Visual Paradigm exporter walks this variable.
 
+### Assumptions and open questions
+
+Both `diagramModel` and `diagramLayout` carry two parallel string arrays, matching the BPMN skill's shape:
+
+```javascript
+{
+  // ...
+  assumptions:   [ 'המערכת מזהה כל עובד מחסן דרך מזהה משתמש יחיד.',
+                   'ייבוא נתונים מה-ERP של הספק מתבצע באמצעות API ולא קובץ.' ],
+  openQuestions: [ 'האם נדרש אישור נוסף על ידי מנהל לכל שינוי רמות מלאי?' ]
+}
+```
+
+Render them in a panel at the bottom of the page — see §11. Only render if at least one of the arrays is non-empty. Do NOT hide the panel; a reader reviewing the diagram needs to see which statements in the diagram rest on assumptions.
+
 ---
 
 ## 10. Styling
@@ -529,9 +607,25 @@ Association line:   #334155, 1.8px, no arrowhead
 Include/extend:     #7c3aed, 1.6px, dasharray 6 4, open arrowhead, label 9.5px
 Generalization:     #334155, 1.8px, hollow triangle (fill white)
 System title:       white on #1e40af, 14px bold
+Assumptions panel:  white bg, border #cbd5e1 (1px), rx=8, padding 16px, margin-top 20px
+Assumptions h3:     #1e40af, 13px, weight 600, margin-bottom 6px
+Assumptions li:     #334155, 12px, line-height 1.6, list-style disc inside
 Fonts:              'Noto Sans Hebrew' + 'IBM Plex Mono' from Google Fonts
 ```
 
+The assumptions panel CSS must be included in the HTML `<style>` block:
+
+```css
+.assumptions-panel { display: flex; gap: 24px; max-width: 1000px;
+  margin: 20px auto; padding: 16px 20px; background: #fff;
+  border: 1px solid #cbd5e1; border-radius: 8px; direction: rtl; }
+.assumptions-col { flex: 1; min-width: 0; }
+.assumptions-col h3 { margin: 0 0 6px; font-size: 13px; font-weight: 600;
+  color: #1e40af; }
+.assumptions-col ul { margin: 0; padding-right: 18px; }
+.assumptions-col li { color: #334155; font-size: 12px; line-height: 1.6; }
+```
+
 ---
 
 ## 11. HTML File Structure
@@ -571,6 +665,18 @@ Fonts:              'Noto Sans Hebrew' + 'IBM Plex Mono' from Google Fonts
     <svg id="diagram-svg-1" viewBox="0 0 1100 900" xmlns="http://www.w3.org/2000/svg">...</svg>
   </div>
 
+  <!-- Assumptions / open-questions panel (render only if at least one non-empty) -->
+  <div id="assumptions-panel" class="assumptions-panel" hidden>
+    <div class="assumptions-col" id="assumptions-col">
+      <h3>הנחות</h3>
+      <ul id="assumptions-list"></ul>
+    </div>
+    <div class="assumptions-col" id="open-questions-col">
+      <h3>שאלות פתוחות</h3>
+      <ul id="open-questions-list"></ul>
+    </div>
+  </div>
+
   <!-- VP export button -->
   <button class="vp-export-btn" onclick="exportXMI()">Download .xmi (Visual Paradigm)</button>
 
@@ -595,8 +701,31 @@ Fonts:              'Noto Sans Hebrew' + 'IBM Plex Mono' from Google Fonts
     function xmiBody(elements, rels) { /* export-buttons.md */ }
     function exportXMI() { /* export-buttons.md */ }
 
+    function renderAssumptions() {
+      const a = (diagramModel && diagramModel.assumptions)   || [];
+      const q = (diagramModel && diagramModel.openQuestions) || [];
+      const panel = document.getElementById('assumptions-panel');
+      if (!panel) return;
+      if (!a.length && !q.length) { panel.hidden = true; return; }
+      panel.hidden = false;
+      const ul = id => document.getElementById(id);
+      const fill = (listEl, items) => {
+        listEl.innerHTML = '';
+        items.forEach(s => {
+          const li = document.createElement('li');
+          li.textContent = s;
+          listEl.appendChild(li);
+        });
+      };
+      fill(ul('assumptions-list'),    a);
+      fill(ul('open-questions-list'), q);
+      document.getElementById('assumptions-col').hidden    = !a.length;
+      document.getElementById('open-questions-col').hidden = !q.length;
+    }
+
     document.addEventListener('DOMContentLoaded', () => {
       diagramLayouts.forEach(l => fixLayout(l));
+      renderAssumptions();
     });
   </script>
 </body>
@@ -616,6 +745,9 @@ Fonts:              'Noto Sans Hebrew' + 'IBM Plex Mono' from Google Fonts
 
 ## 13. Pre-Delivery Checklist
 
+- [ ] Every actor-UC association has a written §4.1 justification block (role, initiates? one-line "why"); every UC has ≥1 association with `initiates = yes`.
+- [ ] Every association line carries a transparent click-hitbox (stroke-width ≥12, `data-conn-id`) wired to `showDesc(id,'assoc',event)`; `assocDescriptions` entry exists for each id.
+- [ ] `assumptions` and `openQuestions` arrays are present in `diagramModel`; the HTML renders the bottom panel whenever either is non-empty.
 - [ ] Every «include» and «extend» has a written §4 justification block; any that cannot be filled in has been deleted.
 - [ ] No «include» with exactly one incoming arrow — every include target has ≥2 bases AND zero actor associations.
 - [ ] No generic "ניהול הגדרות מערכת" or combined-entity UCs; each entity has its own UC.