メインコンテンツまでスキップ

ツール

サーバーは 65 個のツールを提供します。5 個のセッションのツール、3 個の読み取りツール、編集操作ごとに 1 つずつある 56 個の編集ツール、そして複数の編集ツールを 1 つの編集として実行する erd_batch です。

erd_list_documents 以外のすべてのツールは、最初の引数としてドキュメントの path を受け取ります。以下の表では省略しています。 ? の付いた引数は省略可能です。

セッションのツール​

ツール引数動作
erd_list_documentsERD ドキュメントを path、open、active、dirty、readonly とともに一覧表示します。作業ディレクトリを扱うエディタがあればそのエディタのドキュメント（JetBrains IDE では開いているすべてのプロジェクトが対象）を、なければ作業ディレクトリ以下の ERD ファイルを表示します。
erd_open_documentcreate?ドキュメントを編集用に開きます。そのドキュメントを扱うエディタがある場合は、そのエディタの ERD Editor で開きます。create を付けると、ファイルがなければ先に作成し、拡張子のない名前には .erd.json が付きます。
erd_saveエディタが保持しているドキュメントを保存します。VS Code はこれが呼び出されるまでエージェントの編集を未保存のままにします。Obsidian と JetBrains IDE はユーザーの編集と同じようにそれらを保存し、これを呼び出すとすぐに書き込まれます。ヘッドレスではすべての編集がすでに書き込まれているため、何もしません。
erd_undoこのエージェントが行った最後の編集を元に戻します。ユーザーの編集は元に戻しません。Undo の項目を作らなかった呼び出しは飛ばされ、その名前が示されます。
erd_redoerd_undo が最後に元に戻した編集を、再び適用します。

各モードで保存と Undo がどう動作するかは、ライブとヘッドレスを参照してください。

ドキュメントの読み取り​

ツール引数動作
erd_listquery?、offset?、limit?、namesOnly?設定と件数、続いて 1 ページ分のテーブルを返します。各テーブルには ID、キャンバス上の位置とサイズ、カラム数が付き、そのインデックスとリレーションシップも含まれます。検索でない場合は、テーブルの後にメモが続きます。
erd_gettableIds?、tableNames?、relationshipIds?、indexIds?、memoIds?指定したエンティティの全体を返します。テーブルはカラムとともに、リレーションシップはそのカラムと onDelete、onUpdate とともに、インデックスはそのカラムとともに、メモは本文とともに返します。
erd_readformat、vendor?、tableIds?、tableNames?ドキュメント全体を 3 つの形式のいずれかで一度に返すか、一部のテーブルだけの DDL を返します。

エージェントは erd_list で ID を見つけ、erd_get でカラムなどの詳細を読み取り、それらの ID を編集ツールに渡します。 erd_list のテーブルのサイズは、キャンバス上でテーブルが占める矩形です。高さは正確で、幅は概算です。 各リレーションシップは、両端の 2 つのテーブルのどちらか一方とともに、1 回だけ一覧に含まれます。

erd_read は次の 3 つの形式のいずれかを受け取ります。

format返す内容
snapshotすべてのエンティティとその ID を含むコンパクトな JSON です。大きなスキーマでは大きくなります。
sql8 つのデータベース Databricks、MariaDB、MSSQL、MySQL、Oracle、PostgreSQL、Snowflake、SQLite のいずれかの DDL です。vendor の既定値は、ドキュメントに設定されているデータベースです。tableIds または tableNames を指定すると、それらのテーブルだけを、それらが持つ外部キーとともに返します。外部キーには ON DELETE と ON UPDATE のアクションが付きますが、対象のデータベースが省くアクションは除きます。ON DELETE と ON UPDATEを参照してください。
json生の .erd.json ドキュメントです。

大きなスキーマ​

数百、数千のテーブルを持つスキーマも扱えます。 1 回の読み取りが返すのは最大 40,000 文字で、Claude Code がツールの結果をファイルに退避させる境目を下回ります。

  • erd_list は既定で 1 ページ 100 テーブルを返し、次のページの開始位置を nextOffset と note で示します。その nextOffset を offset として、同じ query とともに渡します。
  • query は、テーブルやカラムの名前またはコメントに含まれる語でテーブルを探し、大文字と小文字を区別しません。名前に含まれる語が多いテーブルほど先に来ます。
  • namesOnly はテーブル名だけを一覧表示し、短い名前なら 1 回の応答で約 2,000 件を返します。
  • erd_get と erd_read は ID に加えて tableNames も受け取るため、大きなスキーマで SQL クエリを頼まれたエージェントは、必要なテーブルの DDL だけを読み取れます。
  • erd_get は、何も指していない ID と名前を missing に、1 回の応答に収まらなかった ID を notReturned に一覧表示するため、後者は改めて要求できます。
  • 1 回の応答に収まらない読み取りは tooLarge で拒否され、絞り込み方が示されます。

編集ツール​

ID は erd_list と erd_get、またはそのエンティティを作った呼び出しの createdIds から得ます。 x と y はキャンバス上の左端と上端の位置をピクセル単位で表し、色は #3b82f6 のような CSS の 16 進カラーです。

テーブル​

ツール引数動作
erd_add_table空いている場所に空のテーブルを追加し、その ID を createdIds で返します。
erd_remove_tabletableIdテーブルを、そのカラム、インデックス、テーブルに接するすべてのリレーションシップとともに削除します。
erd_change_table_nametableId、valueテーブル名を変更します。
erd_change_table_commenttableId、valueテーブルのコメントを設定します。空文字列で消去します。
erd_change_table_colortableId、colorテーブルの色を設定します。
erd_move_tabletableId、x、yテーブルをキャンバス上の位置に移動します。
erd_move_tablespositions複数のテーブルを 1 つの編集で移動し、1 回の erd_undo で元に戻せます。positions はテーブルごとに { tableId, x, y } を持ち、各テーブルは 1 回までです。
erd_sort_tables読み込み時と同じように、カラムの少ないテーブルから順に、すべてのテーブルをキャンバス上に行状に並べます。

カラム​

ツール引数動作
erd_add_columntableIdテーブルに空のカラムを追加し、その ID を createdIds で返します。
erd_remove_columnstableId、columnIds1 つのテーブルからカラムを削除し、それを使うリレーションシップとインデックスの項目も削除します。
erd_change_column_nametableId、columnId、valueカラム名を変更します。
erd_change_column_data_typetableId、columnId、valueINT や VARCHAR(255) などのデータ型を設定します。リレーションシップのデータ型同期がオンの場合は、それをコピーしている外部キーも追従します。
erd_change_column_defaulttableId、columnId、value既定値を SQL のテキストとして設定します。空文字列で消去します。
erd_change_column_commenttableId、columnId、valueコメントを設定します。空文字列で消去します。
erd_set_column_primary_keytableId、columnId、valuetrue でカラムを主キーに含め、false で主キーから外します。
erd_set_column_uniquetableId、columnId、valueカラムをユニークにするかどうかを設定します。
erd_set_column_not_nulltableId、columnId、valueカラムを NOT NULL にするかどうかを設定します。
erd_set_column_auto_incrementtableId、columnId、valueカラムを自動インクリメントにするかどうかを設定します。
erd_move_columntableId、columnId、targetColumnIdテーブル内でカラムを、別のカラムの位置へ移動します。

リレーションシップ​

relationshipType は子側の端のカーディナリティで、ZeroOne、ZeroN、OneOnly、OneN のいずれかです。 開始テーブルは親、つまり主キーを持つ参照される側で、終了テーブルは子です。 onDelete と onUpdate は外部キーの ON DELETE と ON UPDATE のアクションで、none、noAction、cascade、setNull、setDefault、restrict のいずれかです。 none は句を書き出さないため、データベースの既定の動作が適用されます。ON DELETE と ON UPDATEを参照してください。 erd_add_relationship または erd_link_columns で省略したアクションは none になります。

ツール引数動作
erd_add_relationshipstartTableId、endTableId、relationshipType、onDelete?、onUpdate?2 つのテーブルをリレーションシップでつなぎます。親の主キーを外部キーカラムとして子にコピーし、親に主キーがない場合は先に主キーカラムを作成します。各外部キーカラムには、エディタでリレーションシップを描いたときと同じように名前が付けられます。キーが id の users からは users_id ができ、member_id のようなキーは名前がそのまま使われます。外部キーカラムの名前を参照してください。createdIds には、作成された場合はその新しいキーカラム、外部キーカラム、そして最後にリレーションシップの ID が入ります。
erd_link_columnsstartTableId、startColumnIds、endTableId、endColumnIds、relationshipType、onDelete?、onUpdate?すでにあるカラムの間にリレーションシップを描き、開始側と終了側のカラムを位置の順に対応付けます。
erd_remove_relationshiprelationshipIdリレーションシップの線を削除します。その外部キーカラムはテーブルに残ります。
erd_change_relationship_typerelationshipId、relationshipTypeリレーションシップのカーディナリティを変更します。
erd_change_relationship_on_deleterelationshipId、onDeleteリレーションシップの ON DELETE のアクション、つまり親の行を削除したときにその子の行がどうなるかを設定します。
erd_change_relationship_on_updaterelationshipId、onUpdateリレーションシップの ON UPDATE のアクション、つまり親のキーを変更したときにその子の行がどうなるかを設定します。

erd_add_relationship は実行した時点で外部キーカラムの名前を決めるため、親テーブルとその主キーには先に名前を付けてください。

古い ERD Editor の拡張機能やプラグイン、つまり VS Code の拡張機能の 3.1.0 より前のバージョン、Obsidian のプラグインの 0.2.0 より前のバージョン、JetBrains のプラグインの 0.10.0 より前のバージョンは、ドキュメントを扱うときに ON DELETE と ON UPDATE を無視します。 それらを設定するツールは成功しますが、ダイアグラムにも、そのエディタが保存するファイルにも、それらは残りません。拡張機能やプラグインを更新してください。アップデートを参照してください。 そのドキュメントを扱うエディタがない場合、アクションはほかの編集と同じようにファイルに書き込まれます。

インデックス​

インデックスのカラム ID は、erd_get が返すインデックスのカラム一覧の項目の ID であり、テーブルのカラムの ID ではありません。

ツール引数動作
erd_add_indextableIdテーブルに空のインデックスを追加し、その ID を createdIds で返します。
erd_remove_indexindexIdインデックスを削除します。
erd_change_index_nameindexId、valueインデックス名を変更します。
erd_set_index_uniqueindexId、valueインデックスをユニークにするかどうかを設定します。
erd_add_index_columnindexId、columnIdインデックスのテーブルのカラムを追加し、新しいインデックスのカラム ID を返します。すでにインデックスにあるカラムはそのままです。
erd_remove_index_columnindexId、indexColumnIdインデックスからカラムを 1 つ削除します。
erd_move_index_columnindexId、indexColumnId、targetIndexColumnIdインデックス内でカラムを、そのインデックスの別のカラムの位置へ移動します。
erd_set_index_column_orderindexId、indexColumnId、orderTypeインデックス内の 1 つのカラムの並び順を ASC または DESC に設定します。

メモ​

ツール引数動作
erd_add_memo空いている場所に空のメモを追加し、その ID を createdIds で返します。
erd_remove_memomemoIdメモを削除します。
erd_change_memo_valuememoId、valueメモの本文を置き換えます。
erd_change_memo_colormemoId、colorメモの色を設定します。
erd_move_memomemoId、x、yメモをキャンバス上の位置に移動します。
erd_resize_memomemoId、width、heightメモのサイズを変更します。幅は約 116 ピクセル以上、高さは 100 ピクセル以上である必要があります。エディタはメモのサイズ変更をドラッグによるものしか記録しないため、Undo の項目は作りません。

設定​

データベース、Code Generator のオプション、設定タブの項目など、ドキュメントに保存される設定です。 erd_set_show 以外はどれも Undo の項目を作らないため、erd_undo では元に戻せません。

ツール引数値
erd_set_databasevalueMariaDB、MSSQL、MySQL、Oracle、PostgreSQL、SQLite、Databricks、Snowflake。そのデータベースのデータ型と、vendor を指定しないときに erd_read が出力する DDL を決めます。
erd_set_database_namevalueデータベース名。
erd_set_languagevalueCode Generator の言語。GraphQL、csharp、Java、Kotlin、TypeScript、JPA、Scala、Go、SQLAlchemy、TypeORM、Sequelize、Drizzle、DBML、AML。
erd_set_table_name_casevalue生成されるテーブル名のケース。none、camelCase、pascalCase、snakeCase。
erd_set_column_name_casevalueカラム名について、同じ設定。
erd_set_bracket_typevalue生成される SQL での名前の囲み方。none、doubleQuote、singleQuote、backtick。
erd_set_relationship_data_type_syncvaluetrue にすると、外部キーカラムを、参照するカラムのデータ型に合わせ続けます。
erd_set_relationship_optimizationvalueドキュメントに保存される、リレーションシップ最適化のフラグ。
erd_set_column_ordercolumnType、targetColumnTypeテーブルの行の 1 つの要素を、別の要素の位置へ移動します。columnName、columnDataType、columnNotNull、columnUnique、columnAutoIncrement、columnDefault、columnComment。
erd_set_max_width_commentvalueテーブル内でコメントを描画する最大幅（ピクセル単位）。-1 で制限なし。
erd_set_ignore_save_settingssaveSettingType、valuetrue にすると、保存するファイルから scroll または zoomLevel を除きます。新しいドキュメントは、エディタの新しいダイアグラムと同じように、どちらも true で始まります。スクロール情報の保存を参照してください。
erd_set_showshow、valueダイアグラムの 1 つの要素を表示または非表示にします。tableComment、columnComment、columnDataType、columnDefault、columnAutoIncrement、columnPrimaryKey、columnUnique、columnNotNull、relationship、columnAlternateKey、hideReferentialAction。columnAlternateKey を表示すると、各代替キーのカラムに AK1.1 のようなマークが付きます。hideReferentialAction は意味が逆で、true にすると、リレーションシップの線に付く ON DELETE と ON UPDATE のラベルを非表示にします。ラベルは既定で表示されます。コネクタの読み方を参照してください。

読み込み​

どれもドキュメント全体を置き換え、erd_undo で前のドキュメントに戻せます。 エディタの Import メニューと同じ方法でスキーマを読み込みます。ファイルの読み込みと書き出しを参照してください。

ツール引数動作
erd_import_sqlvalueCREATE TABLE 文などの SQL DDL を読み込みます。
erd_import_graphqlvalueGraphQL SDL を読み込みます。
erd_import_dbmlvalueDBML を読み込みます。
erd_import_amlvalueAML を読み込みます。
erd_import_jsonvalue別の .erd.json ファイルなど、erd-editor の JSON ドキュメントを読み込みます。空のテキストでは、erd_open_document が create で作成するものと同じ、新しいドキュメントになります。

erd_batch​

erd_batch は複数の編集ツールを順に、1 つの編集として実行します。すべて適用されるか、何も適用されないかのどちらかです。

  • operations には最大 100 件の項目を指定し、各項目は { tool, as?, args? } の形です。args は path を除いた、そのツールの引数です。
  • 操作はまずドキュメントのコピーで試されます。拒否された操作は operations[1] erd_remove_table: … のように示され、何も適用されません。
  • 1 回の erd_undo でバッチ全体が元に戻ります。結果の historyEntries はバッチ内のエディタの履歴の件数で、erd_undo の呼び出し回数ではありません。
  • ライブのセッションでは、エディタはバッチ全体を受け入れるか、まったく受け入れないかのどちらかです。

エージェントは、バッチが作成する ID を呼び出す前に知ることができません。そこで as で名前を付けた操作の ID は、後の操作から参照できます。最初に作成された ID は $name または $name.0、2 番目は $name.1、最後は $name.last です。 名前に使えるのは ASCII の英字、数字、アンダースコアで、数字で始めることはできず、1 つの名前は 1 つの操作にしか付けられません。 参照が解決されるのはエンティティの ID を受け取る引数だけなので、$x と書かれた名前やコメントはテキストのままです。

テーブルとそのカラム、リレーションシップを 1 回の呼び出しで作成する例です。

{
  "path": "shop.erd.json",
  "operations": [
    { "tool": "erd_add_table", "as": "users" },
    { "tool": "erd_change_table_name", "args": { "tableId": "$users", "value": "users" } },
    { "tool": "erd_add_column", "as": "uid", "args": { "tableId": "$users" } },
    { "tool": "erd_change_column_name", "args": { "tableId": "$users", "columnId": "$uid", "value": "id" } },
    { "tool": "erd_change_column_data_type", "args": { "tableId": "$users", "columnId": "$uid", "value": "BIGINT" } },
    { "tool": "erd_set_column_primary_key", "args": { "tableId": "$users", "columnId": "$uid", "value": true } },
    { "tool": "erd_add_table", "as": "orders" },
    { "tool": "erd_change_table_name", "args": { "tableId": "$orders", "value": "orders" } },
    { "tool": "erd_add_relationship", "args": { "startTableId": "$users", "endTableId": "$orders", "relationshipType": "ZeroN", "onDelete": "cascade" } }
  ]
}

users とそのキー id にはリレーションシップより前に名前が付いているため、リレーションシップが orders に追加する外部キーカラムは users_id になります。

結果​

編集は 1 行の JSON を返します。

{"tool":"erd_add_table","mode":"live","createdIds":["b7u59tHkuXTA1hhtWh_bD"],"batches":1,"historyEntries":1}
フィールド意味
modelive または headless。ライブとヘッドレスを参照してください。
createdIds呼び出しが作成したものの ID を、作成した順に並べたもの。
batches、historyEntries呼び出しが送った変更のバッチの数と、作成したエディタの履歴の件数。
undoable、undoNoteerd_undo がその呼び出しを飛ばす場合は undoable が false になり、undoNote がその理由を示します。理由は、そのツールが Undo の項目を作らないこと、またはドキュメントがすでにその値を持っていたことです。erd_batch の結果には常に undoNote が付き、1 回の erd_undo でバッチ全体が元に戻ることを示します。
mismatch呼び出しが作成したバッチまたは履歴の件数が、ツールが宣言する数と異なる場合に含まれます。
notesエディタが終了したかドキュメントを扱うのをやめた場合や、ディスク上のファイルが変更された場合など、セッションについて何かが変わったときに含まれます。

拒否は、コードと、どうすればよいかを示すメッセージを含むエラーの結果です。

{"error":{"code":"notFound","message":"tableId nope names no live table; read the document for current ids"}}
code理由
notFoundID が指すものが存在しないか、ファイルが存在しません。
invalidArgs引数がないか、値が正しくありません。
invalidPathパスが ERD ドキュメントではありません。Windows では、Windows が指定どおりに保存しない名前を含むパスや、エディタが別のパスで保持しているドキュメントを指すパスも該当し、その別のパスはメッセージに示されます。
invalidDocumentファイルが、エディタで読めるドキュメントではありません。
tooLarge読み取りが 1 回の応答に収まりません。
blockedハブがオフのエディタが、ドキュメントを保持しています。メッセージにはハブをオンにする方法が示されます。VS Code ではワークスペースを信頼して dineug.erd-editor.agentHub.enabled をオンにするか、ウィンドウを再読み込みします。Obsidian では Coding agents をオンにするか、Obsidian を再読み込みします。JetBrains IDE では Coding agents をオンにするか、オンなら IDE を再起動します。
hubDisabledJetBrains IDE が、信頼していないプロジェクトでだけドキュメントを保持しています。読み取りは引き続き行えます。エージェントに編集させるには、プロジェクトを信頼してください。
conflict呼び出しの間にディスク上のファイルが変更されました。何も書き込まれていません。
hubAppeared、hubGoneエージェントがディスク上で編集していたドキュメントをエディタが扱い始めたか、ドキュメントを扱っていたエディタが動作しているものの、そのロックファイルと接続がなくなりました。何も書き込まれていません。
notSavederd_save がエディタのドキュメントを保存できませんでした。
readonlyエディタがドキュメントを読み取り専用で保持しています。例えば、書き込めないファイルや、ダイアグラムとして読めないファイルです。エディタがない場合は、ファイル自体が読み取り専用です。例えば、チェックアウトしていない Perforce や TFVC のファイルです。何も書き込まれていません。
protocolMismatchエディタの ERD Editor 拡張機能またはプラグインと、サーバーのプロトコルのバージョンが異なります。
hubUnreachable、timeout、disconnectedエディタのハブが接続を受け付けなかったか、30 秒以内に応答しなかったか、呼び出しの途中で接続を切りました。Windows では、hubUnreachable は Windows がエージェントをハブに接続させなかったことも意味します。エディタがエージェントより高い権限で動作している場合で、例えばエディタを管理者として起動しエージェントはそうしなかった場合や、エージェントがサンドボックス内で動作している場合です。

ほかのコードはまれにしか発生しません。どの拒否にも、何が起きたかを示すメッセージが含まれます。

編集ツール、erd_batch、3 つの読み取りツールは、宣言していない引数や型の誤った引数を、ドキュメントに触れる前に JSON-RPC の invalid params エラー（-32602）で拒否するため、綴りを誤った引数が黙って無視されることはありません。 5 個のセッションのツールは、知らない引数を無視します。