Skip to content

Comments

Create PLUGIN_SCHEMA_NOTES.md#93

Merged
affaan-m merged 1 commit intoaffaan-m:mainfrom
pangerlkr:patch-3
Jan 27, 2026
Merged

Create PLUGIN_SCHEMA_NOTES.md#93
affaan-m merged 1 commit intoaffaan-m:mainfrom
pangerlkr:patch-3

Conversation

@pangerlkr
Copy link
Contributor

@pangerlkr pangerlkr commented Jan 27, 2026

This PR documents and stabilizes the Claude Code plugin manifest schema based on real validator behavior observed in Issue #90.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive reference guide for Claude Code plugin manifest validation
    • Covers required fields, field shape rules, path resolution requirements, validator behavior, and common anti-patterns
    • Includes minimal valid example and recommendations for plugin contributors

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

This PR documents and stabilizes the Claude Code plugin manifest schema based on real validator behavior observed in Issue affaan-m#90.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 27, 2026

📝 Walkthrough

Walkthrough

Adds a new documentation file detailing the undocumented constraints and validation rules enforced by the Claude Code plugin manifest validator, including required fields, shape rules, path resolution requirements, and common failure patterns.

Changes

Cohort / File(s) Summary
Documentation
.claude-plugin/PLUGIN_SCHEMA_NOTES.md
New file documenting plugin manifest validator constraints, required fields, validation behavior, anti-patterns, and minimal valid examples

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc in the warren, so neat and so clear,
Listing all validator rules that plugins hold dear,
Fields that must be, and paths that align,
Schema constraints in markdown divine! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly matches the main change: adding a new documentation file PLUGIN_SCHEMA_NOTES.md. It accurately summarizes the primary change in the changeset.
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

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

@pangerlkr
Copy link
Contributor Author

Summary

This PR documents and stabilizes the Claude Code plugin manifest schema based on real validator behavior observed in Issue #90.

Background

Issue #90 exposed that the Claude plugin manifest validator enforces several undocumented constraints, most notably:

  • agents, commands, and skills must be arrays (strings are rejected)
  • agents cannot use directory paths and must enumerate explicit files
  • A version field is required for reliable validation and installation

These rules are not obvious from existing examples and result in vague validation errors such as agents: Invalid input.

What This PR Does

Why This Matters

This repository is widely forked and used as a reference implementation.
Making validator constraints explicit:

  • Prevents repeated installation failures
  • Reduces contributor confusion
  • Improves long-term plugin stability as the ecosystem evolves

Closes #90.

@pangerlkr pangerlkr closed this Jan 27, 2026
@pangerlkr pangerlkr reopened this Jan 27, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.claude-plugin/PLUGIN_SCHEMA_NOTES.md:
- Around line 160-164: Update the example CLI invocation in
.claude-plugin/PLUGIN_SCHEMA_NOTES.md to use the official syntax "claude plugin
validate ." and note it should be run from the plugin root directory instead of
specifying the .claude-plugin/plugin.json path; replace the existing line
`claude plugin validate .claude-plugin/plugin.json` with the corrected command
and a brief comment that it runs from the plugin root.
🧹 Nitpick comments (1)
.claude-plugin/PLUGIN_SCHEMA_NOTES.md (1)

1-10: Consider adding a reference to Issue #90 for context.

Since this documentation is based on the validator behavior reported in Issue #90, consider adding a brief reference or link to that issue in the introduction. This would help future readers understand the origin of these constraints and provide a trail for additional context if needed.

📝 Optional addition
 # Plugin Manifest Schema Notes
 
-This document captures **undocumented but enforced constraints** of the Claude Code plugin manifest validator.
+This document captures **undocumented but enforced constraints** of the Claude Code plugin manifest validator.
+
+> Based on validator behavior observed in [Issue `#90`](https://github.com/affaan-m/everything-claude-code/issues/90)
 
 These rules are based on real installation failures, validator behavior, and comparison with known working plugins.

@affaan-m affaan-m merged commit 5dc1edb into affaan-m:main Jan 27, 2026
2 checks passed
moyueheng added a commit to moyueheng/everything-claude-code that referenced this pull request Jan 29, 2026
675db95 feat: unify commands and skills (v1.2.0)
ca584e2 fix: escape pipe in markdown table for markdownlint
a44a055 fix: resolve ESLint errors and update tests for project-name fallback
c9ef02b docs: add requirements section and hooks field warning
0c53ad8 Revert "docs: update shorthand to shortform terminology"
c3430bd docs: add Traditional Chinese translation
fbe2e56 docs: add simplified Chinese README
7c0bc25 feat: add comprehensive CI/CD pipeline
58a97c8 docs: update shorthand to shortform terminology
04ee208 docs: add plugin manifest validation notes
e3a1306 fix: remove duplicate hooks declaration from plugin.json
81003b1 feat: use project name as session filename fallback
8996303 fix: prevent command injection in Prettier hook (affaan-m#102)
8894e1b docs: update README with skill-create and instinct commands
9bc587a feat: add skill-create and continuous-learning-v2 commands
0ced59a Merge pull request affaan-m#91 from Hor1zonZzz/fix/readme-rules-limitation
2563d1e Merge pull request affaan-m#92 from jhsong-musinsa/fix/plugin-manifest-validation
5dc1edb Merge pull request affaan-m#93 from pangerlkr/patch-3
2aac2d9 Create PLUGIN_SCHEMA_NOTES.md
cdf987d fix: use explicit file paths for agents in plugin.json
384b255 docs: add note about rules limitation in plugin installation
accbb47 feat: add proper header banner to shortform guide
ff67b03 feat: add images and rename guides to the-shortform-guide.md and the-longform-guide.md
7fc5ef1 Merge pull request affaan-m#83 from msyahidin/claude/add-golang-support-frw0Z
779085e fix: add missing agents and hooks declarations to plugin.json
5e1835a Merge pull request affaan-m#81 from pangerlkr/patch-2
2abefe6 Merge pull request affaan-m#79 from pangerlkr/patch-1
4bca615 Merge pull request affaan-m#80 from lichengzhe/fix/stop-hook-shell-error
a1f47f1 Merge pull request affaan-m#85 from roeiba/add-license-file
01ad21b docs: add missing MIT LICENSE file
c6c32cd fix: add language labels to fenced code blocks for MD040 compliance
75e1e46 feat: add comprehensive Golang language support
2feac5a docs: add The Longform Guide to Everything Claude Code
a0b84f7 Fix: Move Stop hook inline code to separate script file
1564213 docs: add The Shorthand Guide to Everything Claude Code
56ff5d4 fix: use correct unscoped agent-browser package name (affaan-m#77)
5c63fa9 feat: v1.1.0 release - session ID tracking, async hooks, new skills
5670fcd Fix plugin manifest validation errors (affaan-m#75)
1c9fa0b Add hooks.md to documentation index (affaan-m#40)
2bfd2fb feat: add cloud infrastructure security skill (affaan-m#44)
fae9716 feat(agents): add database-reviewer agent with Supabase patterns (affaan-m#48)
a2087a8 fix: remove unnecessary .sh hooks (affaan-m#41)
b9b7831 fix: multiple community-reported issues
660e0d3 fix: security and documentation fixes
a7bc5f2 revert: remove hooks declaration - auto-loaded by convention
22ad036 fix: add hooks declaration to plugin.json for proper hook loading
5230892 fix: remove version fields from marketplace.json
970f8bf feat: cross-platform support with Node.js scripts
4ec7a6b fix: remove version field to enable automatic plugin updates
0d438dd style: side-by-side guide layout matching profile README
7f4f622 feat: add star history chart and minimal badge bar
c3f1594 fix: move session-end hooks from Stop to SessionEnd
19345df fix: remove duplicate hooks field from plugin.json
73bda1a fix: use ${CLAUDE_PLUGIN_ROOT} for hook script paths
ecfbbd3 fix: use relative path './' for plugin source instead of GitHub object
ee5affb fix: remove agents field temporarily to debug validation
d362ae6 fix: use string format for repository field in plugin.json
9e8006c fix: use GitHub source object in marketplace.json
5010f82 feat: package as Claude Code plugin with marketplace distribution
4491f15 Clarify README description of the repository
e6440d3 docs: restructure README to flow shorthand → longform guides together
fa0928a Enhance README with update section and resources
2d6fd70 feat: add strategic-compact hook and update hooks.json with all hooks
f96ef1e feat: add memory persistence hooks and context files
7d3ea0f feat: add strategic compact skill
6bf102d feat: add continuous learning skill with session examples
3c1e7d9 Clarify repository purpose and additional resources
62a80df Update README with image and guide link
6eefb41 Update README with guide reading reminder
d7cf890 Fix formatting in README.md for guide link
e57979c Update README with image and guide link
45959c3 Initial release: Complete Claude Code configuration collection
REVERT: 69c0b1a Add link to Agent Skills specification website (affaan-m#160)
REVERT: be229a5 Fix links in agent skills specification (affaan-m#159)
REVERT: f232228 Split agent-skills-spec into separate authoring and client integration guides (affaan-m#148)
REVERT: 0075614 Add doc-coauthoring skill and update example skills (affaan-m#134)
REVERT: ef74077 Move example skills into dedicated folder and create minimal top-level folder structure (affaan-m#129)
REVERT: 0f77e50 Update example skills and rename 'artifacts-builder' (affaan-m#112)
REVERT: e5c6015 Add 'frontend-design' example skill (affaan-m#98)
REVERT: c74d647 Clarify Claude Code installation in README.md (#20)
REVERT: 0877bae Updates to README.md (affaan-m#9)
REVERT: b118d29 Add Claude Claude instructions to the readme (#8)
REVERT: 4d1e3f3 Add Claude Code Marketplace (affaan-m#5)
REVERT: 9b61003 Small tweak to blog link (#7)
REVERT: 10e0fbe Add initial Agent Skills Spec (#2)
REVERT: ec84104 Add 3rd Party notices (affaan-m#4)
REVERT: 67ada86 Adding more details to README (affaan-m#3)
REVERT: 83291af Reorganize the example skills (affaan-m#1)
REVERT: 37292f3 init repo

git-subtree-dir: upstream/anthropics-skills
git-subtree-split: 675db95
charlesbmi pushed a commit to charlesbmi/everything-claude-code that referenced this pull request Jan 29, 2026
524y added a commit to 524y/everything-claude-code-japanese that referenced this pull request Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants