Plugin Validator Error Code Reference

Plugin Validator Error Code Reference

This document provides detailed explanations, examples, and fixes for all error codes emitted by the plugin-validator tool.

Quick Navigation:

• Frontmatter Errors (FM001-FM010)
• Skill Errors (SK001-SK007)
• Link Errors (LK001-LK002)
• Progressive Disclosure (PD001-PD003)
• Plugin Errors (PL001-PL005)

Frontmatter Errors

FM001

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Missing required field (name, description)

When It Occurs: The frontmatter is missing a required field based on the file type:

• Agents: name and description are required
• Commands: description is required
• Skills: No fields are strictly required, but name and description are strongly recommended

Example (Bad):

---
model: sonnet
---

Fix:

---
name: my-agent
description: Agent for processing files
model: sonnet
---

Related Validators: FrontmatterValidator

FM002

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Invalid YAML syntax

When It Occurs: The frontmatter block contains invalid YAML syntax that cannot be parsed.

Example (Bad):

---
name: my-skill
description: This is a skill: but the colon breaks YAML
tools: [Read, Write  # Missing closing bracket
---

Fix:

---
name: my-skill
description: "This is a skill: colons in quotes are safe"
tools: Read, Write
---

Common YAML Pitfalls:

• Unquoted strings with colons (except URLs)
• Mismatched brackets or quotes
• Incorrect indentation
• Tab characters (use spaces only)

Related Validators: FrontmatterValidator

FM003

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Frontmatter not closed with ---

When It Occurs: The frontmatter block starts with --- but is not properly closed with a second ---.

Example (Bad):

---
name: my-skill
description: My skill description

# Content starts here

Fix:

---
name: my-skill
description: My skill description
---

# Content starts here

Related Validators: FrontmatterValidator

FM004

Severity: Warning Auto-Fixable: Yes Category: Frontmatter

Description: Forbidden multiline indicator (>-, |-)

When It Occurs: The frontmatter uses YAML multiline string indicators (>-, |-), which are not supported by Claude Code's frontmatter parser.

Example (Bad):

---
name: my-skill
description: >-
  This is a multiline
  description using YAML folded style
---

Fix (Auto-Fixed):

---
name: my-skill
description: "This is a multiline description using YAML folded style"
---

Why It's Forbidden: Claude Code's frontmatter parser expects simple key-value pairs, not YAML's advanced multiline syntax.

Related Validators: FrontmatterValidator

FM005

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Field type mismatch (expected string/bool)

When It Occurs: A frontmatter field has a value of the wrong type (e.g., boolean when string expected, number when string expected).

Example (Bad):

---
name: my-skill
description: 12345  # Number instead of string
user-invocable: yes  # String instead of boolean
---

Fix:

---
name: my-skill
description: "12345"  # String
user-invocable: true  # Boolean
---

Field Types:

• name: string
• description: string
• model: string (must be one of: sonnet, opus, haiku, inherit)
• tools: string (comma-separated)
• skills: string (comma-separated)
• user-invocable: boolean (true/false)

Related Validators: FrontmatterValidator

FM006

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Invalid field value (model not in enum)

When It Occurs: A field with a constrained set of valid values contains an invalid value.

Example (Bad):

---
name: my-agent
description: My agent
model: gpt-4  # Invalid model
---

Fix:

---
name: my-agent
description: My agent
model: sonnet  # Valid: sonnet, opus, haiku, inherit
---

Valid model Values:

• sonnet - Claude 3.5 Sonnet (default)
• opus - Claude 3 Opus
• haiku - Claude 3 Haiku
• inherit - Use parent's model

Related Validators: FrontmatterValidator

FM007

Severity: Warning Auto-Fixable: Yes Category: Frontmatter

Description: Tools field is YAML array (not CSV string)

When It Occurs: The tools field is specified as a YAML array instead of a comma-separated string.

Example (Bad):

---
name: my-agent
description: My agent
tools:
  - Read
  - Write
  - Grep
---

Fix (Auto-Fixed):

---
name: my-agent
description: My agent
tools: Read, Write, Grep
---

Why It's Wrong: Claude Code's frontmatter parser expects comma-separated strings, not YAML arrays.

Related Validators: FrontmatterValidator

FM008

Severity: Warning Auto-Fixable: Yes Category: Frontmatter

Description: Skills field is YAML array (not CSV string)

When It Occurs: The skills field is specified as a YAML array instead of a comma-separated string.

Example (Bad):

---
name: my-agent
description: My agent
skills:
  - python3-development
  - holistic-linting
---

Fix (Auto-Fixed):

---
name: my-agent
description: My agent
skills: python3-development, holistic-linting
---

Related Validators: FrontmatterValidator

FM009

Severity: Warning Auto-Fixable: Yes Category: Frontmatter

Description: Unquoted description with colons

When It Occurs: The description field contains colons but is not quoted, which can cause YAML parsing issues.

Example (Bad):

---
name: my-skill
description: Use this when: processing files or analyzing code
---

Fix (Auto-Fixed):

---
name: my-skill
description: "Use this when: processing files or analyzing code"
---

Exception: URLs with colons (https://...) are safe without quotes when they appear at the end of a description.

Related Validators: FrontmatterValidator

FM010

Severity: Error Auto-Fixable: No Category: Frontmatter

Description: Name pattern invalid (not lowercase-hyphens)

When It Occurs: The name field does not match the required pattern: lowercase letters, numbers, and hyphens only.

Example (Bad):

---
name: My_Skill_Name
description: My skill
---

Fix:

---
name: my-skill-name
description: My skill
---

Valid Name Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$ or ^[a-z0-9]$

Rules:

• Only lowercase letters (a-z)
• Only numbers (0-9)
• Only hyphens (-) as separators
• Must start and end with alphanumeric character
• No underscores, spaces, or special characters
• Maximum 40 characters (for skill directory names)

Related Validators: FrontmatterValidator, NameFormatValidator

Skill Errors

SK001

Severity: Error Auto-Fixable: No Category: Skill

Description: Name contains uppercase characters

When It Occurs: The skill name field contains uppercase letters.

Example (Bad):

---
name: MySkillName
description: My skill
---

Fix:

---
name: my-skill-name
description: My skill
---

Why It Matters: Skill names are used in slash commands, which are case-sensitive and conventionally lowercase.

Related Validators: NameFormatValidator

SK002

Severity: Error Auto-Fixable: No Category: Skill

Description: Name contains underscores (use hyphens)

When It Occurs: The skill name uses underscores instead of hyphens.

Example (Bad):

---
name: my_skill_name
description: My skill
---

Fix:

---
name: my-skill-name
description: My skill
---

Why It Matters: Claude Code naming convention uses hyphens (kebab-case), not underscores (snake_case).

Related Validators: NameFormatValidator

SK003

Severity: Error Auto-Fixable: No Category: Skill

Description: Name has leading/trailing/consecutive hyphens

When It Occurs: The skill name has hyphens at the beginning or end, or multiple consecutive hyphens.

Example (Bad):

---
name: -my-skill-
description: My skill
---

# OR

---
name: my--skill
description: My skill
---

Fix:

---
name: my-skill
description: My skill
---

Related Validators: NameFormatValidator

SK004

Severity: Warning Auto-Fixable: No Category: Skill

Description: Description too short (minimum 20 characters)

When It Occurs: The skill description is shorter than the recommended minimum of 20 characters.

Example (Bad):

---
name: my-skill
description: A skill
---

Fix:

---
name: my-skill
description: "Use when processing files and analyzing code for quality issues"
---

Why It Matters: Short descriptions don't provide enough context for Claude to know when to use the skill.

Related Validators: DescriptionValidator

SK005

Severity: Warning Auto-Fixable: No Category: Skill

Description: Description missing trigger phrases

When It Occurs: The skill description doesn't contain any trigger phrases that indicate when the skill should be used.

Example (Bad):

---
name: my-skill
description: A skill that processes files and analyzes code
---

Fix:

---
name: my-skill
description: "Use this when processing files and analyzing code. Activate for quality checks and linting tasks."
---

Required Trigger Phrases (include at least one):

• "use when"
• "use this"
• "trigger"
• "activate"

Why It Matters: Trigger phrases help Claude understand the skill's activation conditions.

Related Validators: DescriptionValidator

SK006

Severity: Warning Auto-Fixable: No Category: Skill

Description: Token count exceeds 4000 (consider splitting)

When It Occurs: The skill body (excluding frontmatter) contains more than 4000 tokens (approximately 500 lines).

Example: (Large skill file with 4500 tokens)

Fix: Consider splitting the skill into smaller, focused skills:

Original: large-skill (4500 tokens)

Split into:
- large-skill-core (1500 tokens) - Core functionality
- large-skill-advanced (1500 tokens) - Advanced features
- large-skill-reference (1500 tokens) - Reference documentation

Why It Matters: Large skills consume Claude's context window and make skills harder to maintain.

Related Validators: ComplexityValidator

SK007

Severity: Error Auto-Fixable: No Category: Skill

Description: Token count exceeds 6400 (must split)

When It Occurs: The skill body contains more than 6400 tokens (approximately 800 lines).

Example: (Very large skill file with 7000 tokens)

Fix: Must split the skill - see SK006 for splitting strategy.

Why It Matters: Skills this large significantly impact Claude's performance and context window.

Related Validators: ComplexityValidator

Link Errors

LK001

Severity: Error Auto-Fixable: No Category: Links

Description: Broken internal link (file does not exist)

When It Occurs: A markdown link with a relative path (starting with ./) points to a file that doesn't exist.

Example (Bad):

See [the reference guide](./references/non-existent.md) for details.

Fix:

# Create the referenced file
mkdir -p references
touch references/non-existent.md

# OR update the link

See [the reference guide](./references/existing-file.md) for details.

Why It Matters: Broken links prevent users from accessing referenced documentation.

Related Validators: InternalLinkValidator

LK002

Severity: Warning Auto-Fixable: No Category: Links

Description: Link missing ./ prefix (not relative path)

When It Occurs: A markdown link to an internal file doesn't start with ./.

Example (Bad):

See [the reference guide](references/guide.md) for details.

Fix:

See [the reference guide](./references/guide.md) for details.

Why It Matters: Links without ./ prefix are ambiguous and may not resolve correctly in all contexts.

Related Validators: InternalLinkValidator

Progressive Disclosure

PD001

Severity: Info Auto-Fixable: No Category: Progressive Disclosure

Description: No references/ directory found

When It Occurs: The skill doesn't have a references/ directory for detailed documentation.

Example: Skill structure missing references/

my-skill/
├── SKILL.md
└── (no references/)

Fix:

mkdir -p my-skill/references
# Add detailed documentation files

Why It Matters: Progressive disclosure keeps SKILL.md focused while providing depth in separate files.

Related Validators: ProgressiveDisclosureValidator

PD002

Severity: Info Auto-Fixable: No Category: Progressive Disclosure

Description: No examples/ directory found

When It Occurs: The skill doesn't have an examples/ directory for example files.

Example: Skill structure missing examples/

Fix:

mkdir -p my-skill/examples
# Add example files demonstrating skill usage

Related Validators: ProgressiveDisclosureValidator

PD003

Severity: Info Auto-Fixable: No Category: Progressive Disclosure

Description: No scripts/ directory found

When It Occurs: The skill doesn't have a scripts/ directory for helper scripts.

Example: Skill structure missing scripts/

Fix:

mkdir -p my-skill/scripts
# Add helper scripts or tools

Related Validators: ProgressiveDisclosureValidator

Plugin Errors

PL001

Severity: Error Auto-Fixable: No Category: Plugin

Description: Missing plugin.json file

When It Occurs: The plugin directory doesn't contain a .claude-plugin/plugin.json file.

Example (Bad):

my-plugin/
├── skills/
└── (no .claude-plugin/plugin.json)

Fix:

mkdir -p my-plugin/.claude-plugin
cat > my-plugin/.claude-plugin/plugin.json << 'EOF'
{
  "name": "my-plugin",
  "version": "0.1.0",
  "description": "My plugin description",
  "skills": ["./skills/"],
  "agents": [],
  "commands": []
}
EOF

Related Validators: PluginStructureValidator

PL002

Severity: Error Auto-Fixable: No Category: Plugin

Description: Invalid JSON syntax in plugin.json

When It Occurs: The plugin.json file contains invalid JSON syntax.

Example (Bad):

{
  "name": "my-plugin",
  "version": "0.1.0",
  "skills": ["./skills/"]  // Comments not allowed in JSON
}

Fix:

{
  "name": "my-plugin",
  "version": "0.1.0",
  "skills": ["./skills/"]
}

Validation Command:

python3 -m json.tool .claude-plugin/plugin.json

Common JSON Errors:

• Trailing commas
• Comments (use // or /* */)
• Single quotes instead of double quotes
• Missing commas between fields

Related Validators: PluginStructureValidator

PL003

Severity: Error Auto-Fixable: No Category: Plugin

Description: Missing required field name in plugin.json

When It Occurs: The plugin.json file is missing the required name field.

Example (Bad):

{
  "version": "0.1.0",
  "skills": ["./skills/"]
}

Fix:

{
  "name": "my-plugin",
  "version": "0.1.0",
  "skills": ["./skills/"]
}

Required Fields:

• name: Plugin name (kebab-case)

Related Validators: PluginStructureValidator

PL004

Severity: Error Auto-Fixable: No Category: Plugin

Description: Component path does not start with ./

When It Occurs: A component path in plugin.json doesn't start with ./.

Example (Bad):

{
  "name": "my-plugin",
  "skills": ["skills/"],
  "agents": ["agents/worker.md"]
}

Fix:

{
  "name": "my-plugin",
  "skills": ["./skills/"],
  "agents": ["./agents/worker.md"]
}

Why It Matters: Claude Code requires relative paths to start with ./ for security and consistency.

Related Validators: PluginStructureValidator

PL005

Severity: Error Auto-Fixable: No Category: Plugin

Description: Referenced component file does not exist

When It Occurs: A file or directory referenced in plugin.json doesn't exist.

Example (Bad):

{
  "name": "my-plugin",
  "agents": ["./agents/non-existent.md"]
}

Fix:

# Create the referenced file
mkdir -p agents
touch agents/non-existent.md

# OR remove the reference from plugin.json

Related Validators: PluginStructureValidator

See Also

• Plugin Validator Architecture - Technical specification
• CONTRIBUTING.md - Contribution guidelines
• Official Claude Code Plugin Documentation - Official documentation

Last Updated: 2026-01-30 Plugin Validator Version: 0.1.0 (planned)