database-schema
在数据库持久化需求触发时,维护多来源、多数据库的 JSONC schema,并同步相关代码。
为什么有这个 skill
把 schema.json、registry.schema.json 的机器契约、references/CONSTRAINTS.md 的语义规范和 examples 组织成一个可复用、可安装且能记忆多来源、多数据库 schema 关系的 Agent skill。
解决什么问题
数据库 schema 同时包含结构、语义、类型映射和索引规则,Agent 容易遗漏约束或擅自修改用户意图。
复制即可安装:安装 database-schema
自动探测本机已安装的 Agent;命令中的站点地址会根据当前页面自动生成。
正在生成安装命令…
人类说明
database-schema
解决什么问题
数据库 schema 同时承担结构定义、字段语义、类型映射、索引配置和代码生成依据。若这些规则散落在编辑器配置、数据库文档和个人经验中,Agent 很容易漏掉 required、误解可空性、覆盖用户显式类型,或在不同数据库之间生成不一致的代码。
为什么有这个 skill
这个 skill 将现有数据库 schema 制品包装成一个可安装、可复用的 Agent 能力:
schema.json负责机器可校验的结构契约;registry.schema.json负责项目内 schema 位置注册表的结构契约;references/CONSTRAINTS.md负责保真、位置、可空性和双向同步等核心语义;references/multi-source-layout.md、type-mapping.md和indexes-and-risks.md按场景加载多来源、类型与索引细节;examples/提供 MongoDB、PostgreSQL 等目标数据库的完整写法参考;SKILL.md负责告诉 Agent 何时使用这些资源、如何记忆 schema 位置,以及如何坚持“保真优先、只警告不代决”。
适用范围
适用于:
- 所有涉及持久化结构或数据契约的数据库需求,即使用户没有显式提到 schema;
- JSONC schema 的生成、修改、校验和评审;
- fields、enums、types、indexes、required、readonly 和类型映射的设计;
- schema 与数据库定义、DTO、ORM 模型及其他代码的双向同步;
- 多来源、多数据库下 source / canonical / target 三层 schema 的组织与追踪;
- MongoDB、PostgreSQL 等数据库之间的落地差异分析。
不适用于与本仓库 JSONC schema 格式无关的普通 SQL 查询、数据库运维或独立迁移方案设计。
默认情况下,schema 文档放在项目的 docs/schemas/ 目录,并由项目内的 docs/schemas/SCHEMA-REGISTRY.json 记录位置。只有用户明确指定跨项目公共存储目录,或注册表已经记录该 schema 使用公共目录时,才使用外部路径;公共 schema 也必须保留项目内引用记录。
本 skill 不提供内置代码生成器或 SQL 生成器;它要求 Agent 在数据库需求发生时定位 schema,并同步 schema、已有代码和位置注册表。
多来源或多数据库项目使用注册表 version: 2:来源契约放在 sources/,跨来源业务定义放在 canonical/,具体数据库投影放在 targets/,公共枚举和类型放在 shared/。每份文档通过稳定的 schema_id、entity、role、system_id 和 derived_from 追踪,不能只用 table_name 区分。
安装
从仓库根目录执行:
bash scripts/install.sh --skill database-schema --yes
默认会探测本机已安装的 Agent,只安装到探测到的目录。只安装到某个 Agent 时,添加例如 --target codex-cli。安装器会完整复制 skills/database-schema/ 目录,因此结构契约、按需 references 和 examples 会与 SKILL.md 一起分发,并保持相对路径不变。安装完成后请新建会话或重新加载 Agent,使其重新扫描 skills 目录。