التثبيت
الخادم منشور على npm باسم @dineug/erd-editor-mcp.
وهو ملف واحد قائم بذاته بلا تبعيات في وقت التشغيل، ويُنزّله npx في المرة الأولى التي يشغّله فيها الوكيل، لذا لا يلزم تثبيت أي شيء آخر.
ويتطلب الإصدار 22.12 أو أحدث من Node.js.
ليحرر الوكيل مخططًا تحريرًا مباشرًا، أعدّ أيضًا المحرر الذي يحتفظ به: VS Code أو Obsidian أو بيئة تطوير JetBrains. حين لا يخدم أي محرر المستند، يحرر الوكيل الملف على القرص، راجع الوضع المباشر والوضع بدون واجهة.
Claude Code
شغّل ما يلي في مجلد مشروعك:
claude mcp add --transport stdio erd-editor -- npx -y @dineug/erd-editor-mcp
أضف --scope project قبل --transport لكتابة الخادم في الملف .mcp.json الخاص بالمشروع بدلًا من ذلك، حيث يحصل عليه كل من يستنسخ المشروع.
Codex
شغّل ما يلي مرة واحدة. تتشارك واجهة سطر أوامر 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.
يحلّ الخادم مسار المستند النسبي انطلاقًا من مجلد عمله، لذا شغّله في مجلد مشروعك.
ويدعم إصدارات بروتوكول MCP 2025-06-18 و2025-03-26 و2024-11-05، ويردّ على العميل الذي يستخدم إصدارًا أحدث بالإصدار 2025-06-18.
إعداد VS Code
تخدم نافذة VS Code المخططات الموجودة في مجلدات مساحة العمل الخاصة بها وأي مخطط مفتوح فيها.
- ثبّت إضافة ERD Editor بالإصدار
4.0.0أو أحدث. وهي تتطلب VS Code بالإصدار1.101.0أو أحدث. - افتح مجلد المشروع ثم ثق بمساحة العمل. لا تخدم الإضافة الوكلاء إلا في مساحة عمل موثوقة.
- اترك الإعداد
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 المخططات الموجودة في خزنتها.
- ثبّت من Community plugins المكوّن الإضافي ERD Editor بالإصدار
1.0.0أو أحدث، وفعّله. وهو يعمل في تطبيق سطح المكتب فقط، ويتطلب Obsidian بالإصدار1.5.7أو أحدث. - اترك 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.
إعداد بيئة تطوير JetBrains
تخدم بيئة تطوير JetBrains مخططات كل مشروع مفتوح فيها، وأي مخطط مفتوح في ERD Editor التابع لها.
- ثبّت المكوّن الإضافي ERD Editor بالإصدار
1.0.0أو أحدث. وهو يتطلب بيئة تطوير مبنية على IntelliJ بالإصدار2025.2أو أحدث، تعمل على JetBrains Runtime. - افتح المشروع ثم ثق به. في مشروع لا تثق به بيئة التطوير، مثل مشروع مفتوح في الوضع الآمن، يقرأ الوكلاء المخططات لكنهم لا يغيّرونها أبدًا.
- اترك Settings | Tools | ERD Editor → Coding agents محدّدًا. وهو مفعّل افتراضيًا وينطبق على بيئة التطوير كلها.
المكوّن الإضافي بالإصدار 0.9.0 أو 0.10.0 والخادم بالإصدار 1.0.0 يرفض كلٌّ منهما الآخر، والمكوّن الإضافي قبل الإصدار 0.9.0 لا يخدم أي وكيل، راجع التحديث.
تخدم بيئة التطوير الوكلاء منذ لحظة فتح أول مشروع، لذا يصل الوكيل إلى مخططات المشروع قبل أن تفتح أيًّا منها.
| الإعداد | القيمة الافتراضية | التأثير |
|---|---|---|
| Coding agents | مفعّل | يتيح لخادم MCP التابع للوكيل تحرير مخططات بيئة التطوير هذه عبر مقبس محلي، أو عبر أنبوب مسمّى على Windows. عند تعطيله، يظل بإمكان الوكلاء قراءة مخططات المشاريع المفتوحة من القرص، لكنهم لا يغيّرون أي مخطط دون علم محرره أبدًا. |
تذكر صفحة الإعدادات متى يكون وكلاء البرمجة غير متاحين: في بيئة تطوير بلا JCEF (حيث لا يمكن تشغيل ERD Editor أيضًا)، وفي بيئة تطوير مثبّتة بوصفها Flatpak على Linux، وعندما يتعذر بدء تشغيل محورها. في هذه الحالات لا تحتفظ بيئة التطوير بملف قفل، ويحرر الوكيل الملفات على القرص. لا يعيد ERD Editor تحميل مخطط تغيّر على القرص وهو مفتوح، ويعيد تعديلك التالي فيه كتابة المخطط كله فوق تغييرات الوكيل، لذا أغلق المخطط أولًا.
جرّبه
- افتح المجلد الذي يحتوي على مخططاتك: في VS Code، بوصفه مساحة عمل تثق بها؛ وفي Obsidian، بوصفه خزنة؛ وفي بيئة تطوير JetBrains، بوصفه مشروعًا تثق به.
- شغّل الوكيل في المجلد نفسه واطلب بلغة عادية، على سبيل المثال «أضف جدول reviews إلى schema.erd.json، مرتبطًا بـ users وproducts».
- شاهد التغيير يظهر على لوحة الرسم. في VS Code، احفظ باستخدام
Ctrl + S(Windows/Linux) أو⌘ + S(Mac)، أو اطلب من الوكيل الحفظ. يحفظ Obsidian وبيئة تطوير JetBrains التغيير كما يحفظان تعديلاتك، ويؤدي طلب الحفظ من الوكيل إلى كتابته فورًا.
يُفتح المخطط غير المفتوح بعد في ERD Editor عند أول تعديل يجريه الوكيل، دون أن يأخذ تركيز لوحة المفاتيح.
ينشئ الوكيل مستندًا جديدًا باستخدام erd_open_document، ويُضاف .erd.json إلى الاسم الذي لا امتداد له.
التحديث
لا تحدد الأوامر أعلاه أي إصدار، لذا يتحقق npx من npm بحثًا عن إصدار أحدث من الخادم في كل مرة يشغّله فيها الوكيل.
ويحتفظ الخادم الذي يعمل بالفعل بإصداره إلى أن يشغّله الوكيل من جديد.
يتحقق الخادم من إصدار البروتوكول الذي يستخدمه المحرر قبل أن يتصل به.
وعندما يختلف الإصداران، يُرفض كل استدعاء يصل إلى ذلك المحرر بالرمز protocolMismatch، بما في ذلك عمليات القراءة وerd_list_documents، ولا يُكتب شيء.
وتذكر الرسالة الطرف الذي يجب تحديثه: الخادم، أو ERD Editor في المحرر، وهو الإضافة في VS Code والمكوّن الإضافي في Obsidian وبيئة تطوير JetBrains.
يستخدم البروتوكول 2 كلٌّ من الخادم بالإصدار 1.0.0، وإضافة VS Code بالإصدار 4.0.0 أو أحدث، ومكوّن Obsidian الإضافي بالإصدار 1.0.0 أو أحدث، ومكوّن JetBrains الإضافي بالإصدار 1.0.0 أو أحدث.
ويستخدم كل إصدار سابق من الخادم البروتوكول 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 الخاص بإصدار المكوّن الإضافي الذي حمّلته أولًا.