@bgerona/opencode-mxcli-readme
v1.0.0
Published
opencode plugin — mxcl-style README skill, rewritten for opencode schema compliance
Maintainers
Readme
mxcli-readme
Rewrite of mxcl/skills (mxcl-readme) as an opencode plugin.
The original SKILL.md carries instructions and agent metadata through unsupported
frontmatter fields that opencode silently ignores. This rewrite strips those fields,
replaces them with compliant name, description, allowed-tools, and metadata
frontmatter, and injects explicit Initialization Protocols into the skill body
so opencode agents are always directed to follow the prescribed workflow — even
without a global ruleset.
Structure
mxcli-readme/
├── references/
│ └── mxcl-skills/ # upstream clone (gitignored)
├── src/
│ ├── index.ts # plugin entry (registers skills path + rules)
│ ├── README.md # mxcl-style README tailored for opencode agents
│ └── skills/
│ └── opencode-mxcl-readme/
│ ├── SKILL.md # the skill (schema-compliant frontmatter)
│ ├── references/
│ │ └── style.md # mxcl README style guide
│ └── rules/
│ └── Initiation_Protocols.md
├── package.json
└── .gitignoreWhat Changed
| Original field | Status |
|----------------------|---------------------|
| name | Kept (required) |
| description | Rewritten for opencode trigger keywords |
| agent: autopilot | Removed (unsupported — opencode ignores it) |
| allowed-tools | Added (documentation convention) |
| metadata | Added (schema URL, source) |
| In-body instructions | Expanded with "## Initialization Protocols" section |
Register
Add to your opencode.json:
{
"plugin": ["/path/to/mxcli-readme"]
}Or symlink the skill directly:
ln -sf /path/to/mxcli-readme/src/skills/opencode-mxcl-readme \
~/.config/opencode/skills/opencode-mxcl-readmeRequires opencode ^1.0.0.
