-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
component:skillSkills layerSkills layereffort:medium1-4 hours1-4 hourspriority:mediumShould be addressedShould be addressedrefactorCode restructuring without behavior changeCode restructuring without behavior change
Description
Summary
Three skills exceed the recommended word count for SKILL.md files. Per the skill-development best practices:
Target: 1,500-2,000 words for the SKILL.md body. Move detailed content to references/.
Progressive disclosure ensures SKILL.md stays lean (loaded when skill triggers) while detailed content lives in references/ (loaded as needed).
Current Word Counts
| Skill | Current Words | Target | Over By |
|---|---|---|---|
command-development |
~2,800 | ~2,000 | ~800 |
hook-development |
~2,500 | ~2,000 | ~500 |
mcp-integration |
~2,200 | ~1,800 | ~400 |
Skills within target (no changes needed):
agent-development: ~1,438 ✅skill-development: ~1,600 ✅plugin-structure: ~2,000 ✅plugin-settings: ~2,100 (acceptable)
Recommended Content Migrations
command-development (~2,800 → ~2,000)
Move to references/:
- "Common Patterns" section →
references/common-patterns.md - "Troubleshooting" section →
references/troubleshooting.md - Detailed bash execution examples →
references/bash-execution.md
hook-development (~2,500 → ~2,000)
Move to references/:
- "Temporarily Active Hooks" section → merge into existing
references/patterns.md - Detailed event-specific JSON examples →
references/event-examples.md - "Hook Lifecycle and Limitations" →
references/lifecycle.md
mcp-integration (~2,200 → ~1,800)
Move to references/:
- "Performance Considerations" →
references/performance.md - "Debugging" section →
references/debugging.md - Detailed authentication patterns (already good coverage in references)
Implementation Notes
- Keep core concepts and quick reference in SKILL.md
- Move detailed examples and edge cases to references/
- Add clear pointers in SKILL.md: "For detailed patterns, see
references/patterns.md" - Ensure no content is lost—just relocated
- Update "Additional Resources" section to reflect new reference files
Acceptance Criteria
-
command-development/SKILL.mdreduced to ~2,000 words -
hook-development/SKILL.mdreduced to ~2,000 words -
mcp-integration/SKILL.mdreduced to ~1,800 words - All moved content exists in appropriate reference files
- SKILL.md files include pointers to new reference files
- No information loss—content relocated, not deleted
Benefits
- Faster skill loading (less content to process when skill triggers)
- Better context efficiency (detailed content loaded only when needed)
- Follows official progressive disclosure pattern
- Aligns with plugin-dev's own best practices
References
- skill-development SKILL.md - Progressive disclosure guidance
- Official Skills Docs - Supporting files section
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
component:skillSkills layerSkills layereffort:medium1-4 hours1-4 hourspriority:mediumShould be addressedShould be addressedrefactorCode restructuring without behavior changeCode restructuring without behavior change