התקנה

השרת מפורסם ב-npm בשם @dineug/erd-editor-mcp. זהו קובץ יחיד ועצמאי ללא תלויות זמן ריצה, ו-npx מוריד אותו בפעם הראשונה שהסוכן מפעיל אותו, כך שאין צורך להתקין דבר נוסף. הוא דורש Node.js בגרסה 22.12 ומעלה.

כדי שהסוכן יוכל לערוך תרשים בזמן אמת, יש להגדיר גם את העורך שמחזיק אותו: VS Code, Obsidian או IDE של JetBrains. כשאין עורך שמשרת את המסמך, הסוכן עורך את הקובץ בדיסק – ראו מצב חי ומצב ללא ממשק.

Claude Code

יש להריץ בתיקיית הפרויקט:

claude mcp add --transport stdio erd-editor -- npx -y @dineug/erd-editor-mcp

הוספת --scope project לפני --transport כותבת את השרת במקום זאת ל-.mcp.json של הפרויקט, שם כל מי שמשכפל את הפרויקט מקבל אותו.

Codex

יש להריץ פעם אחת. ה-CLI, האפליקציה והרחבת ה-IDE של Codex חולקים את ההגדרה:

codex mcp add erd-editor -- npx -y @dineug/erd-editor-mcp

לחלופין, ניתן להוסיף את השרת ל-~/.codex/config.toml, או ל-.codex/config.toml בפרויקט מהימן:

[mcp_servers.erd-editor]
command = "npx"
args = ["-y", "@dineug/erd-editor-mcp"]

כל לקוח MCP אחר

יש להריץ את npx -y @dineug/erd-editor-mcp כשרת stdio: הפקודה היא npx, והארגומנטים הם -y ו-@dineug/erd-editor-mcp.

השרת מפרש נתיב יחסי של מסמך לפי תיקיית העבודה שלו, ולכן יש להפעיל אותו בתיקיית הפרויקט. הוא מדבר בגרסאות 2025-06-18, 2025-03-26 ו-2024-11-05 של פרוטוקול MCP, ועונה ב-2025-06-18 ללקוח שמשתמש בגרסה מאוחרת יותר.

הגדרת VS Code

חלון של VS Code משרת את התרשימים שבתיקיות סביבת העבודה שלו ואת כל תרשים שפתוח בו.

1. יש להתקין את הרחבת ERD Editor בגרסה 4.0.0 ומעלה. היא דורשת VS Code בגרסה 1.101.0 ומעלה.
2. יש לפתוח את תיקיית הפרויקט ולתת אמון בסביבת העבודה. ההרחבה משרתת סוכנים רק בסביבת עבודה מהימנה.
3. יש להשאיר את ההגדרה dineug.erd-editor.agentHub.enabled מופעלת. היא מופעלת כברירת מחדל.

הרחבה מגרסה 3.0.0 ועד גרסה 3.1.0 והשרת בגרסה 1.0.0 דוחים זה את זה, והרחבה בגרסה שקודמת ל-3.0.0 אינה משרתת סוכנים – ראו עדכון.

ההרחבה מופעלת בסביבת עבודה שמכילה קובצי .erd, .erd.json, .vuerd או .vuerd.json, כך שסוכן מגיע לתרשימים האלה עוד לפני שפותחים אחד מהם. בסביבת עבודה שאין בה אף אחד מהם, היא מופעלת כשפותחים תרשים, ועד אז הסוכן עורך בדיסק.

הגדרה	ברירת מחדל	השפעה
dineug.erd-editor.agentHub.enabled	true	מאפשרת לשרת ה-MCP של סוכן לערוך את המסמכים של החלון הזה דרך שקע מקומי, או דרך צינור בעל שם ב-Windows. כשהיא כבויה, או בסביבת עבודה לא מהימנה, סוכנים עדיין יכולים לקרוא את התרשימים של החלון מהדיסק, אבל לעולם אינם כותבים תרשים בלי ידיעת העורך שלו.

הגדרת Obsidian

חלון של כספת Obsidian משרת את התרשימים שבכספת שלו.

1. יש להתקין את תוסף ERD Editor בגרסה 1.0.0 ומעלה מ-Community plugins, ולהפעיל אותו. הוא פועל באפליקציה למחשב שולחני בלבד, ודורש Obsidian בגרסה 1.5.7 ומעלה.
2. יש להשאיר את ההגדרה Settings → ERD Editor → Coding agents מופעלת. היא מופעלת כברירת מחדל, וכל כספת שומרת הגדרה משלה.

תוסף בגרסה קודמת והשרת בגרסה 1.0.0 דוחים זה את זה – ראו עדכון.

חלון של כספת משרת סוכנים מרגע שהתוסף נטען, כך שסוכן מגיע לתרשימים של הכספת עוד לפני שפותחים אחד מהם. אין שלב של מתן אמון. קובץ שהכספת אינה מציגה ברשימה, כגון קובץ בתיקייה ששמה מתחיל בנקודה, אינו ניתן לפתיחה ב-ERD Editor, ולכן עריכה שלו נדחית.

יש לבקש מהסוכן לתת לתרשימים חדשים שמות עם הסיומת .erd. שם ללא סיומת מקבל .erd.json, וסייר הקבצים של Obsidian מציג קובץ .erd.json רק כל עוד ההגדרה Settings → Files and links → Detect all file extensions מופעלת.

הגדרה	ברירת מחדל	השפעה
Coding agents	מופעל	מאפשרת לשרת ה-MCP של סוכן לערוך את התרשימים של הכספת הזו דרך שקע מקומי, או דרך צינור בעל שם ב-Windows. כשהיא כבויה, סוכנים עדיין יכולים לקרוא את התרשימים של הכספת מהדיסק, אבל לעולם אינם כותבים תרשים בלי ידיעת העורך שלו.

Obsidian שהותקן מ-Flathub פועל בארגז חול של Flatpak, שהשרת אינו יכול להגיע אליו. שם התוסף אינו משרת סוכנים ואינו מחזיק קובץ נעילה, ולכן הסוכן עורך את הקבצים בדיסק, אפילו תרשים שפתוח כרגע. Obsidian טוען מחדש את התרשים, כפי שהוא עושה אחרי כל שינוי שנעשה מחוצה לו, ועריכה של המשתמש שהוא עדיין לא שמר מפנה את מקומה לעריכה של הסוכן. התוסף מציין זאת בכל פעם שהכספת נפתחת, עד שמכבים את ההגדרה Coding agents.

הגדרת IDE של JetBrains

IDE של JetBrains משרת את התרשימים של כל פרויקט שפתוח בו, ואת כל תרשים שפתוח ב-ERD Editor שלו.

1. יש להתקין את תוסף ERD Editor בגרסה 1.0.0 ומעלה. הוא דורש IDE מבוסס IntelliJ בגרסה 2025.2 ומעלה, שרץ על JetBrains Runtime.
2. יש לפתוח את הפרויקט ולתת בו אמון. בפרויקט שה-IDE אינו נותן בו אמון, כגון פרויקט שנפתח במצב בטוח, סוכנים קוראים את התרשימים אבל לעולם אינם משנים אותם.
3. יש להשאיר את ההגדרה Settings | Tools | ERD Editor → Coding agents מסומנת. היא מופעלת כברירת מחדל וחלה על ה-IDE כולו.

תוסף בגרסה 0.9.0 או 0.10.0 והשרת בגרסה 1.0.0 דוחים זה את זה, ותוסף בגרסה שקודמת ל-0.9.0 אינו משרת סוכנים – ראו עדכון.

ה-IDE משרת סוכנים מרגע שהפרויקט הראשון נפתח, כך שסוכן מגיע לתרשימים של פרויקט עוד לפני שפותחים אחד מהם.

הגדרה	ברירת מחדל	השפעה
Coding agents	מופעל	מאפשרת לשרת ה-MCP של סוכן לערוך את התרשימים של ה-IDE הזה דרך שקע מקומי, או דרך צינור בעל שם ב-Windows. כשהיא כבויה, סוכנים עדיין יכולים לקרוא את התרשימים של הפרויקטים הפתוחים מהדיסק, אבל לעולם אינם משנים תרשים בלי ידיעת העורך שלו.

דף ההגדרות מציין מתי סוכני קוד אינם זמינים: ב-IDE ללא JCEF (שבו גם ERD Editor אינו יכול לפעול), ב-IDE שהותקן כ-Flatpak ב-Linux, וכשלא ניתן היה להפעיל את ה-hub שלו. במקרים האלה ה-IDE אינו מחזיק קובץ נעילה, והסוכן עורך את הקבצים בדיסק. ERD Editor אינו טוען מחדש תרשים שהשתנה בדיסק בזמן שהוא פתוח, והעריכה הבאה של המשתמש בו כותבת את התרשים כולו בחזרה על גבי השינויים של הסוכן, ולכן יש לסגור קודם את התרשים.

ניסיון ראשון

1. יש לפתוח את התיקייה שמכילה את התרשימים: ב-VS Code, כסביבת עבודה מהימנה; ב-Obsidian, ככספת; ב-IDE של JetBrains, כפרויקט מהימן.
2. יש להפעיל את הסוכן באותה תיקייה ולבקש במילים רגילות, לדוגמה "להוסיף ל-schema.erd.json טבלת reviews, עם קשרים ל-users ול-products".
3. ניתן לראות את השינוי כשהוא מופיע בבד הציור. ב-VS Code, יש לשמור באמצעות Ctrl + S (Windows/Linux) או ⌘ + S (Mac), או לבקש מהסוכן לשמור. Obsidian ו-IDE של JetBrains שומרים את השינוי כפי שהם שומרים את העריכות של המשתמש, ובקשה מהסוכן לשמור כותבת אותו מיד.

תרשים שעדיין אינו פתוח נפתח ב-ERD Editor בעריכה הראשונה של הסוכן, בלי לקחת את הפוקוס של המקלדת. הסוכן יוצר מסמך חדש באמצעות erd_open_document, ושם ללא סיומת מקבל .erd.json.

עדכון

הפקודות שלמעלה אינן מציינות גרסה, ולכן npx בודק ב-npm אם יש גרסה חדשה יותר של השרת בכל פעם שהסוכן מפעיל אותו. שרת שכבר פועל נשאר בגרסה שלו עד שהסוכן מפעיל אותו שוב.

השרת בודק באיזו גרסת פרוטוקול העורך מדבר לפני שהוא מתחבר. כשהגרסאות שונות, כל קריאה שמגיעה לעורך הזה נדחית עם protocolMismatch, כולל כלי הקריאה ו-erd_list_documents, ושום דבר אינו נכתב. ההודעה מציינת את הצד שיש לעדכן: השרת, או ERD Editor בעורך, כלומר ההרחבה ב-VS Code והתוסף ב-Obsidian וב-IDE של JetBrains.

השרת בגרסה 1.0.0, הרחבת VS Code בגרסה 4.0.0 ומעלה, התוסף ל-Obsidian בגרסה 1.0.0 ומעלה והתוסף ל-JetBrains בגרסה 1.0.0 ומעלה מדברים בפרוטוקול 2. כל שרת בגרסה קודמת מדבר בפרוטוקול 1, וכך גם כל גרסה קודמת של עורך שמשרתת סוכנים: הרחבת VS Code מגרסה 3.0.0 ועד גרסה 3.1.0, התוסף ל-Obsidian בגרסאות 0.1.0 ו-0.2.0, והתוסף ל-JetBrains בגרסאות 0.9.0 ו-0.10.0. עורך כזה והשרת בגרסה 1.0.0 דוחים זה את זה, וכך גם שרת בגרסה קודמת ועורך שמדבר בפרוטוקול 2. הרחבת VS Code בגרסה שקודמת ל-3.0.0 או תוסף ל-JetBrains בגרסה שקודמת ל-0.9.0 אינם משרתים סוכנים כלל, ולכן הסוכן עורך את הקבצים בדיסק, אפילו תרשים שפתוח בעורך.

שילוב	סוף ההודעה
השרת בגרסה 1.0.0 עם הרחבה או תוסף שמדברים בפרוטוקול 1	Update the ERD Editor extension or plugin in the editor until its hub speaks protocol 2.
שרת בגרסה קודמת עם הרחבה או תוסף שמדברים בפרוטוקול 2	Update the MCP server (npx -y @dineug/erd-editor-mcp@latest) until it speaks protocol 2.

יש לעדכן את השרת ואת ההרחבה או התוסף יחד. יש לעדכן גם את ERD Editor בכל מקום שבו התרשימים נפתחים. הרחבת VS Code בגרסה שקודמת ל-4.0.0, התוסף ל-Obsidian בגרסה שקודמת ל-1.0.0 והתוסף ל-JetBrains בגרסה שקודמת ל-1.0.0 מציגים תרשים שגרסה מאוחרת יותר שמרה, או שהסוכן ערך בדיסק, בלי סמלי המפתח הראשי שלו. כשהם שומרים את הקובץ, הם משמיטים ממנו את קבוצות הטבלאות ואת הסקריפטים של סכמת SQL. הרחבת VS Code בגרסה שקודמת ל-3.1.0, התוסף ל-Obsidian בגרסה שקודמת ל-0.2.0 והתוסף ל-JetBrains בגרסה שקודמת ל-0.10.0 משמיטים גם את פעולות ה-ON DELETE וה-ON UPDATE של תרשים כשהם שומרים את הקובץ. ב-Obsidian, יש להפעיל מחדש את האפליקציה אחרי עדכון התוסף: עד אז, חלון של כספת ממשיך להריץ את ERD Editor של גרסת התוסף שהוא טען ראשונה.