用途
Plugin Creator 是一个 Agent Skill,用于在 Codex 项目中快速创建和脚手架化插件目录。它帮助开发者生成符合规范的插件基础结构,减少手动创建文件和配置的工作量。
主要能力
- 生成插件根目录,默认位于
<repo_root>/plugins/<plugin-name>/。 - 始终创建
.codex-plugin/plugin.json清单文件,包含完整 schema 结构、占位符值和完整的 interface 部分。 - 可选创建配套文件夹和文件:
skills/hooks/scripts/assets/.mcp.json.app.json
- 可选生成或更新仓库级 marketplace 条目,文件位于
<repo-root>/.agents/plugins/marketplace.json。 - 自动规范化插件名称:转为小写、连字符分隔、合并连续连字符,且长度不超过 64 字符。例如 "My Plugin" → "my-plugin","My--Plugin" → "my-plugin"。
- 生成的文件夹名与 plugin.json 中的 name 始终一致。
使用方式
-
运行脚手架脚本(从仓库根目录执行):
python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py <plugin-name>默认在
<repo_root>/plugins/<plugin-name>下创建插件。 -
打开
<plugin-path>/.codex-plugin/plugin.json,替换[TODO: ...]占位符。 -
如需生成或更新 marketplace 条目:
python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py my-plugin --with-marketplacemarketplace 文件始终位于
<repo-root>/.agents/plugins/marketplace.json。 -
如需生成可选配套文件夹:
python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py my-plugin --path <parent-plugin-directory> \ --with-skills --with-hooks --with-scripts --with-assets --with-mcp --with-apps --with-marketplace<parent-plugin-directory>是插件文件夹<plugin-name>将被创建的父目录(例如~/code/plugins)。 -
使用
--force仅在有意替换同名插件的现有 marketplace 条目或覆盖现有文件时。
Marketplace 工作流
- marketplace.json 固定位于
<repo-root>/.agents/plugins/marketplace.json。 - 根元数据支持顶层
name和可选的interface.displayName。 plugins[]中的顺序视为 Codex 中的渲染顺序,默认追加新条目。displayName位于 marketplace 的 interface 对象内,而非单个插件条目中。- 每个生成的 marketplace 条目必须包含:
policy.installation(默认"AVAILABLE")policy.authentication(默认"ON_INSTALL")category
- 允许的
policy.installation值:NOT_AVAILABLE、AVAILABLE、INSTALLED_BY_DEFAULT。 - 允许的
policy.authentication值:ON_INSTALL、ON_USE。 policy.products仅在用户明确要求产品门控时添加。- 生成的条目结构示例:
{ "name": "plugin-name", "source": { "source": "local", "path": "./plugins/plugin-name" }, "policy": { "installation": "AVAILABLE", "authentication": "ON_INSTALL" }, "category": "Productivity" } - 若 marketplace 文件不存在,则先创建包含顶层
name、interface.displayName和plugins数组的新文件。
适用场景
- 需要为 Codex 快速搭建插件项目骨架。
- 需要保持多个插件目录结构一致。
- 需要自动生成或更新 marketplace 条目。
限制
- 生成的清单值默认为占位符,需人工或后续步骤填充。
- 插件名称会强制规范化,不能保留原样中的空格、下划线或大写字母。
- 使用
--force会覆盖现有文件或 marketplace 条目,需谨慎。 - 不提供插件功能的具体实现,仅生成结构框架。
- 具体收费、平台支持范围等暂未提供。