AI 工具配置指南
本文件只说明如何把 DLZ-DB 文档交给 AI 工具，不复制 API、硬约束或代码模板。编程事实只有 dlz-db-速读.md 一份。
配置目标
无论使用 IDE Agent、代码补全工具还是普通对话模型，都让它遵循同一读取协议：
- 初次进入仓库先读根目录
llms.txt。 - 生成、修改、审查或迁移 DLZ-DB 代码前，完整读取
docs/5.AI辅助/dlz-db-速读.md。 - 根据
docs/5.AI辅助/README.md的路由，只补充当前任务需要的专题文件。 - 文档与源码冲突时，以当前源码和 POM 为准，并修正唯一编程契约。
项目级指令
在 AI 工具支持的项目规则、仓库指令或自定义说明中写入下面这段即可：
本项目使用 DLZ-DB 8.0。
开始工作时先读取根目录 llms.txt。
只要任务涉及生成、修改、审查或迁移 DLZ-DB 代码，必须完整读取
docs/5.AI辅助/dlz-db-速读.md，并将它作为唯一 AI 编程契约。
需要框架集成、迁移、Web 分层或 DLZ-KIT 时，按照
docs/5.AI辅助/README.md 的路由加载必要的少量专题文件；单一任务通常 1 个，组合任务可以多个。
不要根据模型记忆猜测 DLZ-DB API，不要从历史文档复制旧写法。
如文档与源码或 POM 冲突，以当前源码和 POM 为准。
生成后必须编译并运行相关测试。
不要把 dlz-db-速读.md 的内容再复制进各工具配置。工具配置只保留上述读取指令，API 更新时就不需要同步维护多份规则。
仓库感知型 Agent
对于能读取仓库文件的 Agent：
- 将上面的项目级指令放入该工具支持的仓库规则文件。
- 确认工具可以访问
llms.txt和docs/5.AI辅助/。 - 第一次任务可要求它复述将要加载的文件，但不要求复述整份 API。
- 普通 CRUD 默认只加载
llms.txt与dlz-db-速读.md。
工具支持的规则文件名和 UI 可能随版本变化，以工具当前官方说明为准；不要在本项目文档中固化快捷键或易变界面步骤。
普通 Chat / 临时会话
不能直接读取仓库时：
- 上传或粘贴
dlz-db-速读.md。 - 再提供与任务相关的 Entity、表结构、已有代码和目标框架。
- 只有任务触发时才额外上传必要的少量专题文件；单一任务通常 1 个，组合任务可以多个。
- 明确要求回答只使用文档中存在的 API，并标出无法确认的签名。
建议开场：
请完整阅读我提供的 DLZ-DB AI 编程契约，再处理下面的任务。
不得根据 MyBatis、MyBatis-Plus 或旧版 DLZ-DB 的习惯猜测方法名。
如果契约没有覆盖某个签名，请先检查当前源码，不要虚构 API。
完成后检查包名、返回类型、写入条件、Java 版本并给出验证结果。
代码审查任务
让 AI 审查现有代码时，只需提供编程契约、目标文件和必要上下文：
依据 docs/5.AI辅助/dlz-db-速读.md 审查这些文件。
重点检查入口选择、占位符、返回类型、执行终点、写入条件、
主键与逻辑删除、事务边界、internal import 和不存在的旧 API。
只报告有证据的问题。
团队维护规则
- 所有工具共享同一个文档路径，不分别维护 Cursor、Copilot、ChatGPT 等 API 副本。
- API 变化只更新
dlz-db-速读.md；加载规则变化才更新本文件和 AI README。 - 框架差异、迁移和按需能力文档只写各自增量，不重复公共约束。
- 定期搜索旧路径和旧 API 名，避免工具继续读取失效上下文。
- 将编译和测试结果作为 AI 任务完成条件，而不是相信生成文本。