Встановлення
Сервер опубліковано в npm як пакет @dineug/erd-editor-mcp.
Це один самодостатній файл без залежностей часу виконання, і npx завантажує його, коли агент уперше його запускає, тож більше нічого встановлювати не потрібно.
Йому потрібен Node.js версії 22.12 або новішої.
Щоб агент міг редагувати діаграму в режимі Live, налаштуйте також редактор, у якому вона міститься: VS Code, Obsidian або IDE від JetBrains. Якщо документ не обслуговує жоден редактор, агент редагує файл на диску — див. режими Live і Headless.
Claude Code
Виконайте в папці вашого проєкту:
claude mcp add --transport stdio erd-editor -- npx -y @dineug/erd-editor-mcp
Додайте --scope project перед --transport, щоб натомість записати сервер у файл .mcp.json проєкту, звідки його підхоплює кожен, хто клонує проєкт.
Codex
Виконайте один раз. Codex CLI, застосунок і розширення для IDE спільно використовують це налаштування:
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
Вікно сховища (vault) 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 — як проєкт, якому ви довіряєте.
- Запустіть агента в тій самій папці й попросіть звичайними словами, наприклад «Додайте до schema.erd.json таблицю reviews, пов’язану з users і products».
- Подивіться, як зміна з’являється на полотні. У 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 тієї версії плагіна, яку воно завантажило першою.