跳到主要内容

工具

服务器提供 63 个工具：五个会话工具、三个读取工具、54 个编辑工具（每种编辑操作一个），以及把多个编辑工具作为一次编辑执行的 erd_batch。

除 erd_list_documents 外，每个工具都以文档的 path 作为第一个参数，下面的表格中省略了它。 标有 ? 的参数是可选的。

会话工具​

工具参数作用
erd_list_documents列出 ERD 文档及其 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_redo重新应用 erd_undo 最近撤回的编辑。

关于保存和 Undo 在每种模式下的行为，参见实时与无头模式。

读取文档​

工具参数作用
erd_listquery?, offset?, limit?, namesOnly?先是设置与数量统计，然后是一页表，并带有它们的索引与关系；每个表附带其 id、在画布上的位置和大小、列数，以及它所属的表分组（如果属于某个分组）。除非是在搜索，否则表之后依次是表分组和备注。
erd_gettableIds?, tableNames?, relationshipIds?, indexIds?, memoIds?, tableGroupIds?完整返回所指定的实体：表附带其列及其所属的表分组，关系附带其列及其 onDelete 和 onUpdate，索引附带其列，备注附带其文本，表分组附带其中的表。
erd_readformat, vendor?, statements?, header?, tableIds?, tableNames?, groupNames?以四种格式之一一次性返回整个文档，或者只返回部分表或部分表分组的 DDL。

智能体用 erd_list 查找 id，用 erd_get 读取列及其他详细信息，再把这些 id 传给编辑工具。 erd_list 中表的大小是它在画布上占据的方框：高度是精确的，宽度是近似的。 表分组按其存储的矩形列出，并附带其名称、颜色以及其中所含表的数量。 每条关系只列出一次，随其两个表中的一个列出。 erd_list 和 erd_read 报告的设置是文件所保存的设置，参见设置。

erd_read 接受以下四种格式之一：

format返回内容
snapshot包含每个实体及其 id 的紧凑 JSON，其中包括表分组，以及设置和 Schema SQL 脚本。它省略因查看者而异的内容：测量出的宽度、堆叠顺序、视图和标签页。schema 较大时体积也较大。
sql八种数据库之一的 DDL：Databricks、MariaDB、MSSQL、MySQL、Oracle、PostgreSQL、Snowflake 或 SQLite。vendor 默认为文档所设置的数据库。整个文档的 DDL 包含其前置脚本和后置脚本。指定 tableIds、tableNames 或 groupNames 时，只返回这些表，以及它们持有的外键，不包含脚本。外键会带有其 ON DELETE 与 ON UPDATE 操作，目标数据库省略的操作除外，参见 ON DELETE 与 ON UPDATE。
json与保存时写出的文件完全相同的整个文档，包括编辑器尚未保存的编辑，参见存储形式与运行时值。
scripts只返回文档的前置脚本和后置脚本，形式为 {"before":"…","after":"…"}，未设置的脚本为空，无论 schema 有多大。

只有 sql 格式接受 vendor、statements、header、tableIds、tableNames 和 groupNames，其他格式会拒绝它们。

  • statements：create，即默认值；ifNotExists，它在 MySQL、MariaDB、PostgreSQL、SQLite 和 Databricks 上写出 CREATE TABLE IF NOT EXISTS，在其他数据库上写出普通的 CREATE TABLE；或者 recreate，它会先删除这些表再创建它们，Snowflake 则改为写出 CREATE OR REPLACE TABLE。
  • header：none，即默认值；use，它会选择文档的数据库名称所指定的数据库或 schema；或者 createAndUse，它会先创建该数据库或 schema。Oracle 只具备 use，因此 createAndUse 在那里写出 use；PostgreSQL 只具备 createAndUse，因此 use 在那里不写出任何头部。SQLite 不写出头部，数据库名称为空或不是普通标识符时，任何数据库都不写出头部。
  • groupNames：所指定的表分组中的表，按名称指定，不区分大小写，并与 tableIds 和 tableNames 合并。没有匹配任何分组的名称会以 notFound 被拒绝。不含任何表的分组不会增加任何表；最终不含任何表的读取（例如所指定的每个分组都为空且没有指定任何表）会以 invalidArgs 被拒绝。

statements 和 header 同样适用于部分表的 DDL。它们的作用与编辑器 Schema SQL 标签页中的 Statements 和 Header 选项相同，不过该标签页的初始值为 If not exists 和 CREATE + USE。 名称会用文件所保存的括号类型加引号，Bracket Type 锁定期间则使用锁定的括号类型，参见锁定。

大型 schema​

包含数百乃至数千个表的 schema 同样可以处理。 一次读取最多返回 40,000 个字符，低于 Claude Code 把工具结果另存到文件中的阈值。

  • erd_list 默认返回一页 100 项，依次是表、表分组和备注，并通过 nextOffset 和 note 说明下一页从哪里开始。把该 nextOffset 作为 offset 传入，并使用相同的 query。
  • query 按表名、列名或注释中的词查找表，不区分大小写。名称中包含更多这些词的表排在前面。搜索不会列出表分组或备注。
  • namesOnly 只列出表名，一次返回约 2,000 个短名称。
  • erd_get 和 erd_read 除了 id 之外也接受 tableNames，erd_read 还接受 groupNames，因此当智能体被要求在大型 schema 上编写 SQL 查询时，只需读取它所需表的 DDL。
  • erd_get 会把没有对应任何实体的 id 和名称列在 missing 下，把一次返回放不下的 id 列在 notReturned 下，以便再次请求。
  • 一次返回放不下的读取会以 tooLarge 被拒绝，并说明如何缩小范围。

编辑工具​

id 来自 erd_list 和 erd_get，或者来自创建该实体的那次调用的 createdIds。 新的 id 由 25 个小写字母和数字组成，例如 03h17be2plxpj5n59tqag7ogj，而文档中已有的 id 保持其原有形式，因此不要从 id 的形式推断任何含义。 x 和 y 是在画布上的左边缘和上边缘，以像素为单位；颜色是 CSS 十六进制颜色，例如 #3b82f6，或者是表示去掉颜色的空字符串。

表​

工具参数作用
erd_add_table在空闲位置添加一个空表，并在 createdIds 中返回其 id。
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在一次编辑中移动多个表，一次 erd_undo 即可撤回。positions 中每个表对应一个 { tableId, x, y }，每个表最多出现一次。
erd_sort_tables将所有表按行排列在画布上，列数最少的在前，与 erd_import_sql、erd_import_graphql、erd_import_dbml 和 erd_import_aml 放置表的方式相同。表分组中的表会聚在一起，每个分组的框都会调整为恰好围住其中的表。

列​

工具参数作用
erd_add_columntableId向表中添加一个空列，并在 createdIds 中返回其 id。
erd_remove_columnstableId, columnIds从一个表中删除列，连同使用这些列的关系与索引条目。
erd_change_column_nametableId, columnId, value重命名列。
erd_change_column_data_typetableId, columnId, value设置数据类型，例如 INT 或 VARCHAR(255)。关系数据类型同步开启期间，该修改会像在编辑器中一样沿着关系双向传递：serial 类型会以其存储的整数类型传到外键，与 erd_add_relationship 复制它时相同；而当 serial 类型的键的某个外键发生变化时，该键会保留自己的类型，修改也就在那里停止。该同步由用户开启或关闭，erd_list 会将其报告为 relationshipDataTypeSync。
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?关联两个表。它会把父表的主键作为外键列复制到子表中，如果父表没有主键，则先创建一个主键列。每个外键列的命名方式与在编辑器中绘制关系时相同：users 的键 id 会变为 users_id，像 member_id 这样的键则保持原名，参见外键列名。每个外键列都沿用其对应键的数据类型，但 serial 类型的键对应其存储的整数类型，例如 serial4 对应 integer，而单独的 serial 在 PostgreSQL、MySQL 和 MariaDB 之外仍为 serial，参见识别关系。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_batch 中运行 erd_remove_relationship（它会把外键列保留在表中）和指定所需列的 erd_link_columns，一次 erd_undo 即可撤回。

索引​

索引列 id 是 erd_get 给出的索引列列表中的条目，而不是表中列的 id。

工具参数作用
erd_add_indextableId向表中添加一个空索引，并在 createdIds 中返回其 id。
erd_remove_indexindexId删除索引。
erd_change_index_nameindexId, value重命名索引。
erd_set_index_uniqueindexId, value设置索引是否唯一。
erd_add_index_columnindexId, columnId添加索引所属表中的一列，并返回新的索引列 id。已在索引中的列保持不变。
erd_remove_index_columnindexId, indexColumnId从索引中删除一列。
erd_move_index_columnindexId, indexColumnId, targetIndexColumnId在索引内将一列移动到该索引另一列的位置。
erd_set_index_column_orderindexId, indexColumnId, orderType设置索引中某一列的排序方式：ASC 或 DESC。

备注​

工具参数作用
erd_add_memo在空闲位置添加一个空备注，并在 createdIds 中返回其 id。
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 记录，因为编辑器只在拖动调整备注大小时才会记录。

通过 View Option → Memos 隐藏备注期间，erd_add_memo 仍会添加备注，该备注会保持隐藏，直到备注再次显示。 erd_list 和 erd_get 同样会列出隐藏的备注。

表分组​

表分组是绘制在其中各表后面、带有名称的框，其颜色会显示在框上以及其中各表的表头上，参见表分组。 一个表最多属于一个分组。无论 erd_move_table、erd_move_tables 和 erd_move_table_group 把表放在哪里，都不会改变分组所容纳的表；而在编辑器中，表在哪里放下，决定了它加入还是离开某个分组，参见添加与移除表。erd_add_table_group 和 erd_set_table_group 会把表放入分组，erd_remove_table_group 则让其中的表不再属于任何分组。 分组存储一个矩形，宽至少 160 像素、高至少 100 像素（含标题栏），编辑器绘制的框会撑大到足以容纳其中的每个表。

工具参数作用
erd_add_table_groupname, color?, x?, y?, width?, height?, tableIds?添加一个分组，并在 createdIds 中返回其 id。请传入 tableIds，或者同时传入构成矩形的 x、y、width 和 height，两者择一。传入 tableIds 时，每个表都会离开其原来所在的分组，矩形会像为选中的表分组时那样调整为恰好围住这些表。传入矩形时，中心位于矩形内、且不属于任何分组的每个表都会加入该分组，与绘制分组时相同。name 为空时，分组没有名称。一次 erd_undo 会删除该分组，并让每个表回到其原来所在的分组。
erd_remove_table_groupgroupId删除分组。其中的表留在原处，不再属于任何分组。
erd_change_table_group_namegroupId, value重命名分组。空字符串会让分组没有名称。
erd_change_table_group_colorgroupId, color设置分组的颜色。
erd_move_table_groupgroupId, x, y移动分组，使其矩形从该点开始，其中的表也移动相同的距离，与拖动其标题栏时相同。移动总计不足 20 像素（横向与纵向的距离相加）时不产生 Undo 记录。
erd_resize_table_groupgroupId, x?, y?, width, height设置分组的矩形，其中的表保持原位。省略 x 和 y 时保留其左上角的位置。无法连同四周留白容纳分组中各表的矩形会被拒绝，消息会指出矩形必须容纳的范围。
erd_set_table_grouptableIds, groupId把表放入分组，每个表都会离开其原来所在的分组。groupId 为 null 或空字符串时，会把这些表移出所有分组。

通过 View Option → Table Groups 隐藏分组期间，这些工具仍会添加和修改分组，这些分组会保持隐藏，直到分组再次显示，参见隐藏分组。 erd_sort_tables 会让每个分组中的表聚在一起，erd_import_dbml 和 erd_import_json 会带入分组（参见导入），erd_read 则可以通过 groupNames 写出所选分组的 DDL。 智能体在磁盘上写入的文件，如果由更早发布版本的 ERD Editor 保存，可能会丢掉其中的分组，参见更新。

设置​

智能体设置的是 schema 本身的设置：数据库、数据库名称，以及 Schema SQL 脚本。 文档存储的其他所有设置都由用户在编辑器中设置：View Option 开关、Settings 标签页中的选项、Code Generator 的语言与名称大小写、括号类型，以及锁定。 没有任何工具会更改它们，以 replace 模式进行的导入除外：erd_import_json 会带来它所加载文档的设置和锁定，其他四个工具则会把视图移回画布的起点，参见导入。 服务器 1.0.0 删除了设置它们的工具：erd_set_language、erd_set_table_name_case、erd_set_column_name_case、erd_set_bracket_type、erd_set_relationship_data_type_sync、erd_set_relationship_optimization、erd_set_column_order、erd_set_max_width_comment、erd_set_ignore_save_settings 和 erd_set_show。

erd_list 和 erd_read 的 snapshot 格式会按文件所保存的形式报告设置，其中 lockSettings 为每个锁定各包含一个标志：viewport、canvasType、language、tableNameCase、columnNameCase 和 bracketType。 已锁定的语言、名称大小写或括号类型会以其锁定的值报告，即文件保留、每个编辑器打开时所使用的值，无论编辑器的屏幕上显示的是什么。视图和标签页不会被报告。

erd_set_ddl_script 会产生 Undo 记录。erd_set_database 和 erd_set_database_name 不产生 Undo 记录，因此 erd_undo 无法撤回它们。

工具参数作用
erd_set_databasevalue设置数据库：MariaDB、MSSQL、MySQL、Oracle、PostgreSQL、SQLite、Databricks 或 Snowflake。它决定该数据库的数据类型，以及未指定 vendor 时 erd_read 输出的 DDL。
erd_set_database_namevalue设置数据库名称，即 erd_read 的 use 和 createAndUse 头部所指定的名称。
erd_set_ddl_scriptposition, sql设置写在各表前后的两段脚本之一，参见前置与后置脚本。position 为 before 时，脚本写在各表之前，例如 CREATE EXTENSION 或 CREATE SCHEMA；为 after 时，脚本写在各表之后，例如 GRANT 或 CREATE VIEW。sql 会替换整段脚本，最多 10,000 个字符，空字符串会删除该脚本。请先用 erd_read 的 scripts 格式读取当前的脚本。

脚本会按原样写入每种数据库的 DDL，因此请按文档的数据库编写脚本。在 MSSQL 上，如果脚本的最后一行不是 GO，会在其后添加一行 GO。 智能体在磁盘上写入的文件，如果由更早发布版本的 ERD Editor 保存，可能会丢掉其中的脚本，参见更新。

导入​

这些工具以与编辑器 Import 菜单相同的方式读取 schema，参见导入与导出文件。 每个工具都以 value 接受文本，并接受 mode：replace（默认值）或 append。

工具参数作用
erd_import_sqlvalue, mode?加载 SQL DDL，即 CREATE TABLE 语句之类的内容。
erd_import_graphqlvalue, mode?加载 GraphQL SDL。
erd_import_dbmlvalue, mode?加载 DBML。每个 TableGroup 都会成为一个由其列出的表组成的表分组，参见 DBML。
erd_import_amlvalue, mode?加载 AML。
erd_import_jsonvalue, mode?加载 erd-editor 的 JSON 文档，例如另一个 .erd.json 文件。

replace 会取代当前文档，erd_undo 可以恢复之前的文档：

  • erd_import_sql、erd_import_graphql、erd_import_dbml 和 erd_import_aml 会替换所有表、关系、索引、备注和表分组。它们保留文档的设置（包括锁定），只有视图除外，视图会回到画布的起点并恢复为 100%。
  • erd_import_json 会替换整个文档，包括其设置：JSON 中的设置和锁定会取代当前文档的设置和锁定，未记录任何锁定的 JSON 会开启所有锁定，并把视图放在画布的起点。要保留当前文档的设置，请以 erd_read 的 json 格式给出的文本为基础。空文本会得到一个新文档，与 erd_open_document 带 create 时创建的文档相同。

append 会像编辑器的 Import and Add 一样，把导入的内容添加到文档中，一次 erd_undo 即可撤回整个添加：

  • 文本中的内容会作为带有新 id 的新实体载入，组成一个内容块，落在文档中所有内容（包括隐藏的备注和表分组）的下方，并与其左边缘对齐。已有的每个表和每项设置都会保留，同名的表也不例外：不会按名称合并任何内容。
  • 关系和索引只会在导入带来的表之间建立，因此指向文本中未声明的表的外键会被丢弃。
  • erd_import_sql、erd_import_graphql 和 erd_import_aml 会添加表及其关系和索引，erd_import_dbml 还会添加其表分组。erd_import_json 会添加表、关系、索引、备注和表分组，但绝不会添加其设置，并且会拒绝空文本。

JSON 文档会保留自身的排列，包括其中的表分组：使用 replace 时保留其放置表的位置，使用 append 时则在添加的内容块内部保留。 SQL、GraphQL、DBML 和 AML 中的表会按行排列，列数最少的在前，每个分组中的表聚在一起，与 erd_sort_tables 放置表的方式相同，而绝不会像编辑器自身的 Import 在可行时那样按 Flow 排布。这四个工具在两种模式下都会拒绝空文本。

erd_batch​

erd_batch 按顺序把多个编辑工具作为一次编辑执行，要么全部生效，要么全部不生效。

  • operations 最多包含 100 个条目，每个条目为 { tool, as?, args? }，其中 args 是该工具去掉 path 后的参数。
  • 这些操作会先在文档的副本上试运行。被拒绝的操作会被指明，例如 operations[1] erd_remove_table: …，并且不会应用任何内容。
  • 一次 erd_undo 即可撤回整个批处理，但无法撤回的操作除外，结果中的 undoNote 会列出它们：所用工具不产生 Undo 记录的操作，例如 erd_set_database；以及改变了文档却没有产生 Undo 记录的操作，例如移动距离很短的 erd_move_table_group。完全没有产生 Undo 记录的批处理会被 erd_undo 跳过。结果中的 historyEntries 统计的是其中编辑器历史记录的条数，而不是 erd_undo 的调用次数。
  • 在实时会话中，编辑器要么接受整个批处理，要么完全不接受。

智能体在调用之前无法知道批处理会创建哪些 id，因此用 as 命名的操作可以让后续操作引用它们：$name 或 $name.0 表示它创建的第一个 id，$name.1 表示第二个，$name.last 表示最后一个。 名称由 ASCII 字母、数字和下划线组成，不能以数字开头，并且同一个名称只能用于一个操作。 引用只在接受实体 id 的参数中才会解析，因此内容为 $x 的名称或注释仍然是文本。

在一次调用中创建一个带列的表以及一条关系：

{
  "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。

结果​

编辑会返回一行 JSON：

{"tool":"erd_add_table","mode":"live","createdIds":["03h17be2plxpj5n59tqag7ogj"],"batches":1,"historyEntries":1}
字段含义
modelive 或 headless，参见实时与无头模式。
createdIds该调用所创建内容的 id，按创建顺序排列。
batches, historyEntries该调用发送了多少批变更，以及产生了多少条编辑器历史记录。
undoable, undoNote当 erd_undo 会跳过该调用时，undoable 为 false，undoNote 则说明原因：该工具不产生 Undo 记录；该调用改变了文档却没有产生 Undo 记录，例如移动不足 20 像素的 erd_move_table_group；或者文档已持有该值。erd_batch 的结果始终带有 undoNote。批处理产生了 Undo 记录时，它会说明一次 erd_undo 即可撤回该批处理，并列出撤回时保持不变的操作；没有产生时，结果会带有 undoable: false，说明则指出 erd_undo 会跳过它。
mismatch当该调用产生的变更批数或历史记录条数与工具声明的不一致时出现。
notes会话发生某些变化时出现，例如编辑器已退出或已停止为该文档提供服务，或者文件在磁盘上发生了变化。

拒绝是一个错误结果，带有代码和一条说明该怎么做的消息：

{"error":{"code":"notFound","message":"tableId nope names no live table; read the document for current ids"}}
code原因
notFound某个 id 没有对应任何现存的实体，或者文件不存在。
invalidArgs缺少某个参数，或者参数的值不正确。
invalidPath该路径不是 ERD 文档。在 Windows 上，还包括含有 Windows 无法按原样存储的名称的路径，或者指向某个编辑器以另一条路径持有的文档的路径，消息会指出那条路径。
invalidDocument该文件不是编辑器可以读取的文档。
tooLarge一次读取无法放入一次返回中。
blocked持有该文档的编辑器的 hub 已关闭。消息会说明如何开启它：在 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 扩展或插件与服务器所用的协议版本不同，例如服务器 1.0.0 搭配更早的扩展或插件。读取同样会被拒绝，消息会指出需要更新的一方，参见更新。
hubUnreachable, timeout, disconnected编辑器的 hub 没有接受连接、没有在 30 秒内应答，或者在调用期间断开了连接。在 Windows 上，hubUnreachable 还表示 Windows 不允许智能体访问该 hub：编辑器以高于智能体的权限运行（例如编辑器以管理员身份启动而智能体没有），或者智能体在沙箱中运行。

其他代码较为少见，而且每次拒绝都会附带一条说明发生了什么的消息。

编辑工具、erd_batch 以及三个读取工具会在接触文档之前，以 JSON-RPC 的 invalid params 错误（-32602）拒绝它们未声明的参数或类型错误的参数，因此拼错的参数绝不会被悄悄丢弃。 五个会话工具会忽略它们不认识的参数。