Skip to content

Commit 39e6346

Browse files
committed
docs: clarify skill naming is convention, not enforced
The documentation incorrectly stated that skill names must follow strict validation rules (lowercase alphanumeric with hyphens, regex pattern, etc). Looking at the actual code in skill.ts, there is no such validation - the name field accepts any string. This validation was proposed in PR anomalyco#5930 but removed before merging because it broke backward compatibility (see issue anomalyco#6432). Updated the docs to present these as recommended conventions rather than enforced requirements. Fixes anomalyco#9294
1 parent 0d8e706 commit 39e6346

1 file changed

Lines changed: 8 additions & 15 deletions

File tree

packages/web/src/content/docs/skills.mdx

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,28 +44,21 @@ Unknown frontmatter fields are ignored.
4444

4545
---
4646

47-
## Validate names
47+
## Naming conventions
4848

49-
`name` must:
49+
For consistency and compatibility with Claude Code's `.claude/skills/` format, we recommend:
5050

51-
- Be 1–64 characters
52-
- Be lowercase alphanumeric with single hyphen separators
53-
- Not start or end with `-`
54-
- Not contain consecutive `--`
55-
- Match the directory name that contains `SKILL.md`
51+
- Lowercase alphanumeric names with hyphens (e.g., `git-release`, `code-review`)
52+
- Matching the directory name to the skill name
53+
- Keeping names concise and descriptive
5654

57-
Equivalent regex:
58-
59-
```text
60-
^[a-z0-9]+(-[a-z0-9]+)*$
61-
```
55+
These are conventions, not enforced requirements. The `name` field accepts any non-empty string.
6256

6357
---
6458

65-
## Follow length rules
59+
## Description length
6660

67-
`description` must be 1-1024 characters.
68-
Keep it specific enough for the agent to choose correctly.
61+
Keep descriptions specific enough for the agent to choose correctly—aim for 1-2 sentences that clearly explain when to use the skill.
6962

7063
---
7164

0 commit comments

Comments
 (0)