Mac版Codex本地插件创建教程:自定义plugin.json结构详解【教程】

夏宇姑娘_8579

夏宇姑娘_8579

2026-06-17

423人浏览

原创

Codex插件加载失败的根本原因是plugin.json字段不合规:必须严格满足required字段、语义化version、合法name格式、显式声明skills路径、正确配置assets和mcpServers相对路径。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

mac版codex本地插件创建教程:自定义plugin.json结构详解【教程】

你想让 Codex 在本地加载一个自己写的插件,但 plugin.json 总是报错、不被识别、或者装上去没图标没技能——根本原因往往就藏在 plugin.json 的字段写法里。这个文件不是随便填几个键值对就能跑起来的 JSON,它必须严格匹配 Codex CLI 的解析规则,少一个 required 字段、多一个非法 key、路径写错斜杠方向,插件就会静默失败。

确认插件根目录和基础结构

在终端中进入你准备存放插件的目录,比如 ~/plugins/my-first-plugin;【必须确保该目录下没有 package.json 或 node_modules】,否则 Codex CLI 会误判为 npm 包而跳过扫描。

创建 .codex-plugin 子目录:mkdir -p .codex-plugin

在这个子目录里新建 plugin.json 文件:touch .codex-plugin/plugin.json

plugin.json 必填字段与格式规范

打开 .codex-plugin/plugin.json,用 VS Code 或其他纯文本编辑器粘贴以下最小合法结构:

{
  "name": "my-first-plugin",
  "description": "A minimal working plugin",
  "version": "0.1.0",
  "author": {"name": "You"},
  "license": "MIT"
}

注意:name 字段只能含小写字母、数字、连字符(-),不能有空格或下划线;【version 必须是语义化版本格式 x.y.z,写成 0.1 或 1 不会被接受】。

保存后,在终端运行 codex plugins list,如果看到 my-first-plugin 出现在列表中且状态为 “enabled”,说明 plugin.json 基础结构已通过校验。

添加技能入口:skills 路径必须显式声明

如果你的插件包含技能(即 skills/**/SKILL.md),必须在 plugin.json 中显式声明 skills 字段,不能依赖默认路径。

方法一:单个技能目录
在 plugin.json 的根对象里追加一行: "skills": ["skills/"]

方法二:多个技能目录
写成数组形式:"skills": ["skills/", "extra-skills/"]

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载

【Codex 不会自动扫描 skills/ 目录,不写 skills 字段 = 技能完全不可见】。即使 SKILL.md 文件存在且格式正确,也不会被加载。

图标与资产路径配置

第一步:把 icon.png 放到插件根目录(不是 .codex-plugin 下)

第二步:在 plugin.json 中添加 assets 字段:
"assets": { "icon": "icon.png" }

第三步:确保 icon.png 是 128×128 像素、PNG 格式、无透明通道(部分 macOS 渲染器对 alpha 通道支持不稳定)

这一步操作起来很简单,直接把文件拖进去就行。但如果你用 Sketch 或 Figma 导出带透明底的 PNG,图标在 Codex App 里可能显示为全黑或空白。

关联 MCP Server 的正确写法

第一步:在插件根目录创建 .mcp.json 文件

第二步:确保 .mcp.json 内容是合法 JSON 对象,至少含 name 和 endpoint 字段,例如:
{ "name": "my-mcp", "endpoint": "http://localhost:8080" }

第三步:回到 plugin.json,在根对象中添加字段:
"mcpServers": ".mcp.json"

【mcpServers 字段值必须是相对插件根目录的路径字符串,不能是数组,不能带前导 ./】。写成 "./.mcp.json" 或 ["./.mcp.json"] 都会导致 MCP 服务注册失败。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

codex js json figma

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Codex AI 编程代理与智能开发工作流
Codex AI 编程代理与智能开发工作流

Codex 是一款超越传统代码生成的 AI 编程代理,致力于构建全生命周期的智能开发工作流。通过持久线程保留上下文,支持多智能体并行协作与后台自动化运维。借助沙箱权限控制、Plan/Steer 任务管理机制,Codex 既能自主拆解并执行复杂工程任务,又能让开发者牢牢掌控项目进程。从需求分析、编码测试到代码审查与部署,Codex 将 AI 深度融入研发全链路,极大提升了软件工程的交付效率与质量标准。

2026.05.26

614

10

Codex API集成与AI编程生态开发
Codex API集成与AI编程生态开发

Codex API 集成是构建下一代 AI 编程生态的核心基石,能通过 API 将强大的代码生成与推理能力无缝接入 VS Code、JetBrains 等主流 IDE 插件,还能将其深度嵌入 CI/CD 流水线,实现自动化的代码审查、单元测试生成与 Bug 修复。结合 Amazon Bedrock 等云平台的托管服务,企业可以灵活打造符合内部安全规范的专属 AI 编程助手。

2026.05.26

244

10

Codex 模型原理与AI软件工程进阶
Codex 模型原理与AI软件工程进阶

Codex 是基于通用大模型底座,通过海量代码语料与真实 Pull Request 进行专项微调的代码专用模型,能深度理解代码语法树与跨文件依赖,实现从自然语言到高质量工程代码的精准转化。在 AI 软件工程进阶中,Codex 推动了从提示词工程向“驾驭工程(Harness Engineering)”的范式跃迁。

2026.05.26

197

10

Codex AI编程工具新手指南
Codex AI编程工具新手指南

全面解析Codex AI编程工具的核心原理、功能特点与实际用途,提供适合新手的Codex入门教程、环境配置方法、代码生成演示与常见问题解答,帮助开发者快速掌握AI自动写代码能力,提升编程学习与开发效率。

2026.05.27

410

10

Codex Agent编程与自主开发能力调优专题
Codex Agent编程与自主开发能力调优专题

PHP中文网为您提供Codex Agent编程与自主开发能力调优专题。针对AI Agent全权委托开发模式,我们为您系统梳理了Harness Engineering(驾驭工程)核心理念,以及涵盖AGENTS.md规范编写、Skills技能配置、Worktree沙盒隔离与多Agent协作架构的实战指南。

2026.06.10

248

7

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

80

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

40

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

40

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

20

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Codex 应用程序简介
Codex 应用程序简介

共0课时 | 173人学习

Codex官方文档
Codex官方文档

共0课时 | 0人学习

安装 Xdebug 并配置 phpstorm
安装 Xdebug 并配置 phpstorm

共1课时 | 192人学习