Перейти к основному содержимому

Установка

Сервер опубликован в npm под именем @dineug/erd-editor-mcp. Это один самодостаточный файл без зависимостей времени выполнения, и npx загружает его, когда агент впервые запускает сервер, поэтому больше ничего устанавливать не нужно. Серверу требуется Node.js версии 22.12 или новее.

Чтобы агент мог редактировать диаграмму вживую, настройте также редактор, в котором она находится: 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 обслуживает диаграммы в папках своей рабочей области и любую диаграмму, открытую в нем.

  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 не обслуживает агентов. Расширение версии 4.0.0 или 4.1.0 подключается, но не показывает и не сохраняет логические имена, привязки к доменам и строки словарей, которые записывает агент. При расширении до версии 4.3.0 таблица, заметка или группа таблиц, которую вы и агент в один и тот же момент перемещаете или изменяете в размере, может оказаться у каждого из вас в разных местах — см. Обновление.

Расширение запускается в рабочей области, содержащей файлы .erd, .erd.json, .vuerd или .vuerd.json, поэтому агент получает доступ к этим диаграммам еще до того, как вы откроете одну из них. В рабочей области без таких файлов оно запускается, когда вы открываете диаграмму, а до тех пор агент вносит правки на диске.

НастройкаЗначение по умолчаниюДействие
dineug.erd-editor.agentHub.enabledtrueПозволяет 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 и сервер версии 1.0.0 или новее отклоняют друг друга. Плагин версии 1.0.0 или 1.1.0 подключается, но не показывает и не сохраняет логические имена, привязки к доменам и строки словарей, которые записывает агент. При плагине до версии 1.3.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 не обслуживает агентов. Плагин версии 1.0.0 или 1.1.0 подключается, но не показывает и не сохраняет логические имена, привязки к доменам и строки словарей, которые записывает агент. При плагине до версии 1.3.0 таблица, заметка или группа таблиц, которую вы и агент в один и тот же момент перемещаете или изменяете в размере, может оказаться у каждого из вас в разных местах — см. Обновление.

IDE обслуживает агентов с момента открытия первого проекта, поэтому агент получает доступ к диаграммам проекта еще до того, как вы откроете одну из них.

НастройкаЗначение по умолчаниюДействие
Coding agentsВключеноПозволяет MCP-серверу агента редактировать диаграммы этой IDE через локальный сокет, а в Windows — через именованный канал. Если параметр выключен, агенты по-прежнему могут читать диаграммы открытых проектов с диска, но никогда не изменяют диаграмму в обход ее редактора.

Страница настроек сообщает, когда агенты для программирования недоступны: в IDE без JCEF (где не может работать и ERD Editor), в IDE, установленной как Flatpak в Linux, и когда хаб IDE не смог запуститься. В этих случаях 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 или новее с расширением или плагином, использующим протокол 1Update the ERD Editor extension or plugin in the editor until its hub speaks protocol 2.
Более ранний сервер с расширением или плагином, использующим протокол 2Update the MCP server (npx -y @dineug/erd-editor-mcp@latest) until it speaks protocol 2.

Обновляйте сервер и расширение или плагин вместе. Сервер и редактор, использующие один и тот же протокол, подключаются друг к другу, какой бы из них ни был старше, но инструменты для логических имен, доменов и словарей есть только у сервера версии 1.1.0 или новее — см. Словари. Только расширение VS Code версии 4.2.0 или новее и плагины Obsidian и JetBrains версии 1.2.0 или новее показывают и сохраняют логические имена, привязки к доменам и строки словарей, которые записывают эти инструменты. Более раннее расширение или плагин, если подключается, игнорирует их, хотя вызов агента выполняется успешно. Однако физические имена, сформированные словарями, и типы данных, заданные доменами, применяются и в нем. Сервер до версии 1.1.0 читает файл без его логических имен, привязок к доменам и строк словарей и не записывает их, когда редактирует файл на диске, — см. Headless.

Сервер версии 1.2.0 тоже использует протокол 2 и не добавляет, не удаляет и не переименовывает ни одного инструмента и не меняет ни одного аргумента. Но перемещение или изменение размера одной и той же таблицы, заметки или группы таблиц, которые вы и агент выполняете в один и тот же момент, приходит к одному результату в редакторе и у агента, только если сервер версии 1.2.0 или новее, а в редакторе установлено расширение VS Code версии 4.3.0 или новее либо плагин Obsidian или JetBrains версии 1.3.0 или новее. Если хотя бы у одной стороны более старая версия, редактор и агент могут прийти к разным позициям, а агент продолжает читать и редактировать исходя из своей, пока более позднее перемещение не поставит обе стороны в одну точку или агент не подключится к документу заново — см. Правки, сделанные в один и тот же момент. Ни одна из этих версий не меняет того, что содержит файл.

Обновляйте также ERD Editor везде, где открываются диаграммы. Расширение VS Code до версии 4.2.0, плагин Obsidian до версии 1.2.0 и плагин JetBrains до версии 1.2.0 открывают диаграмму, сохраненную более поздней версией или отредактированную агентом на диске, без логических имен ее таблиц и столбцов, привязок ее столбцов к доменам и ее слов, терминов и доменов. При сохранении файла они их не записывают. Расширение 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 той версии плагина, которую оно загрузило первой.