Skip to content

Fix SKILL.md description so claude.ai and Claude Code see the same text - #15

Open
andhie wants to merge 1 commit into
humanlayer:mainfrom
andhie:patch-1
Open

andhie wants to merge 1 commit into
humanlayer:mainfrom
andhie:patch-1

Conversation

@andhie

@andhie andhie commented Nov 10, 2026

Copy link
Copy Markdown

Problem

The description in SKILL.md contains <important if>, which triggers:

SKILL.md description cannot contain XML tags

claude.ai saves the description with the angle brackets removed, while Claude Code reads the original text from the file. The two products end up with different descriptions, which can change when the skill triggers.

Error as seen in plugin sync

Why descriptions can't contain XML-like tags

Skill names and descriptions are loaded into the system prompt at startup, and the Agent Skills standard recommends an XML format for Claude models, roughly:

<available_skills>
  <skill>
    <name>improve-claude-md</name>
    <description>...</description>
  </skill>
</available_skills>

Anthropic doesn't document the reason for the rule, but a raw tag like <important if> inside that block would read as markup rather than text. In practice, claude.ai strips the brackets while Claude Code keeps them, so the two products end up with different descriptions. Removing the tag avoids both problems.

Why it matters

Anthropic's skill authoring guide lists "Cannot contain XML tags" as a requirement for description (alongside non-empty and max 1,024 characters). The description is loaded into the system prompt at startup and is what Claude uses to decide whether to trigger the skill, so it needs to be valid and identical everywhere.

Change

  • Replaced <important if> with "important if" in the frontmatter description.
  • Rewrote the description in third person and added when-to-use triggers, following the same guide.
  • The skill body is unchanged. <important if> blocks are still valid there, since the rule applies only to frontmatter fields.

Reference

https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices#skill-structure

Angle brackets aren’t allowed in a skill description, so claude.ai and Claude Code end up seeing two different descriptions. Add when to use the skill, which helps it trigger.
@CLAassistant

CLAassistant commented Nov 10, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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