用 Cursor Rules 实现「类型标注补全」:.mdc 规则写法与示例
开发者经常要做「类型标注补全」这类事:为 Python 或 JavaScript 代码逐步补充类型标注并通过类型检查。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 Cursor Rules 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 类型标注补全(type-annotation) |
| 作用 | 为 Python 或 JavaScript 代码逐步补充类型标注并通过类型检查 |
| 输入 | 源码文件 |
| 输出 | 带类型标注的代码与检查结果 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 开发者 |
处理流程分四步:
- 识别公共接口
- 从调用处推断类型
- 补充标注
- 运行类型检查器修正
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 Cursor Rules 中是什么形态
Cursor 用项目规则(Project Rules)给智能体注入长期指令,规则文件放在 .cursor/rules/ 下,扩展名为 .mdc,头部可写 description、globs 与 alwaysApply,用来控制规则何时生效。
规则文件随仓库提交;description 供智能体按需选用,globs 让规则在匹配文件被引用时自动附加,alwaysApply 为 true 时每次都会带上。
示例配置
.cursor/rules/type-annotation.mdc 示例(示意):
---
description: 类型标注补全:为 Python 或 JavaScript 代码逐步补充类型标注并通过类型检查
globs: **/*.{py,ts,js,go,java}
alwaysApply: false
---
# 类型标注补全
当我要求「类型标注补全」时,按以下步骤进行:
1. 识别公共接口
2. 从调用处推断类型
3. 补充标注
4. 运行类型检查器修正
输出:带类型标注的代码与检查结果。
- 改动前确认有测试与版本控制,一次只改一类问题。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者提出相关请求时能对上号;二是约束部分要写进「改动前确认有测试与版本控制,一次只改一类问题」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在仓库新建
.cursor/rules/type-annotation.mdc - 写好 description,让它准确描述适用场景
- 按需填写 globs(只对相关文件生效),一般不要设为 alwaysApply
- 在 Agent 模式中描述任务,确认规则被引用
- 把规则提交到仓库,并在团队约定里说明
实操:一次完整的运行
假设你在代码仓库与终端中发出这样的请求(虚构示例):
这是今天的源码文件,按团队的类型标注补全流程处理一下。
智能体识别到任务与「类型标注补全」相关后,会依次识别公共接口、从调用处推断类型、补充标注、运行类型检查器修正。最终交付带类型标注的代码与检查结果,并在末尾列出需要人工确认的内容。你的工作是对照原始源码文件抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Agent 对话中观察规则是否被列为上下文;分别打开匹配与不匹配 globs 的文件测试。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准源码文件,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 把十几条无关规则都设成 alwaysApply,挤占上下文且相互冲突。
- 规则写成泛泛的“写出高质量代码”,缺少可执行的步骤。
- 只写了步骤,没写交付格式,导致每次输出的带类型标注的代码与检查结果结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 类型标注补全 · GitHub Copilot 指令与提示文件 版
- 类型标注补全 · OpenAI Agents SDK 版
- 类型标注补全 · GPTs 版
- 废弃接口迁移 · Cursor Rules 版
- 功能开关清理 · Cursor Rules 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。