Create README.md

[pangerlkr]

Summary by CodeRabbit

• Documentation
  • Added comprehensive plugin manifest validation constraints documentation detailing undocumented requirements enforced by the plugin validator, including component field array specifications, agent file path requirements, and mandatory version field declarations. This guidance helps developers avoid validation failures and better understand plugin configuration constraints.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

A new documentation section titled "Plugin Manifest Gotchas" was added to .claude-plugin/README.md, documenting undocumented constraints enforced by the Claude plugin validator: component fields must be arrays, agents require explicit file paths, and a version field is mandatory. The section directs users to review detailed schema notes before making changes.

Changes

Cohort / File(s)	Summary
Documentation – Plugin Manifest Guide \.claude-plugin/README.md	Added "Plugin Manifest Gotchas" section documenting validator constraints: arrays required for components, explicit paths required for agents, version field mandatory. Includes cross-reference to schema notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Fix plugin manifest validation errors #75: Implemented manifest validation fixes (converted agents field structure and tools to arrays, added version field) that directly correspond to the constraints now documented in this README update.

Poem

🐰 A note for those who tinker with schemas,
Beware the gotchas in your plugin dreams!
Arrays and paths and versions you'll need,
Read the warnings, avoid the misdeed. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The PR title 'Create README.md' is vague and generic. While a README.md file is modified, the title doesn't capture the substantive change: adding documentation about plugin manifest constraints and validation gotchas.	Revise the title to be more specific about the actual content added, such as 'Add plugin manifest validation documentation to .claude-plugin/README.md' or 'Document Claude plugin validator constraints in README.'

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}