docs: add plugin manifest validation notes

This commit is contained in:
Graceme Kamei
2026-01-29 12:34:58 +05:30
committed by GitHub
parent e3a1306369
commit 04ee20827c

5
.claude-plugin/README.md Normal file
View File

@@ -0,0 +1,5 @@
### Plugin Manifest Gotchas
If you plan to edit `.claude-plugin/plugin.json`, be aware that the Claude plugin validator enforces several **undocumented but strict constraints** that can cause installs to fail with vague errors (for example, `agents: Invalid input`). In particular, component fields must be arrays, `agents` must use explicit file paths rather than directories, and a `version` field is required for reliable validation and installation.
These constraints are not obvious from public examples and have caused repeated installation failures in the past. They are documented in detail in `.claude-plugin/PLUGIN_SCHEMA_NOTES.md`, which should be reviewed before making any changes to the plugin manifest.