返回 CodeWhale
SKILL.md
1 ---
2 name: skill-creator
3 description: Create or improve codewhale skills. Use when the user wants a new skill, wants to update an existing skill, or needs guidance on when a skill should be a skill versus MCP, hooks, tools, or a plugin scaffold.
4 metadata:
5 short-description: Create DeepSeek skills
6 aliases-for: create-skill
7 ---
8
9 # Skill Creator
10
11 Use this skill to create small, useful codewhale skills that match the
12 runtime this repository actually ships.
13
14 ## What A Skill Is
15
16 A skill is a local folder with a `SKILL.md` file. DeepSeek reads the skill name
17 and description during discovery, then loads the body only when the user or task
18 matches the skill.
19
20 Discovery paths, in precedence order:
21
22 - `<workspace>/.agents/skills`
23 - `<workspace>/skills`
24 - `<workspace>/.opencode/skills`
25 - `<workspace>/.claude/skills`
26 - `<workspace>/.cursor/skills`
27 - `<workspace>/.codewhale/skills`
28 - `~/.agents/skills`
29 - `~/.claude/skills`
30 - `~/.codewhale/skills`
31 - `~/.deepseek/skills` (legacy fallback)
32
33 Use skills for model instructions, workflows, and lightweight conventions. Use
34 MCP for live external APIs or durable tools. Use hooks for automatic local
35 events. Use plugin folders only as packaging/scaffolding until a real plugin
36 loader exists.
37
38 ## Minimum Shape
39
40 ```text
41 my-skill/
42 `-- SKILL.md
43 ```
44
45 ```markdown
46 ---
47 name: my-skill
48 description: Use when Codewhale should follow this specific workflow.
49 ---
50
51 # My Skill
52
53 Instructions for the agent.
54 ```
55
56 Frontmatter parsing is intentionally simple. Keep `name` and `description` as
57 plain single-line values. Use lower-case hyphen-case names.
58
59 ## Writing Rules
60
61 - Make the `description` action-oriented and trigger-specific. It is the main
62 signal DeepSeek sees before loading the body.
63 - Keep the body operational. Include what to do, what to avoid, and how to
64 verify the result.
65 - Do not include general programming advice, marketing copy, or long background
66 material.
67 - Move bulky details to `references/` and mention exactly when to open them.
68 - Add `scripts/` only for deterministic helpers that are worth maintaining.
69 - Add `assets/` only for templates, fixtures, examples, or files reused by the
70 workflow.
71 - Do not assume scripts are safe to run. Community skill scripts require user
72 intent and trust review.
73
74 ## Creation Workflow
75
76 1. Define the skill boundary in one sentence.
77 2. Decide whether a skill is the right surface:
78 - Instructional workflow: skill
79 - External service/API: MCP server plus an optional skill
80 - Repeated shell helper: local tool or script plus an optional skill
81 - Packaging multiple pieces: plugin scaffold plus skill/MCP activation notes
82 3. Create `<skill-name>/SKILL.md`.
83 4. Write frontmatter with `name` and `description`.
84 5. Write a concise body with:
85 - trigger and scope
86 - required inputs or assumptions
87 - step-by-step workflow
88 - validation checks
89 - safety notes
90 6. Add companion files only when they reduce real complexity.
91 7. Validate by loading the skill through `/skills` or by running the relevant
92 skill discovery tests if editing this repository.
93
94 ## Updating Existing Skills
95
96 - Preserve the user's local intent. Avoid replacing a working skill wholesale
97 unless the user asked for a rewrite.
98 - Tighten descriptions when the skill is under-triggering or over-triggering.
99 - Remove stale tool names, unavailable dependencies, and copied instructions
100 from other agents that do not apply to codewhale.
101 - Keep examples short and directly tied to this runtime's commands and tools.
102
103 ## Validation Checklist
104
105 - `SKILL.md` starts with `---`.
106 - `name` matches the directory name unless there is a deliberate reason.
107 - `description` says when to use the skill, not just what it is.
108 - The body references only tools, commands, and paths that exist or are clearly
109 optional.
110 - Any scripts or external-service steps explain credential and trust handling.
111
111 lines MARKDOWN