如果你在数据库客户端与查询工具里反复做数据字典生成,可以考虑把经验沉淀为一个 Skill:写清触发条件、步骤、输出格式和边界,让智能体代劳重复部分,人只负责把关。

本文介绍如何在 Gemini CLI 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能数据字典生成(data-dictionary)
作用根据库表结构与注释生成数据字典文档
输入数据库结构
输出数据字典
形态带脚本
风险低
适用人群后端与数据工程师

处理流程分四步:

  1. 读取表与字段
  2. 整理含义与示例
  3. 标出敏感字段
  4. 输出文档

这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。

在 Gemini CLI 中是什么形态

Gemini CLI 会读取项目中的 GEMINI.md 作为长期上下文,还支持在 .gemini/commands/ 下用 TOML 文件定义自定义斜杠命令,把一段固定提示封装成一个命令。

项目级命令放在仓库的 .gemini/commands/,个人级放在用户目录下的 .gemini/commands/;命令中可用 {{args}} 接收调用时的参数。

示例配置

自定义命令示例(示意):

# .gemini/commands/data-dictionary.toml
description = "数据字典生成:根据库表结构与注释生成数据字典文档"
prompt = """
你现在执行「数据字典生成」任务。
输入:{{args}}

按以下步骤处理:
1. 读取表与字段
2. 整理含义与示例
3. 标出敏感字段
4. 输出文档

最后输出:数据字典,并列出需要人工确认的内容。
"""

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在后端与数据工程师提出相关请求时能对上号;二是约束部分要写进「默认使用只读连接,任何写操作都要人工确认」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 在项目中新建 .gemini/commands/data-dictionary.toml
  2. 填写 description 与 prompt,prompt 中写清步骤与输出
  3. 在 GEMINI.md 中补充项目约定,供命令执行时参考
  4. 在 CLI 中输入 /data-dictionary 加参数调用
  5. 提交到仓库,团队共享

实操:一次完整的运行

假设你在数据库客户端与查询工具中发出这样的请求(虚构示例):

这是今天的数据库结构,按团队的数据字典生成流程处理一下。

智能体识别到任务与「数据字典生成」相关后,会依次读取表与字段、整理含义与示例、标出敏感字段、输出文档。最终交付数据字典,并在末尾列出需要人工确认的内容。你的工作是对照原始数据库结构抽查两三处关键信息,确认无误后再使用。

测试与验收

用空参数、正常参数和超长参数各调用一次命令,确认提示中的步骤与约束都生效。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准数据库结构,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • 把所有流程都塞进 GEMINI.md,导致每次对话上下文过长。
  • 命令名与内置命令或其他命令重名,调用时混淆。
  • 只写了步骤,没写交付格式,导致每次输出的数据字典结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。