「日志规范化」是开发者的高频任务。它的输入通常是服务代码,期望得到的是改造后的日志调用与规范说明。这类有固定流程、又需要一点判断力的工作,很适合封装成智能体 Skill。

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

这个技能做什么

项目说明
技能日志规范化(logging-standardize)
作用统一日志级别、字段与格式,补齐关键路径日志
输入服务代码
输出改造后的日志调用与规范说明
形态纯提示词
风险中
适用人群开发者

处理流程分四步:

  1. 读取日志规范
  2. 找出不一致调用
  3. 统一字段
  4. 在关键路径补日志并避免记录敏感信息

这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;属于中等风险:结果会影响业务判断,建议在输出前设置人工审核点。

在 Cursor Rules 中是什么形态

Cursor 用项目规则(Project Rules)给智能体注入长期指令,规则文件放在 .cursor/rules/ 下,扩展名为 .mdc,头部可写 description、globs 与 alwaysApply,用来控制规则何时生效。

规则文件随仓库提交;description 供智能体按需选用,globs 让规则在匹配文件被引用时自动附加,alwaysApply 为 true 时每次都会带上。

示例配置

.cursor/rules/logging-standardize.mdc 示例(示意):

---
description: 日志规范化:统一日志级别、字段与格式,补齐关键路径日志
globs: **/*.{py,ts,js,go,java}
alwaysApply: false
---

# 日志规范化

当我要求「日志规范化」时,按以下步骤进行:

1. 读取日志规范
2. 找出不一致调用
3. 统一字段
4. 在关键路径补日志并避免记录敏感信息

输出:改造后的日志调用与规范说明。

- 改动前确认有测试与版本控制,一次只改一类问题。
- 结论中不确定的部分单独列出,标注「需人工确认」。

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者提出相关请求时能对上号;二是约束部分要写进「改动前确认有测试与版本控制,一次只改一类问题」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 在仓库新建 .cursor/rules/logging-standardize.mdc
  2. 写好 description,让它准确描述适用场景
  3. 按需填写 globs(只对相关文件生效),一般不要设为 alwaysApply
  4. 在 Agent 模式中描述任务,确认规则被引用
  5. 把规则提交到仓库,并在团队约定里说明

实操:一次完整的运行

假设你在代码仓库与终端中发出这样的请求(虚构示例):

帮我做一下日志规范化,材料是附上的服务代码。

智能体识别到任务与「日志规范化」相关后,会依次读取日志规范、找出不一致调用、统一字段、在关键路径补日志并避免记录敏感信息。最终交付改造后的日志调用与规范说明,并在末尾列出需要人工确认的内容。你的工作是对照原始服务代码抽查两三处关键信息,确认无误后再使用。

测试与验收

在 Agent 对话中观察规则是否被列为上下文;分别打开匹配与不匹配 globs 的文件测试。

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

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

常见坑

  • 把十几条无关规则都设成 alwaysApply,挤占上下文且相互冲突。
  • 规则写成泛泛的“写出高质量代码”,缺少可执行的步骤。
  • 只写了步骤,没写交付格式,导致每次输出的改造后的日志调用与规范说明结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

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