










LLM:大语言模型。 是一种基于大量文本训练的 AI 模型,能够理解并生成人类语言。
Claude
Cursor:
MCP:
Skills:
场景:在 Cursor 中让 AI 帮你生成 API 文档
1. Claude (AI模型) - 理解你的需求:"生成API文档" - 分析代码结构 - 生成文档内容 2. Cursor (编辑器) - 提供代码编辑界面 - 集成 Claude 模型 - 显示 AI 的响应 3. MCP (协议层,可选) - 如果 Skill 需要连接外部工具(如数据库、API) - MCP 提供标准化的连接方式 - 例如:通过 MCP 连接 GitHub API 获取代码信息 4. Skill (具体实现) - 定义规则:"当用户说'生成API文档'时,执行以下步骤..." - 告诉 Claude 如何分析 Controller - 指定输出格式(Markdown)
假设你定义了一个 Skill:"代码审查助手"
用户输入:"审查这个文件"
↓
Cursor 识别到这是 Skill 触发
↓
Claude 读取 Skill 定义:
- 检查代码风格
- 查找潜在bug
- 检查安全性
↓
Claude 执行审查
↓
Cursor 显示结果
关于skills的讲解 : https://www.163.com/dy/article/KJP2368405566SDR.html

1. 文件夹名称必须是小写字母+连字符,例如 hotspot-collector(不能有空格、大写)
2. SKILL.md是唯一必需的,其他都是可选的
SKILL.md 是核心文件,它的结构是固定的分为两部分:
1、YAML头部(必需):用---包裹,包含 name和description字段,这是 OpenCode用来识别 Skill 的名片。
2、Markdown 主体(必需):详细的工作流程,输出格式要求,示例等。
---name: 你的skill名称description: 简要描述该技能的功能以及何时该使用它# 你的技能名称## 指令 (Instructions)为 OpenCode提供清晰、逐步的操作指南。## 示例 (Examples)展示使用该技能的具体代码或操作案例 【description这个字段描述 很核心,就是描述Agent会在何时如何调用你这个skills。】
一个完整的 Skill 定义通常包含:
在项目根目录创建 .cursorrules 文件:
# 项目 AI 规则和 Skills
## Skill: 代码审查助手
### 触发条件
当用户说"审查代码"、"代码审查"或"review code"时激活
### 执行步骤
1. 读取当前打开的文件或用户指定的文件
2. 检查以下方面:
- 代码风格一致性(命名规范、缩进等)
- 潜在bug(空指针、数组越界等)
- 性能问题(循环优化、数据库查询等)
- 安全性问题(SQL注入、XSS等)
- 代码重复和可维护性
3. 生成结构化的审查报告
### 输出格式
- 使用 Markdown 格式
- 按优先级分类(严重、警告、建议)
- 每个问题包含:位置、问题描述、建议修复方案
### 示例
用户:"审查这个 Controller"
AI 执行 Skill,返回审查报告
---
## Skill: API 文档生成器
### 触发条件
当用户说"生成API文档"、"API文档"时激活
### 执行步骤
1. 扫描项目中的 Controller 类
2. 提取:
- 路由路径
- HTTP 方法
- 请求参数(Query、Body、Header)
- 响应格式
- 状态码
3. 生成 Markdown 格式的 API 文档
4. 包含请求/响应示例
### 输出格式
# API 文档
## GET /api/users
**描述**: 获取用户列表
**参数**:
- page (int, optional): 页码
**响应**:
{
"data": [...],
"total": 100
}
当用户说"生成迁移"、"数据库迁移"时激活
#### 步骤 2:定义 Skill 的详细结构 一个规范的 Skill 定义模板: ## Skill: [技能名称] ### 描述 简要说明这个 Skill 的用途 ### 触发条件 - 关键词列表 - 或者特定文件类型 - 或者特定上下文 ### 前置条件 - 需要哪些文件存在 - 需要什么环境配置 ### 执行流程 1. 第一步:做什么 2. 第二步:做什么 3. ... ### 输出要求 - 格式要求 - 包含哪些信息 - 如何组织 ### 约束和限制 - 不做什么 - 避免什么 - 特殊情况处理 ### 示例对话 用户:"[触发语句]" AI:"[预期响应]"
方法 A:自动激活(推荐)
方法 B:显式调用
测试示例:
你:"审查代码" AI:[应该按照 Skill 定义的步骤执行,返回审查报告] 你:"生成API文档" AI:[应该扫描 Controller 并生成文档]
如果 Skill 执行不符合预期:
假设你要创建一个"错误处理助手" Skill:
## Skill: 错误处理助手 ### 描述 自动为代码添加完善的错误处理和日志记录 ### 触发条件 - "添加错误处理" - "完善异常处理" - "添加 try-catch" ### 执行流程 1. 识别当前代码中的潜在异常点: - 数据库操作 - 文件 I/O - 网络请求 - 空值访问 2. 为每个异常点添加: - try-catch 块 - 适当的异常类型捕获 - 日志记录(使用项目中的日志框架) - 用户友好的错误消息 - 错误码(如果项目有错误码体系) 3. 保持原有代码逻辑不变 4. 遵循项目的错误处理规范 ### 输出要求 - 代码中直接添加错误处理 - 在代码上方添加注释说明错误处理逻辑 - 使用项目统一的日志格式 ### 约束 - 不要改变原有业务逻辑 - 不要过度捕获异常(避免捕获 Exception) - 保持代码可读性 ### 示例 用户:"为这个 Service 方法添加错误处理" AI:[分析代码,添加适当的 try-catch 和日志]
1. 创建 .cursorrules 文件 ↓ 2. 定义 Skill(名称、触发、步骤、输出) ↓ 3. 保存文件(Cursor 自动加载) ↓ 4. 在对话中使用触发词 ↓ 5. AI 按照 Skill 定义执行 ↓ 6. 检查结果,优化 Skill 定义 ↓ 7. 重复使用和改进
.cursorrules 文件位置:项目根目录 文件格式:纯文本,支持 Markdown 加载时机:创建或修改后,Cursor 会自动读取(可能需要重启) 多个 Skills:可以在同一文件中定义多个,用 --- 分隔 优先级:更具体的 Skill 定义会优先匹配
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。