Skip to content

docs: clarify skill naming is convention, not enforced #9295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yacinehmito wants to merge 1 commit into
base: dev
Choose a base branch
from
+8 −15
Open

docs: clarify skill naming is convention, not enforced #9295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions packages/web/src/content/docs/skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,28 +44,21 @@ Unknown frontmatter fields are ignored.

---

## Validate names
## Naming conventions

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

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

Equivalent regex:

```text
^[a-z0-9]+(-[a-z0-9]+)*$
```
These are conventions, not enforced requirements. The `name` field accepts any non-empty string.

---

## Follow length rules
## Description length

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

---

Expand Down