نصب
سرور با نام @dineug/erd-editor-mcp در npm منتشر شده است.
این سرور یک فایل مستقل و بدون هیچ وابستگی زمان اجراست و 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 به نمودارهای درون پوشه‌های فضای کاری خود و هر نموداری که در آن باز است سرویس می‌دهد.
- افزونهٔ 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 به نمودارهای درون همان خزانه سرویس می‌دهد.
- پلاگین ERD Editor نسخهٔ
1.0.0یا بالاتر را از Community plugins نصب و روشن کنید. این پلاگین فقط در برنامهٔ دسکتاپ اجرا می‌شود و به 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 را خاموش کنید.
راه‌اندازی یک IDE از JetBrains
یک IDE از JetBrains به نمودارهای همهٔ پروژه‌هایی که در آن باز هستند و هر نموداری که در ERD Editor آن باز است سرویس می‌دهد.
- پلاگین ERD Editor نسخهٔ
1.0.0یا بالاتر را نصب کنید. این پلاگین به یک IDE مبتنی بر IntelliJ با نسخهٔ2025.2یا بالاتر نیاز دارد که روی JetBrains Runtime اجرا شود. - پروژه را باز کنید و به آن اعتماد کنید. در پروژه‌ای که IDE به آن اعتماد ندارد، مانند پروژه‌ای که در حالت امن باز شده است، عامل‌ها نمودارها را می‌خوانند اما هرگز تغییرشان نمی‌دهند.
- 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 و هنگامی که هاب آن نتوانسته باشد شروع به کار کند. در این موارد IDE هیچ فایل قفلی نگه نمی‌دارد و عامل فایل‌ها را روی دیسک ویرایش می‌کند. ERD Editor نموداری را که هنگام باز بودن روی دیسک تغییر کرده است دوباره بارگذاری نمی‌کند، و ویرایش بعدی شما در آن کل نمودار را روی تغییرات عامل بازنویسی می‌کند، پس ابتدا نمودار را ببندید.
امتحان کنید
- پوشه‌ای را که نمودارهایتان در آن است باز کنید: در VS Code، به‌عنوان فضای کاری‌ای که به آن اعتماد دارید؛ در Obsidian، به‌عنوان یک خزانه؛ در یک IDE از JetBrains، به‌عنوان پروژه‌ای که به آن اعتماد دارید.
- عامل را در همان پوشه اجرا کنید و به زبان ساده درخواست کنید، برای نمونه «یک جدول reviews به schema.erd.json اضافه کن که با users و products رابطه داشته باشد».
- ببینید که تغییر روی بوم اعمال می‌شود. در VS Code، با
Ctrl + S(Windows/Linux) یا⌘ + S(Mac) ذخیره کنید، یا از عامل بخواهید ذخیره کند. Obsidian و یک IDE از JetBrains تغییر را مانند ویرایش‌های خودتان ذخیره می‌کنند، و اگر از عامل بخواهید ذخیره کند، تغییر بی‌درنگ نوشته می‌شود.
نموداری که هنوز باز نیست، با نخستین ویرایش عامل در ERD Editor باز می‌شود، بدون آنکه فوکوس صفحه‌کلید را بگیرد.
عامل سند جدید را با erd_open_document می‌سازد و به نامی که پسوند ندارد .erd.json افزوده می‌شود.
به‌روزرسانی
فرمان‌های بالا نسخه‌ای را مشخص نمی‌کنند، پس npx هر بار که عامل سرور را اجرا می‌کند، npm را برای یافتن نسخه‌ای جدیدتر از سرور بررسی می‌کند.
سروری که از قبل در حال اجراست، نسخهٔ خود را تا زمانی که عامل دوباره آن را اجرا کند حفظ می‌کند.
سرور پیش از اتصال، نسخهٔ پروتکلی را که ویرایشگر از آن استفاده می‌کند بررسی می‌کند.
اگر این دو متفاوت باشند، هر فراخوانی‌ای که به آن ویرایشگر برسد، از جمله خواندن‌ها و erd_list_documents، با protocolMismatch رد می‌شود و هیچ چیز نوشته نمی‌شود.
پیام سمتی را که باید به‌روزرسانی شود نام می‌برد: سرور، یا 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 همان نسخه‌ای از پلاگین را اجرا می‌کند که ابتدا بارگذاری کرده است.