Skip to content

Commit 57aab8a

Browse files
authored
docs: add tip on writing effective skill descriptions (#78)
Co-authored-by: williycole <[email protected]>
1 parent a23fdd0 commit 57aab8a

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ defp usage_rules do
8484
end
8585
```
8686

87+
> **Tip:** Many AI coding agents (Claude Code, Cursor, GitHub Copilot, Windsurf) use the `description:` value to decide when to auto-load the skill without manual invocation. Descriptions with specific, observable signals tend to work better than generic topic labels — e.g. `"Load when any file uses Ash.Resource or when debugging Ash.Error.Forbidden"` rather than `"Use when working with Ash resources."` File paths, error type names, and mix task names give agents precise matching cues.
88+
8789
Then run:
8890

8991
```sh

0 commit comments

Comments
 (0)