@slycode/slycode 0.1.19 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/web/.next/BUILD_ID +1 -1
- package/dist/web/.next/build-manifest.json +2 -2
- package/dist/web/.next/server/app/_global-error.html +2 -2
- package/dist/web/.next/server/app/_global-error.rsc +1 -1
- package/dist/web/.next/server/app/_global-error.segments/__PAGE__.segment.rsc +1 -1
- package/dist/web/.next/server/app/_global-error.segments/_full.segment.rsc +1 -1
- package/dist/web/.next/server/app/_global-error.segments/_head.segment.rsc +1 -1
- package/dist/web/.next/server/app/_global-error.segments/_index.segment.rsc +1 -1
- package/dist/web/.next/server/app/_global-error.segments/_tree.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.html +1 -1
- package/dist/web/.next/server/app/_not-found.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_full.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_head.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_index.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_not-found/__PAGE__.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_not-found.segment.rsc +1 -1
- package/dist/web/.next/server/app/_not-found.segments/_tree.segment.rsc +1 -1
- package/dist/web/.next/server/app/page_client-reference-manifest.js +1 -1
- package/dist/web/.next/server/app/project/[id]/page_client-reference-manifest.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__46b023d4._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__4c7995bf._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__4d0d3464._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__543058c2._.js +3 -3
- package/dist/web/.next/server/chunks/[root-of-the-server]__6d330d40._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__884d73e4._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__949bb248._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__949d814c._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__aa814a86._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__ad64e04f._.js +2 -2
- package/dist/web/.next/server/chunks/[root-of-the-server]__baa99257._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__bbb4b3ac._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__bf286c26._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__ce429522._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__d38c7a96._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__e9b0e744._.js +1 -1
- package/dist/web/.next/server/chunks/[root-of-the-server]__f1fe18e6._.js +2 -2
- package/dist/web/.next/server/chunks/ssr/[root-of-the-server]__677b7660._.js +1 -1
- package/dist/web/.next/server/chunks/ssr/[root-of-the-server]__79c0188d._.js +1 -1
- package/dist/web/.next/server/chunks/ssr/src_lib_registry_ts_2fc87c9c._.js +1 -1
- package/dist/web/.next/server/pages/404.html +1 -1
- package/dist/web/.next/server/pages/500.html +2 -2
- package/dist/web/.next/static/chunks/7660448872d80e27.js +4 -0
- package/dist/web/.next/static/chunks/{49ff6bc5c5e30161.js → b694f741bb34ac84.js} +1 -1
- package/dist/web/src/components/ClaudeTerminalPanel.tsx +4 -0
- package/dist/web/src/lib/store-scanner.ts +70 -10
- package/dist/web/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/templates/kanban-seed.json +1 -1
- package/dist/store/.backups/actions/onboard.md +0 -33
- package/dist/store/.backups/actions/review.md +0 -37
- package/dist/store/.backups/actions/show-card.md +0 -20
- package/dist/store/.backups/checkpoint/SKILL.md +0 -43
- package/dist/store/.backups/context-priming/SKILL.md +0 -153
- package/dist/store/.backups/context-priming/references/area-index.md +0 -101
- package/dist/store/.backups/context-priming/references/areas/claude-actions.md +0 -120
- package/dist/store/.backups/context-priming/references/areas/messaging.md +0 -177
- package/dist/store/.backups/context-priming/references/areas/scripts-deployment.md +0 -138
- package/dist/store/.backups/context-priming/references/areas/skills.md +0 -135
- package/dist/store/.backups/context-priming/references/areas/terminal-bridge.md +0 -232
- package/dist/store/.backups/context-priming/references/areas/web-frontend.md +0 -252
- package/dist/store/.backups/context-priming/references/maintenance.md +0 -128
- package/dist/store/.ignored-updates.json +0 -37
- package/dist/store/actions/analyse-implementation.md +0 -72
- package/dist/store/actions/archive.md +0 -36
- package/dist/store/actions/clear.md +0 -13
- package/dist/store/actions/complete.md +0 -34
- package/dist/store/actions/continue.md +0 -20
- package/dist/store/agents/doc-updater.md +0 -619
- package/dist/store/mcp/context7.json +0 -8
- package/dist/store/skills/claude-code-docs-maintainer/SKILL.md +0 -168
- package/dist/store/skills/create-command/SKILL.md +0 -92
- package/dist/store/skills/doc-discovery/SKILL.md +0 -18
- package/dist/store/skills/doc-update/SKILL.md +0 -15
- package/dist/store/skills/dummy/SKILL.md +0 -22
- package/dist/store/skills/interactive-explainer/SKILL.md +0 -557
- package/dist/store/skills/interactive-explainer/assets/base_template.html +0 -780
- package/dist/store/skills/interactive-explainer/references/design_patterns.md +0 -486
- package/dist/store/skills/interactive-explainer/references/visualization_libraries.md +0 -512
- package/dist/store/skills/problem_summary/SKILL.md +0 -11
- package/dist/store/skills/reference-fetch/SKILL.md +0 -206
- package/dist/store/skills/skill-creator/LICENSE.txt +0 -202
- package/dist/store/skills/skill-creator/SKILL.md +0 -246
- package/dist/store/skills/skill-creator/scripts/init_skill.py +0 -303
- package/dist/store/skills/skill-creator/scripts/package_skill.py +0 -110
- package/dist/store/skills/skill-creator/scripts/quick_validate.py +0 -65
- package/dist/web/.next/static/chunks/600359dcf0f0daac.js +0 -4
- /package/dist/web/.next/static/{ilZDkIBsZqGYxOIGxgcnT → BbBq5FNe-sYRKe8Pc24UW}/_buildManifest.js +0 -0
- /package/dist/web/.next/static/{ilZDkIBsZqGYxOIGxgcnT → BbBq5FNe-sYRKe8Pc24UW}/_clientMiddlewareManifest.json +0 -0
- /package/dist/web/.next/static/{ilZDkIBsZqGYxOIGxgcnT → BbBq5FNe-sYRKe8Pc24UW}/_ssgManifest.js +0 -0
|
@@ -1,206 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: reference-fetch
|
|
3
|
-
version: 1.1.1
|
|
4
|
-
updated: 2026-02-22
|
|
5
|
-
allowed-tools: mcp__context7__resolve-library-id, mcp__context7__get-library-docs, mcp__firecrawl__firecrawl_scrape, mcp__firecrawl__firecrawl_search, Read, Write, Glob, Bash(date:*), Bash(powershell:*), Bash(Get-ChildItem:*), Bash(Get-Item:*), Bash(Get-Date:*), find
|
|
6
|
-
argument-hint: "[topic/url] [optional output filename] [--firecrawl|--context7]"
|
|
7
|
-
description: "Fetch reference documentation using Context7 (structured) or Firecrawl (web scraping)"
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Reference Documentation Fetcher
|
|
11
|
-
|
|
12
|
-
## Summary
|
|
13
|
-
Fetch reference documentation from multiple sources and create/update summary MD files in the Documentation/Reference folder. Uses **Context7** for structured library documentation (preferred) with **Firecrawl** as fallback for web scraping. Checks for existing documents and only updates if older than 24 hours.
|
|
14
|
-
|
|
15
|
-
## Source Selection Logic
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
Input: topic/URL [--firecrawl|--context7]
|
|
19
|
-
│
|
|
20
|
-
├─► --firecrawl flag? ─────────────► Force Firecrawl
|
|
21
|
-
│
|
|
22
|
-
├─► --context7 flag? ──────────────► Force Context7 only (no fallback)
|
|
23
|
-
│
|
|
24
|
-
├─► Is it a URL? ──────────────────► Firecrawl (direct scrape)
|
|
25
|
-
│
|
|
26
|
-
└─► Is it a topic/library name?
|
|
27
|
-
│
|
|
28
|
-
└─► Try Context7 first
|
|
29
|
-
│
|
|
30
|
-
├─► Sufficient result? ──► Use Context7
|
|
31
|
-
│
|
|
32
|
-
└─► Insufficient? ────────► Fallback to Firecrawl
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
### When to Use Each Source
|
|
36
|
-
|
|
37
|
-
| Source | Best For | Limitations |
|
|
38
|
-
|--------|----------|-------------|
|
|
39
|
-
| **Context7** | Popular libraries, frameworks, SDKs (React, FastAPI, boto3, etc.) | Only known libraries, no arbitrary URLs |
|
|
40
|
-
| **Firecrawl** | Direct URLs, blogs, niche tools, general topics | Raw scraping, messier output |
|
|
41
|
-
|
|
42
|
-
## Variable Declarations
|
|
43
|
-
|
|
44
|
-
### Input Variables
|
|
45
|
-
- **Search Topic/URL**: `$1` - The topic to search for or direct URL to fetch
|
|
46
|
-
- **Output Filename**: `$2` (optional) - Custom filename for the output (defaults to sanitized topic name)
|
|
47
|
-
- **Source Flag**: `--firecrawl` or `--context7` (optional) - Force a specific source
|
|
48
|
-
|
|
49
|
-
### Working Variables
|
|
50
|
-
- **Target Directory**: `documentation/reference/`
|
|
51
|
-
- **Existing File Path**: Discovered via glob pattern matching
|
|
52
|
-
- **File Age**: Calculated from file modification time
|
|
53
|
-
- **24 Hour Threshold**: 86400 seconds
|
|
54
|
-
- **Selected Source**: Context7 or Firecrawl
|
|
55
|
-
- **Fetch Results**: Content retrieved from selected source
|
|
56
|
-
|
|
57
|
-
### Output Variables
|
|
58
|
-
- **Summary File**: Markdown file in documentation/reference/ folder
|
|
59
|
-
- **Creation Status**: New file created or existing file updated
|
|
60
|
-
- **Content Statistics**: Word count, sections created, source used
|
|
61
|
-
|
|
62
|
-
## Setup Tasks
|
|
63
|
-
|
|
64
|
-
### 1. Parse Arguments
|
|
65
|
-
- Extract topic/URL from arguments
|
|
66
|
-
- Check for `--firecrawl` or `--context7` flags
|
|
67
|
-
- Strip flags from topic before processing
|
|
68
|
-
|
|
69
|
-
### 2. Check for Existing Documentation
|
|
70
|
-
- Use Glob tool to search for existing files matching the topic pattern
|
|
71
|
-
- If files found, check their modification time using Read tool
|
|
72
|
-
- Compare with current time to determine if older than 24 hours
|
|
73
|
-
|
|
74
|
-
### 3. Handle Existing Files
|
|
75
|
-
If existing file is older than 24 hours:
|
|
76
|
-
- Display file information and age
|
|
77
|
-
- ASK FOR PERMISSION before deletion (not auto-allowed)
|
|
78
|
-
- Only proceed with user confirmation
|
|
79
|
-
|
|
80
|
-
### 4. Prepare Output Path
|
|
81
|
-
- Sanitize topic name for filename if $2 not provided
|
|
82
|
-
- Ensure documentation/reference/ directory exists
|
|
83
|
-
- Determine final output path
|
|
84
|
-
|
|
85
|
-
## Workflow
|
|
86
|
-
|
|
87
|
-
### Phase 1: Discovery
|
|
88
|
-
1. **Parse Input**
|
|
89
|
-
- Detect if input is URL (starts with http) or topic
|
|
90
|
-
- Check for source override flags
|
|
91
|
-
- Report: "Input: [topic/url], Source override: [none/firecrawl/context7]"
|
|
92
|
-
|
|
93
|
-
2. **Check Existing Files**
|
|
94
|
-
- Look for existing reference documentation on the topic
|
|
95
|
-
- Calculate file age if found
|
|
96
|
-
- Report findings to user
|
|
97
|
-
|
|
98
|
-
3. **User Confirmation**
|
|
99
|
-
- If file exists and is >24 hours old:
|
|
100
|
-
- Ask: "Found existing file [name] from [date]. Update it?"
|
|
101
|
-
- If file exists and is <24 hours old:
|
|
102
|
-
- Inform: "Recent file exists (created [time] ago). Skipping update."
|
|
103
|
-
|
|
104
|
-
### Phase 2: Source Selection & Fetching
|
|
105
|
-
|
|
106
|
-
#### If `--firecrawl` flag or input is URL:
|
|
107
|
-
- Skip Context7, go directly to Firecrawl
|
|
108
|
-
- Report: "Using Firecrawl (forced/URL detected)"
|
|
109
|
-
|
|
110
|
-
#### If `--context7` flag:
|
|
111
|
-
- Use Context7 only, no fallback
|
|
112
|
-
- Report: "Using Context7 only (forced)"
|
|
113
|
-
|
|
114
|
-
#### Default (topic without flags):
|
|
115
|
-
1. **Try Context7 First**
|
|
116
|
-
- Report: "Trying Context7 for structured documentation..."
|
|
117
|
-
- Use `mcp__context7__resolve-library-id` to find library
|
|
118
|
-
- Use `mcp__context7__get-library-docs` to fetch docs
|
|
119
|
-
|
|
120
|
-
2. **Evaluate Result Sufficiency**
|
|
121
|
-
A Context7 result is **insufficient** if ANY of:
|
|
122
|
-
- No content returned / library not found
|
|
123
|
-
- Content is under ~500 words AND has no code examples
|
|
124
|
-
- Content appears to be an error message
|
|
125
|
-
|
|
126
|
-
3. **Fallback to Firecrawl if Insufficient**
|
|
127
|
-
- Report: "Context7 result insufficient, falling back to Firecrawl..."
|
|
128
|
-
- Use `mcp__firecrawl__firecrawl_search` to find sources
|
|
129
|
-
- Scrape top results
|
|
130
|
-
|
|
131
|
-
#### Firecrawl Operations
|
|
132
|
-
- For URLs: Use `mcp__firecrawl__firecrawl_scrape`
|
|
133
|
-
- For topics: Use `mcp__firecrawl__firecrawl_search` with scraping
|
|
134
|
-
- Fetch comprehensive content with markdown format
|
|
135
|
-
|
|
136
|
-
### Phase 3: Content Processing
|
|
137
|
-
1. **Organize Information**
|
|
138
|
-
- Structure content with clear sections
|
|
139
|
-
- Add metadata (fetch date, source used)
|
|
140
|
-
- Create table of contents
|
|
141
|
-
- Ensure information density
|
|
142
|
-
|
|
143
|
-
2. **Format Document**
|
|
144
|
-
- Add header with title and last updated date
|
|
145
|
-
- Include source attribution (Context7 or Firecrawl + URLs)
|
|
146
|
-
- Organize by logical sections
|
|
147
|
-
- Add summary at the top
|
|
148
|
-
|
|
149
|
-
### Phase 4: File Creation
|
|
150
|
-
1. **Write Documentation File**
|
|
151
|
-
- Save to documentation/reference/ folder
|
|
152
|
-
- Use descriptive filename
|
|
153
|
-
- Include generation metadata
|
|
154
|
-
|
|
155
|
-
2. **Validation**
|
|
156
|
-
- Verify file was created successfully
|
|
157
|
-
- Check file size and content
|
|
158
|
-
- Confirm markdown formatting
|
|
159
|
-
|
|
160
|
-
## Reporting Format
|
|
161
|
-
|
|
162
|
-
### Success Report
|
|
163
|
-
```
|
|
164
|
-
✅ Reference Documentation Created/Updated
|
|
165
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
166
|
-
📄 File: documentation/reference/[filename].md
|
|
167
|
-
🔍 Source: [Context7|Firecrawl] [fallback note if applicable]
|
|
168
|
-
📊 Size: [X] KB, [Y] sections
|
|
169
|
-
⏰ Generated: [timestamp]
|
|
170
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
171
|
-
|
|
172
|
-
Summary:
|
|
173
|
-
- [Key point 1]
|
|
174
|
-
- [Key point 2]
|
|
175
|
-
- [Key point 3]
|
|
176
|
-
|
|
177
|
-
Use '/reference-fetch [topic]' to fetch other documentation
|
|
178
|
-
Use '--firecrawl' or '--context7' to force a specific source
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
### Skipped Report (Recent File Exists)
|
|
182
|
-
```
|
|
183
|
-
ℹ️ Recent Documentation Exists
|
|
184
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
185
|
-
📄 File: documentation/reference/[filename].md
|
|
186
|
-
⏰ Created: [X] hours ago
|
|
187
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
188
|
-
|
|
189
|
-
File is less than 24 hours old. Skipping update.
|
|
190
|
-
To force update, delete the existing file first.
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### Fallback Report
|
|
194
|
-
```
|
|
195
|
-
⚠️ Context7 Insufficient, Using Firecrawl
|
|
196
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
197
|
-
Reason: [Library not found | Content too sparse | No code examples]
|
|
198
|
-
Falling back to web search...
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
### Error Handling
|
|
202
|
-
- Context7 not available: Automatically use Firecrawl
|
|
203
|
-
- Network errors: Retry with fallback sources
|
|
204
|
-
- No results found: Suggest alternative search terms
|
|
205
|
-
- Permission denied: Explain why deletion wasn't allowed
|
|
206
|
-
- Invalid URL: Provide format guidance
|
|
@@ -1,202 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
Apache License
|
|
3
|
-
Version 2.0, January 2004
|
|
4
|
-
http://www.apache.org/licenses/
|
|
5
|
-
|
|
6
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
-
|
|
8
|
-
1. Definitions.
|
|
9
|
-
|
|
10
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
-
|
|
13
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
-
the copyright owner that is granting the License.
|
|
15
|
-
|
|
16
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
-
other entities that control, are controlled by, or are under common
|
|
18
|
-
control with that entity. For the purposes of this definition,
|
|
19
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
-
direction or management of such entity, whether by contract or
|
|
21
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
-
|
|
24
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
-
exercising permissions granted by this License.
|
|
26
|
-
|
|
27
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
-
including but not limited to software source code, documentation
|
|
29
|
-
source, and configuration files.
|
|
30
|
-
|
|
31
|
-
"Object" form shall mean any form resulting from mechanical
|
|
32
|
-
transformation or translation of a Source form, including but
|
|
33
|
-
not limited to compiled object code, generated documentation,
|
|
34
|
-
and conversions to other media types.
|
|
35
|
-
|
|
36
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
-
Object form, made available under the License, as indicated by a
|
|
38
|
-
copyright notice that is included in or attached to the work
|
|
39
|
-
(an example is provided in the Appendix below).
|
|
40
|
-
|
|
41
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
-
form, that is based on (or derived from) the Work and for which the
|
|
43
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
-
of this License, Derivative Works shall not include works that remain
|
|
46
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
-
the Work and Derivative Works thereof.
|
|
48
|
-
|
|
49
|
-
"Contribution" shall mean any work of authorship, including
|
|
50
|
-
the original version of the Work and any modifications or additions
|
|
51
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
-
means any form of electronic, verbal, or written communication sent
|
|
56
|
-
to the Licensor or its representatives, including but not limited to
|
|
57
|
-
communication on electronic mailing lists, source code control systems,
|
|
58
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
-
excluding communication that is conspicuously marked or otherwise
|
|
61
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
-
|
|
63
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
-
subsequently incorporated within the Work.
|
|
66
|
-
|
|
67
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
-
Work and such Derivative Works in Source or Object form.
|
|
73
|
-
|
|
74
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
-
(except as stated in this section) patent license to make, have made,
|
|
78
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
-
where such license applies only to those patent claims licensable
|
|
80
|
-
by such Contributor that are necessarily infringed by their
|
|
81
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
-
institute patent litigation against any entity (including a
|
|
84
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
-
or contributory patent infringement, then any patent licenses
|
|
87
|
-
granted to You under this License for that Work shall terminate
|
|
88
|
-
as of the date such litigation is filed.
|
|
89
|
-
|
|
90
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
-
modifications, and in Source or Object form, provided that You
|
|
93
|
-
meet the following conditions:
|
|
94
|
-
|
|
95
|
-
(a) You must give any other recipients of the Work or
|
|
96
|
-
Derivative Works a copy of this License; and
|
|
97
|
-
|
|
98
|
-
(b) You must cause any modified files to carry prominent notices
|
|
99
|
-
stating that You changed the files; and
|
|
100
|
-
|
|
101
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
-
that You distribute, all copyright, patent, trademark, and
|
|
103
|
-
attribution notices from the Source form of the Work,
|
|
104
|
-
excluding those notices that do not pertain to any part of
|
|
105
|
-
the Derivative Works; and
|
|
106
|
-
|
|
107
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
-
distribution, then any Derivative Works that You distribute must
|
|
109
|
-
include a readable copy of the attribution notices contained
|
|
110
|
-
within such NOTICE file, excluding those notices that do not
|
|
111
|
-
pertain to any part of the Derivative Works, in at least one
|
|
112
|
-
of the following places: within a NOTICE text file distributed
|
|
113
|
-
as part of the Derivative Works; within the Source form or
|
|
114
|
-
documentation, if provided along with the Derivative Works; or,
|
|
115
|
-
within a display generated by the Derivative Works, if and
|
|
116
|
-
wherever such third-party notices normally appear. The contents
|
|
117
|
-
of the NOTICE file are for informational purposes only and
|
|
118
|
-
do not modify the License. You may add Your own attribution
|
|
119
|
-
notices within Derivative Works that You distribute, alongside
|
|
120
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
-
that such additional attribution notices cannot be construed
|
|
122
|
-
as modifying the License.
|
|
123
|
-
|
|
124
|
-
You may add Your own copyright statement to Your modifications and
|
|
125
|
-
may provide additional or different license terms and conditions
|
|
126
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
-
the conditions stated in this License.
|
|
130
|
-
|
|
131
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
-
this License, without any additional terms or conditions.
|
|
135
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
-
the terms of any separate license agreement you may have executed
|
|
137
|
-
with Licensor regarding such Contributions.
|
|
138
|
-
|
|
139
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
-
except as required for reasonable and customary use in describing the
|
|
142
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
-
|
|
144
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
-
implied, including, without limitation, any warranties or conditions
|
|
149
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
-
appropriateness of using or redistributing the Work and assume any
|
|
152
|
-
risks associated with Your exercise of permissions under this License.
|
|
153
|
-
|
|
154
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
-
unless required by applicable law (such as deliberate and grossly
|
|
157
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
-
liable to You for damages, including any direct, indirect, special,
|
|
159
|
-
incidental, or consequential damages of any character arising as a
|
|
160
|
-
result of this License or out of the use or inability to use the
|
|
161
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
-
other commercial damages or losses), even if such Contributor
|
|
164
|
-
has been advised of the possibility of such damages.
|
|
165
|
-
|
|
166
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
-
or other liability obligations and/or rights consistent with this
|
|
170
|
-
License. However, in accepting such obligations, You may act only
|
|
171
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
-
defend, and hold each Contributor harmless for any liability
|
|
174
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
-
of your accepting any such warranty or additional liability.
|
|
176
|
-
|
|
177
|
-
END OF TERMS AND CONDITIONS
|
|
178
|
-
|
|
179
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
-
|
|
181
|
-
To apply the Apache License to your work, attach the following
|
|
182
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
-
replaced with your own identifying information. (Don't include
|
|
184
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
-
comment syntax for the file format. We also recommend that a
|
|
186
|
-
file or class name and description of purpose be included on the
|
|
187
|
-
same "printed page" as the copyright notice for easier
|
|
188
|
-
identification within third-party archives.
|
|
189
|
-
|
|
190
|
-
Copyright [yyyy] [name of copyright owner]
|
|
191
|
-
|
|
192
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
-
you may not use this file except in compliance with the License.
|
|
194
|
-
You may obtain a copy of the License at
|
|
195
|
-
|
|
196
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
-
|
|
198
|
-
Unless required by applicable law or agreed to in writing, software
|
|
199
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
-
See the License for the specific language governing permissions and
|
|
202
|
-
limitations under the License.
|
|
@@ -1,246 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: skill-creator
|
|
3
|
-
version: 1.0.1
|
|
4
|
-
updated: 2026-02-22
|
|
5
|
-
description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Skill Creator
|
|
9
|
-
|
|
10
|
-
This skill provides guidance for creating effective skills.
|
|
11
|
-
|
|
12
|
-
## About Skills
|
|
13
|
-
|
|
14
|
-
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
|
15
|
-
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
|
16
|
-
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
|
17
|
-
equipped with procedural knowledge that no model can fully possess.
|
|
18
|
-
|
|
19
|
-
### What Skills Provide
|
|
20
|
-
|
|
21
|
-
1. Specialized workflows - Multi-step procedures for specific domains
|
|
22
|
-
2. Tool integrations - Instructions for working with specific file formats or APIs
|
|
23
|
-
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
|
24
|
-
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
|
25
|
-
|
|
26
|
-
### Anatomy of a Skill
|
|
27
|
-
|
|
28
|
-
Every skill consists of a required SKILL.md file and optional bundled resources:
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
skill-name/
|
|
32
|
-
├── SKILL.md (required)
|
|
33
|
-
│ ├── YAML frontmatter metadata (required)
|
|
34
|
-
│ │ ├── name: (required)
|
|
35
|
-
│ │ └── description: (required)
|
|
36
|
-
│ └── Markdown instructions (required)
|
|
37
|
-
└── Bundled Resources (optional)
|
|
38
|
-
├── scripts/ - Executable code (Python/Bash/etc.)
|
|
39
|
-
├── references/ - Documentation intended to be loaded into context as needed
|
|
40
|
-
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
#### SKILL.md (required)
|
|
44
|
-
|
|
45
|
-
**Metadata Quality:** The `name` and `description` in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
|
|
46
|
-
|
|
47
|
-
#### Bundled Resources (optional)
|
|
48
|
-
|
|
49
|
-
##### Scripts (`scripts/`)
|
|
50
|
-
|
|
51
|
-
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
|
52
|
-
|
|
53
|
-
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
|
54
|
-
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
|
55
|
-
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
|
56
|
-
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
|
57
|
-
|
|
58
|
-
##### References (`references/`)
|
|
59
|
-
|
|
60
|
-
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
|
61
|
-
|
|
62
|
-
- **When to include**: For documentation that Claude should reference while working
|
|
63
|
-
- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
|
|
64
|
-
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
|
65
|
-
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
|
66
|
-
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
|
67
|
-
- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
|
|
68
|
-
|
|
69
|
-
##### Assets (`assets/`)
|
|
70
|
-
|
|
71
|
-
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
|
72
|
-
|
|
73
|
-
- **When to include**: When the skill needs files that will be used in the final output
|
|
74
|
-
- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
|
|
75
|
-
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
|
76
|
-
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
|
77
|
-
|
|
78
|
-
### Progressive Disclosure Design Principle
|
|
79
|
-
|
|
80
|
-
Skills use a three-level loading system to manage context efficiently:
|
|
81
|
-
|
|
82
|
-
1. **Metadata (name + description)** - Always in context (~100 words)
|
|
83
|
-
2. **SKILL.md body** - When skill triggers (<5k words)
|
|
84
|
-
3. **Bundled resources** - As needed by Claude (Unlimited*)
|
|
85
|
-
|
|
86
|
-
*Unlimited because scripts can be executed without reading into context window.
|
|
87
|
-
|
|
88
|
-
## Skill Creation Process
|
|
89
|
-
|
|
90
|
-
To create a skill, follow the "Skill Creation Process" in order, skipping steps only if there is a clear reason why they are not applicable.
|
|
91
|
-
|
|
92
|
-
### Step 1: Understanding the Skill with Concrete Examples
|
|
93
|
-
|
|
94
|
-
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
|
95
|
-
|
|
96
|
-
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
|
|
97
|
-
|
|
98
|
-
For example, when building an image-editor skill, relevant questions include:
|
|
99
|
-
|
|
100
|
-
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
|
101
|
-
- "Can you give some examples of how this skill would be used?"
|
|
102
|
-
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
|
|
103
|
-
- "What would a user say that should trigger this skill?"
|
|
104
|
-
|
|
105
|
-
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
|
|
106
|
-
|
|
107
|
-
Conclude this step when there is a clear sense of the functionality the skill should support.
|
|
108
|
-
|
|
109
|
-
### Step 2: Planning the Reusable Skill Contents
|
|
110
|
-
|
|
111
|
-
To turn concrete examples into an effective skill, analyze each example by:
|
|
112
|
-
|
|
113
|
-
1. Considering how to execute on the example from scratch
|
|
114
|
-
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
|
115
|
-
|
|
116
|
-
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
|
117
|
-
|
|
118
|
-
1. Rotating a PDF requires re-writing the same code each time
|
|
119
|
-
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
|
120
|
-
|
|
121
|
-
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
|
|
122
|
-
|
|
123
|
-
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
|
124
|
-
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
|
125
|
-
|
|
126
|
-
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
|
127
|
-
|
|
128
|
-
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
|
129
|
-
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
|
130
|
-
|
|
131
|
-
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
|
132
|
-
|
|
133
|
-
**Evaluate self-maintenance need**: If the skill involves any of these, suggest self-maintaining capabilities (see "Self-Maintaining Skills" section):
|
|
134
|
-
- Evolving reference material that may drift from reality (codebase context, documentation)
|
|
135
|
-
- Heuristics or triggers that may need tuning based on experience
|
|
136
|
-
- Accumulated learnings or notes over time
|
|
137
|
-
|
|
138
|
-
### Step 3: Initializing the Skill
|
|
139
|
-
|
|
140
|
-
At this point, it is time to actually create the skill.
|
|
141
|
-
|
|
142
|
-
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
|
|
143
|
-
|
|
144
|
-
When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
|
|
145
|
-
|
|
146
|
-
Usage:
|
|
147
|
-
|
|
148
|
-
```bash
|
|
149
|
-
scripts/init_skill.py <skill-name> --path <output-directory>
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
The script:
|
|
153
|
-
|
|
154
|
-
- Creates the skill directory at the specified path
|
|
155
|
-
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
|
156
|
-
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
|
157
|
-
- Adds example files in each directory that can be customized or deleted
|
|
158
|
-
|
|
159
|
-
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
|
160
|
-
|
|
161
|
-
### Step 4: Edit the Skill
|
|
162
|
-
|
|
163
|
-
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Focus on including information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
|
|
164
|
-
|
|
165
|
-
#### Start with Reusable Skill Contents
|
|
166
|
-
|
|
167
|
-
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
|
|
168
|
-
|
|
169
|
-
Also, delete any example files and directories not needed for the skill. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
|
170
|
-
|
|
171
|
-
#### Update SKILL.md
|
|
172
|
-
|
|
173
|
-
**Writing Style:** Write the entire skill using **imperative/infinitive form** (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
|
|
174
|
-
|
|
175
|
-
To complete SKILL.md, answer the following questions:
|
|
176
|
-
|
|
177
|
-
1. What is the purpose of the skill, in a few sentences?
|
|
178
|
-
2. When should the skill be used?
|
|
179
|
-
3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
|
|
180
|
-
|
|
181
|
-
### Step 5: Validating a Skill
|
|
182
|
-
|
|
183
|
-
Once the skill is ready, validate it to ensure it meets structural requirements:
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
scripts/quick_validate.py <path/to/skill-folder>
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
The validator checks:
|
|
190
|
-
- YAML frontmatter format and required fields
|
|
191
|
-
- Skill naming conventions and directory structure
|
|
192
|
-
- Description completeness and quality
|
|
193
|
-
- File organization and resource references
|
|
194
|
-
|
|
195
|
-
Skills are created as folders directly in `.claude/skills/` - no zip packaging required for project-local skills. The `package_skill.py` script exists for distribution scenarios but is optional.
|
|
196
|
-
|
|
197
|
-
### Step 6: Iterate
|
|
198
|
-
|
|
199
|
-
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
|
200
|
-
|
|
201
|
-
**Iteration workflow:**
|
|
202
|
-
1. Use the skill on real tasks
|
|
203
|
-
2. Notice struggles or inefficiencies
|
|
204
|
-
3. Identify how SKILL.md or bundled resources should be updated
|
|
205
|
-
4. Implement changes and test again
|
|
206
|
-
|
|
207
|
-
## Self-Maintaining Skills
|
|
208
|
-
|
|
209
|
-
Some skills benefit from self-improvement capabilities - the ability to evaluate their own performance and suggest updates when challenged.
|
|
210
|
-
|
|
211
|
-
### When to Include Self-Maintenance
|
|
212
|
-
|
|
213
|
-
Consider self-maintenance for skills that:
|
|
214
|
-
- Manage evolving reference material (codebase context, documentation)
|
|
215
|
-
- Have heuristics that may need tuning based on experience
|
|
216
|
-
- Accumulate learnings over time
|
|
217
|
-
|
|
218
|
-
### Self-Maintenance Pattern
|
|
219
|
-
|
|
220
|
-
When a user challenges what the skill did ("you should have known this", "why didn't you do X"):
|
|
221
|
-
|
|
222
|
-
1. **Evaluate the action**: What did the skill do or fail to do?
|
|
223
|
-
2. **Identify root cause**: Why? Bad heuristic, missing information, stale reference, wrong trigger?
|
|
224
|
-
3. **Propose improvement**: Suggest a specific change to address the gap
|
|
225
|
-
4. **Await approval**: Only update skill files (SKILL.md, doctrine, core references) with explicit user consent
|
|
226
|
-
5. **Document the change**: If approved, make the update and briefly note what changed
|
|
227
|
-
|
|
228
|
-
### Permission Boundaries
|
|
229
|
-
|
|
230
|
-
Define which files the skill can update autonomously vs. which require approval:
|
|
231
|
-
|
|
232
|
-
| Update Type | Permission |
|
|
233
|
-
|-------------|------------|
|
|
234
|
-
| Reference content (area details, examples) | Can update in stride |
|
|
235
|
-
| Index/metadata (dates, triggers) | Can update in stride |
|
|
236
|
-
| Core skill logic (SKILL.md) | Requires approval |
|
|
237
|
-
| Operational doctrine | Requires approval |
|
|
238
|
-
|
|
239
|
-
### Avoiding Bloat
|
|
240
|
-
|
|
241
|
-
Self-improvement notes and learnings should be:
|
|
242
|
-
- Concise: short phrase tweaks, not paragraphs
|
|
243
|
-
- Prunable: old/obsolete notes get removed
|
|
244
|
-
- Bounded: set limits on accumulated learnings (e.g., max 10 notes per area)
|
|
245
|
-
|
|
246
|
-
When suggesting changes, prefer minimal edits that address the specific issue over broad restructuring.
|