mcpField
C
create-plugin-scaffold

create-plugin-scaffold

github.com/cursor开发14.5k1.2k 次安装今天更新
代码仓库

关于 create-plugin-scaffold

Create plugin scaffold 是一项用于生成 Cursor 插件结构的技能，依据名称、用途、组件和仓库类型等输入创建文件。它还会检查清单路径，供本地使用或提交至市场。

主要功能

  1. 01验证插件命名格式
  2. 02创建插件基础文件
  3. 03生成带 frontmatter 的组件文件
  4. 04按需添加市场条目
  5. 05检查清单路径

适用场景

  1. 01搭建新的本地 Cursor 插件
  2. 02准备将插件提交至市场
  3. 03按所选组件类型创建插件

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/cursor/plugins --skill create-plugin-scaffold

安装后在 Claude Code 中输入/create-plugin-scaffold确认已加载。

详细介绍

创建插件脚手架

触发条件

你需要从头创建一个新的 Cursor 插件，并使其可以在本地使用或提交到市场。

必需输入

  • 插件名称（小写 kebab-case）
  • 插件用途和目标用户
  • 要包含的组件集合（rules、skills、agents、commands、hooks、mcpServers）
  • 仓库风格（single-plugin 或 multi-plugin marketplace）

输出位置

默认情况下，在用户的本地插件目录中创建插件：

~/.cursor/plugins/local/<plugin-name>/

此路径会让 Cursor 无需安装步骤即可立即使用该插件。如果用户明确要求在其他位置创建插件（例如现有仓库或指定目录中），则应遵从其选择。

工作流

  1. 验证插件名称格式：小写 kebab-case，且以字母或数字开头和结尾。
  2. 确定目标目录：
    • 默认：~/.cursor/plugins/local/<plugin-name>/
    • 覆盖：如果用户指定了路径，则使用该路径。
    • 如果目录不存在，则创建该目录（及其父目录）。
  3. 在目标目录中创建基础文件：
    • .cursor-plugin/plugin.json
    • README.md
    • LICENSE
    • 可选的 CHANGELOG.md
  4. 填写 plugin.json：
    • 必需：name
    • 建议填写：version、description、author、license、keywords
    • 仅在需要非默认发现机制时，才添加明确的组件路径。
  5. 创建包含有效 frontmatter 的组件文件：
    • 规则：.mdc 文件，包含 description、alwaysApply，以及可选的 globs
    • 技能：skills/<skill-name>/SKILL.md，包含 name、description
    • Agent：agents/*.md，包含 name、description
    • 命令：commands/*.(md|txt)，包含 name、description
  6. 如果仓库使用 .cursor-plugin/marketplace.json，则添加插件条目：
    • name
    • source
    • 可选元数据（description、keywords、category、tags）
  7. 确保所有清单路径均为相对路径、有效，且不使用绝对路径或父目录遍历。

注意事项

  • 让插件专注于一个用例。
  • 技能和规则文本应简洁且可操作，避免冗长的说明。
  • 不要引用不存在的文件。
  • 除非需要自定义路径，否则使用文件夹发现默认设置。
  • 除非用户提供其他路径，否则始终保存到 ~/.cursor/plugins/local/<plugin-name>/。

输出

  • 插件的文件树（包含输出目录的完整路径）
  • 最终的 plugin.json
  • 市场条目（如适用）
  • 必需字段和组件元数据的简短验证报告
  • 确认插件已保存在 ~/.cursor/plugins/local/ 下并可立即使用

评论

支持 Markdown