aigroup-workflow 2.2.0 → 2.2.2

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.
Files changed (645) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/AGENTS.md +2 -2
  21. package/CLAUDE.md +23 -1
  22. package/LICENSE +20 -20
  23. package/README.md +333 -333
  24. package/agents/a11y-architect.md +141 -141
  25. package/agents/architect.md +211 -211
  26. package/agents/build-error-resolver.md +114 -114
  27. package/agents/chief-of-staff.md +151 -151
  28. package/agents/code-architect.md +71 -71
  29. package/agents/code-explorer.md +69 -69
  30. package/agents/code-reviewer.md +237 -237
  31. package/agents/code-simplifier.md +47 -47
  32. package/agents/comment-analyzer.md +45 -45
  33. package/agents/conversation-analyzer.md +52 -52
  34. package/agents/cpp-build-resolver.md +90 -90
  35. package/agents/cpp-reviewer.md +72 -72
  36. package/agents/csharp-reviewer.md +101 -101
  37. package/agents/dart-build-resolver.md +201 -201
  38. package/agents/database-reviewer.md +91 -91
  39. package/agents/doc-updater.md +107 -107
  40. package/agents/docs-lookup.md +68 -68
  41. package/agents/e2e-runner.md +107 -107
  42. package/agents/flutter-reviewer.md +243 -243
  43. package/agents/gan-evaluator.md +209 -209
  44. package/agents/gan-generator.md +131 -131
  45. package/agents/gan-planner.md +99 -99
  46. package/agents/get-current-datetime.md +26 -26
  47. package/agents/go-build-resolver.md +94 -94
  48. package/agents/go-reviewer.md +76 -76
  49. package/agents/harness-optimizer.md +35 -35
  50. package/agents/healthcare-reviewer.md +83 -83
  51. package/agents/java-build-resolver.md +153 -153
  52. package/agents/java-reviewer.md +92 -92
  53. package/agents/kotlin-build-resolver.md +118 -118
  54. package/agents/kotlin-reviewer.md +159 -159
  55. package/agents/loop-operator.md +36 -36
  56. package/agents/opensource-forker.md +198 -198
  57. package/agents/opensource-packager.md +249 -249
  58. package/agents/opensource-sanitizer.md +188 -188
  59. package/agents/performance-optimizer.md +446 -446
  60. package/agents/planner.md +212 -212
  61. package/agents/pr-test-analyzer.md +45 -45
  62. package/agents/python-reviewer.md +98 -98
  63. package/agents/pytorch-build-resolver.md +120 -120
  64. package/agents/refactor-cleaner.md +85 -85
  65. package/agents/rust-build-resolver.md +148 -148
  66. package/agents/rust-reviewer.md +94 -94
  67. package/agents/security-reviewer.md +108 -108
  68. package/agents/seo-specialist.md +59 -59
  69. package/agents/silent-failure-hunter.md +50 -50
  70. package/agents/tdd-guide.md +91 -91
  71. package/agents/type-design-analyzer.md +41 -41
  72. package/agents/typescript-reviewer.md +112 -112
  73. package/cli/commands/update.mjs +1 -1
  74. package/cli/utils/scaffold.mjs +53 -0
  75. package/docs/rules/agents.md +166 -50
  76. package/docs/rules/cpp/coding-style.md +44 -44
  77. package/docs/rules/cpp/hooks.md +39 -39
  78. package/docs/rules/cpp/patterns.md +51 -51
  79. package/docs/rules/cpp/security.md +51 -51
  80. package/docs/rules/cpp/testing.md +44 -44
  81. package/docs/rules/csharp/coding-style.md +72 -72
  82. package/docs/rules/csharp/hooks.md +25 -25
  83. package/docs/rules/csharp/patterns.md +50 -50
  84. package/docs/rules/csharp/security.md +58 -58
  85. package/docs/rules/csharp/testing.md +46 -46
  86. package/docs/rules/dart/coding-style.md +159 -159
  87. package/docs/rules/dart/hooks.md +66 -66
  88. package/docs/rules/dart/patterns.md +261 -261
  89. package/docs/rules/dart/security.md +135 -135
  90. package/docs/rules/dart/testing.md +215 -215
  91. package/docs/rules/golang/coding-style.md +32 -32
  92. package/docs/rules/golang/hooks.md +17 -17
  93. package/docs/rules/golang/patterns.md +45 -45
  94. package/docs/rules/golang/security.md +34 -34
  95. package/docs/rules/golang/testing.md +31 -31
  96. package/docs/rules/java/coding-style.md +114 -114
  97. package/docs/rules/java/hooks.md +18 -18
  98. package/docs/rules/java/patterns.md +146 -146
  99. package/docs/rules/java/security.md +100 -100
  100. package/docs/rules/java/testing.md +131 -131
  101. package/docs/rules/kotlin/coding-style.md +86 -86
  102. package/docs/rules/kotlin/hooks.md +17 -17
  103. package/docs/rules/kotlin/patterns.md +146 -146
  104. package/docs/rules/kotlin/security.md +82 -82
  105. package/docs/rules/kotlin/testing.md +128 -128
  106. package/docs/rules/perl/coding-style.md +46 -46
  107. package/docs/rules/perl/hooks.md +22 -22
  108. package/docs/rules/perl/patterns.md +76 -76
  109. package/docs/rules/perl/security.md +69 -69
  110. package/docs/rules/perl/testing.md +54 -54
  111. package/docs/rules/php/coding-style.md +40 -40
  112. package/docs/rules/php/hooks.md +24 -24
  113. package/docs/rules/php/patterns.md +33 -33
  114. package/docs/rules/php/security.md +37 -37
  115. package/docs/rules/php/testing.md +39 -39
  116. package/docs/rules/python/coding-style.md +42 -42
  117. package/docs/rules/python/hooks.md +19 -19
  118. package/docs/rules/python/patterns.md +39 -39
  119. package/docs/rules/python/security.md +30 -30
  120. package/docs/rules/python/testing.md +38 -38
  121. package/docs/rules/rust/coding-style.md +151 -151
  122. package/docs/rules/rust/hooks.md +16 -16
  123. package/docs/rules/rust/patterns.md +168 -168
  124. package/docs/rules/rust/security.md +141 -141
  125. package/docs/rules/rust/testing.md +154 -154
  126. package/docs/rules/swift/coding-style.md +47 -47
  127. package/docs/rules/swift/hooks.md +20 -20
  128. package/docs/rules/swift/patterns.md +66 -66
  129. package/docs/rules/swift/security.md +33 -33
  130. package/docs/rules/swift/testing.md +45 -45
  131. package/docs/rules/typescript/coding-style.md +199 -199
  132. package/docs/rules/typescript/hooks.md +22 -22
  133. package/docs/rules/typescript/patterns.md +52 -52
  134. package/docs/rules/typescript/security.md +28 -28
  135. package/docs/rules/typescript/testing.md +18 -18
  136. package/docs/rules/web/coding-style.md +96 -96
  137. package/docs/rules/web/design-quality.md +62 -62
  138. package/docs/rules/web/hooks.md +120 -120
  139. package/docs/rules/web/patterns.md +79 -79
  140. package/docs/rules/web/performance.md +64 -64
  141. package/docs/rules/web/security.md +57 -57
  142. package/docs/rules/web/testing.md +55 -55
  143. package/docs/templates/README.md +36 -36
  144. package/docs/templates/ai-project-final.md +124 -124
  145. package/docs/templates/ai-project.md +105 -105
  146. package/docs/templates/api.md +157 -157
  147. package/docs/templates/bug.md +62 -62
  148. package/docs/templates/code-review.md +87 -87
  149. package/docs/templates/generic.md +116 -116
  150. package/docs/templates/implementation-plan.md +1 -1
  151. package/docs/templates/meeting.md +68 -68
  152. package/docs/templates/prd.md +98 -98
  153. package/docs/templates/ui.md +134 -134
  154. package/docs/workflow-pipeline.md +11 -10
  155. package/package.json +40 -39
  156. package/scripts/hooks/checks/orchestration-artifacts.cjs +28 -23
  157. package/scripts/hooks/checks/workflow-state.cjs +4 -5
  158. package/scripts/orchestration/lib/orchestrator.cjs +344 -117
  159. package/scripts/orchestration/lib/validate.cjs +145 -0
  160. package/scripts/orchestration/session.cjs +88 -44
  161. package/skills/SUPERPOWERS-LICENSE +21 -21
  162. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  163. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  164. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  165. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  166. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  167. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  168. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  169. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  170. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  171. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  172. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  173. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  174. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  175. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  176. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  177. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  178. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  179. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  180. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  181. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  182. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  183. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  184. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  185. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  186. package/skills/backend/api-designer/SKILL.md +217 -217
  187. package/skills/backend/api-designer/references/error-handling.md +541 -541
  188. package/skills/backend/api-designer/references/openapi.md +824 -824
  189. package/skills/backend/api-designer/references/pagination.md +494 -494
  190. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  191. package/skills/backend/api-designer/references/versioning.md +391 -391
  192. package/skills/backend/architecture-designer/SKILL.md +117 -117
  193. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  194. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  195. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  196. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  197. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  198. package/skills/backend/code-documenter/SKILL.md +147 -147
  199. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  200. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  201. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  202. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  203. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  204. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  205. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  206. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  207. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  208. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  209. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  210. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  211. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  212. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  213. package/skills/backend/feature-forge/SKILL.md +98 -98
  214. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  215. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  216. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  217. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  218. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  219. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  220. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  221. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  222. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  223. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  224. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  225. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  226. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  227. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  228. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  229. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  230. package/skills/backend/graphql-architect/SKILL.md +146 -146
  231. package/skills/backend/graphql-architect/references/federation.md +418 -418
  232. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  233. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  234. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  235. package/skills/backend/graphql-architect/references/security.md +569 -569
  236. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  237. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  238. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  239. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  240. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  241. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  242. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  243. package/skills/backend/microservices-architect/SKILL.md +164 -164
  244. package/skills/backend/microservices-architect/references/communication.md +499 -499
  245. package/skills/backend/microservices-architect/references/data.md +721 -721
  246. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  247. package/skills/backend/microservices-architect/references/observability.md +805 -805
  248. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  249. package/skills/database/database-optimizer/SKILL.md +147 -147
  250. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  251. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  252. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  253. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  254. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  255. package/skills/database/postgres-pro/SKILL.md +152 -152
  256. package/skills/database/postgres-pro/references/extensions.md +404 -404
  257. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  258. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  259. package/skills/database/postgres-pro/references/performance.md +265 -265
  260. package/skills/database/postgres-pro/references/replication.md +446 -446
  261. package/skills/database/sql-pro/SKILL.md +129 -129
  262. package/skills/database/sql-pro/references/database-design.md +402 -402
  263. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  264. package/skills/database/sql-pro/references/optimization.md +384 -384
  265. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  266. package/skills/database/sql-pro/references/window-functions.md +328 -328
  267. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  268. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  269. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  270. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  271. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  272. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  273. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  274. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  275. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  276. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  277. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  278. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  279. package/skills/frontend/angular-architect/SKILL.md +152 -152
  280. package/skills/frontend/angular-architect/references/components.md +297 -297
  281. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  282. package/skills/frontend/angular-architect/references/routing.md +361 -361
  283. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  284. package/skills/frontend/angular-architect/references/testing.md +405 -405
  285. package/skills/frontend/design-commands/design.md +91 -91
  286. package/skills/frontend/design-commands/handoff.md +97 -97
  287. package/skills/frontend/design-commands/prototype.md +120 -120
  288. package/skills/frontend/design-commands/spec.md +160 -160
  289. package/skills/frontend/design-commands/style.md +78 -78
  290. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  291. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  292. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  293. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  294. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  295. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  296. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  297. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  298. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  299. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  300. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  301. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  302. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  303. package/skills/frontend/react-expert/SKILL.md +149 -149
  304. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  305. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  306. package/skills/frontend/react-expert/references/performance.md +168 -168
  307. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  308. package/skills/frontend/react-expert/references/server-components.md +143 -143
  309. package/skills/frontend/react-expert/references/state-management.md +171 -171
  310. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  311. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  312. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  313. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  314. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  315. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  316. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  317. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  318. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  319. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  320. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  321. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  322. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  323. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  324. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  325. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  326. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  327. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  328. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  329. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  330. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  339. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  340. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  341. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  342. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  343. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  344. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  345. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  346. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  347. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  348. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  349. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  350. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  351. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  352. package/skills/frontend/vue-expert/SKILL.md +98 -98
  353. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  354. package/skills/frontend/vue-expert/references/components.md +448 -448
  355. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  356. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  357. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  358. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  359. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  360. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  361. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  362. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  363. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  364. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  365. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  366. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  367. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  368. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  369. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  370. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  371. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  372. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  373. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  374. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  375. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  376. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  377. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  378. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  379. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  380. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  381. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  382. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  383. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  384. package/skills/infra/cli-developer/SKILL.md +113 -113
  385. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  386. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  387. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  388. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  389. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  390. package/skills/infra/cloud-architect/SKILL.md +216 -216
  391. package/skills/infra/cloud-architect/references/aws.md +394 -394
  392. package/skills/infra/cloud-architect/references/azure.md +562 -562
  393. package/skills/infra/cloud-architect/references/cost.md +582 -582
  394. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  395. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  396. package/skills/infra/devops-engineer/SKILL.md +144 -144
  397. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  398. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  399. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  400. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  401. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  402. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  403. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  404. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  405. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  406. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  407. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  408. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  409. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  410. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  411. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  412. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  413. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  414. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  415. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  416. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  417. package/skills/infra/mcp-developer/SKILL.md +143 -143
  418. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  419. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  420. package/skills/infra/mcp-developer/references/resources.md +554 -554
  421. package/skills/infra/mcp-developer/references/tools.md +480 -480
  422. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  423. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  424. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  425. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  426. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  427. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  428. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  429. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  430. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  431. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  432. package/skills/infra/sre-engineer/SKILL.md +181 -181
  433. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  434. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  435. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  436. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  437. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  438. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  439. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  440. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  441. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  442. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  443. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  444. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  445. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  446. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  447. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  448. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  449. package/skills/infra/websocket-engineer/references/security.md +474 -474
  450. package/skills/java/java-architect/SKILL.md +132 -132
  451. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  452. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  453. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  454. package/skills/java/java-architect/references/spring-security.md +445 -445
  455. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  456. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  457. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  458. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  459. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  460. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  461. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  462. package/skills/java/spring-boot-engineer/SKILL.md +195 -195
  463. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  464. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  465. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  466. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  467. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  468. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  469. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  470. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  471. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  472. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  473. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  474. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  475. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  476. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  477. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  478. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  479. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  480. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  481. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  482. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  483. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  484. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  485. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  486. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  487. package/skills/php/laravel-specialist/SKILL.md +262 -262
  488. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  489. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  490. package/skills/php/laravel-specialist/references/queues.md +423 -423
  491. package/skills/php/laravel-specialist/references/routing.md +362 -362
  492. package/skills/php/laravel-specialist/references/testing.md +522 -522
  493. package/skills/php/php-pro/SKILL.md +206 -206
  494. package/skills/php/php-pro/references/async-patterns.md +412 -412
  495. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  496. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  497. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  498. package/skills/php/php-pro/references/testing-quality.md +466 -466
  499. package/skills/product/competitive-analysis/SKILL.md +257 -257
  500. package/skills/product/meeting-notes/SKILL.md +266 -266
  501. package/skills/product/prd-template/SKILL.md +150 -150
  502. package/skills/product/stakeholder-update/SKILL.md +225 -225
  503. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  504. package/skills/python/django-expert/SKILL.md +162 -162
  505. package/skills/python/django-expert/references/authentication.md +145 -145
  506. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  507. package/skills/python/django-expert/references/models-orm.md +151 -151
  508. package/skills/python/django-expert/references/testing-django.md +204 -204
  509. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  510. package/skills/python/fastapi-expert/SKILL.md +185 -185
  511. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  512. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  513. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  514. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  515. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  516. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  517. package/skills/python/pandas-pro/SKILL.md +178 -178
  518. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  519. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  520. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  521. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  522. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  523. package/skills/python/python-pro/SKILL.md +177 -177
  524. package/skills/python/python-pro/references/async-patterns.md +356 -356
  525. package/skills/python/python-pro/references/packaging.md +460 -460
  526. package/skills/python/python-pro/references/standard-library.md +378 -378
  527. package/skills/python/python-pro/references/testing.md +404 -404
  528. package/skills/python/python-pro/references/type-system.md +290 -290
  529. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  530. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  531. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  532. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  533. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  534. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  535. package/skills/quality/code-reviewer/SKILL.md +119 -119
  536. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  537. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  538. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  539. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  540. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  541. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  542. package/skills/quality/playwright-expert/SKILL.md +169 -169
  543. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  544. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  545. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  546. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  547. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  548. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  549. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  550. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  551. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  552. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  553. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  554. package/skills/quality/security-reviewer/SKILL.md +103 -103
  555. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  556. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  557. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  558. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  559. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  560. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  561. package/skills/quality/senior-qa/README.md +196 -196
  562. package/skills/quality/senior-qa/SKILL.md +399 -399
  563. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  564. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  565. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  566. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  567. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  568. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  569. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  570. package/skills/quality/tdd-guide/README.md +680 -680
  571. package/skills/quality/tdd-guide/SKILL.md +122 -122
  572. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  573. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  574. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  575. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  576. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  577. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  578. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  579. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  580. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  581. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  582. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  583. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  584. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  585. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  586. package/skills/quality/test-master/SKILL.md +94 -94
  587. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  588. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  589. package/skills/quality/test-master/references/integration-testing.md +120 -120
  590. package/skills/quality/test-master/references/performance-testing.md +118 -118
  591. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  592. package/skills/quality/test-master/references/security-testing.md +127 -127
  593. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  594. package/skills/quality/test-master/references/test-reports.md +104 -104
  595. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  596. package/skills/quality/test-master/references/unit-testing.md +113 -113
  597. package/skills/ruby/rails-expert/SKILL.md +154 -154
  598. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  599. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  600. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  601. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  602. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  603. package/skills/swift/swift-expert/SKILL.md +163 -163
  604. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  605. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  606. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  607. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  608. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  609. package/skills/workflow/brainstorming/SKILL.md +164 -164
  610. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  611. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  612. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  613. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  614. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  615. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  616. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  617. package/skills/workflow/documentation/SKILL.md +45 -45
  618. package/skills/workflow/entropy-management/SKILL.md +115 -115
  619. package/skills/workflow/executing-plans/SKILL.md +70 -70
  620. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  621. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  622. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  623. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  624. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  625. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  626. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  627. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  628. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  629. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  630. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  631. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  632. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  633. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  634. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  635. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  636. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  637. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  638. package/skills/workflow/writing-plans/SKILL.md +151 -151
  639. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  640. package/skills/workflow/writing-skills/SKILL.md +655 -655
  641. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  642. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  643. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  644. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  645. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,1150 +1,1150 @@
1
- # Skill authoring best practices
2
-
3
- > Learn how to write effective Skills that Claude can discover and use successfully.
4
-
5
- Good Skills are concise, well-structured, and tested with real usage. This guide provides practical authoring decisions to help you write Skills that Claude can discover and use effectively.
6
-
7
- For conceptual background on how Skills work, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview).
8
-
9
- ## Core principles
10
-
11
- ### Concise is key
12
-
13
- The [context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) is a public good. Your Skill shares the context window with everything else Claude needs to know, including:
14
-
15
- * The system prompt
16
- * Conversation history
17
- * Other Skills' metadata
18
- * Your actual request
19
-
20
- Not every token in your Skill has an immediate cost. At startup, only the metadata (name and description) from all Skills is pre-loaded. Claude reads SKILL.md only when the Skill becomes relevant, and reads additional files only as needed. However, being concise in SKILL.md still matters: once Claude loads it, every token competes with conversation history and other context.
21
-
22
- **Default assumption**: Claude is already very smart
23
-
24
- Only add context Claude doesn't already have. Challenge each piece of information:
25
-
26
- * "Does Claude really need this explanation?"
27
- * "Can I assume Claude knows this?"
28
- * "Does this paragraph justify its token cost?"
29
-
30
- **Good example: Concise** (approximately 50 tokens):
31
-
32
- ````markdown theme={null}
33
- ## Extract PDF text
34
-
35
- Use pdfplumber for text extraction:
36
-
37
- ```python
38
- import pdfplumber
39
-
40
- with pdfplumber.open("file.pdf") as pdf:
41
- text = pdf.pages[0].extract_text()
42
- ```
43
- ````
44
-
45
- **Bad example: Too verbose** (approximately 150 tokens):
46
-
47
- ```markdown theme={null}
48
- ## Extract PDF text
49
-
50
- PDF (Portable Document Format) files are a common file format that contains
51
- text, images, and other content. To extract text from a PDF, you'll need to
52
- use a library. There are many libraries available for PDF processing, but we
53
- recommend pdfplumber because it's easy to use and handles most cases well.
54
- First, you'll need to install it using pip. Then you can use the code below...
55
- ```
56
-
57
- The concise version assumes Claude knows what PDFs are and how libraries work.
58
-
59
- ### Set appropriate degrees of freedom
60
-
61
- Match the level of specificity to the task's fragility and variability.
62
-
63
- **High freedom** (text-based instructions):
64
-
65
- Use when:
66
-
67
- * Multiple approaches are valid
68
- * Decisions depend on context
69
- * Heuristics guide the approach
70
-
71
- Example:
72
-
73
- ```markdown theme={null}
74
- ## Code review process
75
-
76
- 1. Analyze the code structure and organization
77
- 2. Check for potential bugs or edge cases
78
- 3. Suggest improvements for readability and maintainability
79
- 4. Verify adherence to project conventions
80
- ```
81
-
82
- **Medium freedom** (pseudocode or scripts with parameters):
83
-
84
- Use when:
85
-
86
- * A preferred pattern exists
87
- * Some variation is acceptable
88
- * Configuration affects behavior
89
-
90
- Example:
91
-
92
- ````markdown theme={null}
93
- ## Generate report
94
-
95
- Use this template and customize as needed:
96
-
97
- ```python
98
- def generate_report(data, format="markdown", include_charts=True):
99
- # Process data
100
- # Generate output in specified format
101
- # Optionally include visualizations
102
- ```
103
- ````
104
-
105
- **Low freedom** (specific scripts, few or no parameters):
106
-
107
- Use when:
108
-
109
- * Operations are fragile and error-prone
110
- * Consistency is critical
111
- * A specific sequence must be followed
112
-
113
- Example:
114
-
115
- ````markdown theme={null}
116
- ## Database migration
117
-
118
- Run exactly this script:
119
-
120
- ```bash
121
- python scripts/migrate.py --verify --backup
122
- ```
123
-
124
- Do not modify the command or add additional flags.
125
- ````
126
-
127
- **Analogy**: Think of Claude as a robot exploring a path:
128
-
129
- * **Narrow bridge with cliffs on both sides**: There's only one safe way forward. Provide specific guardrails and exact instructions (low freedom). Example: database migrations that must run in exact sequence.
130
- * **Open field with no hazards**: Many paths lead to success. Give general direction and trust Claude to find the best route (high freedom). Example: code reviews where context determines the best approach.
131
-
132
- ### Test with all models you plan to use
133
-
134
- Skills act as additions to models, so effectiveness depends on the underlying model. Test your Skill with all the models you plan to use it with.
135
-
136
- **Testing considerations by model**:
137
-
138
- * **Claude Haiku** (fast, economical): Does the Skill provide enough guidance?
139
- * **Claude Sonnet** (balanced): Is the Skill clear and efficient?
140
- * **Claude Opus** (powerful reasoning): Does the Skill avoid over-explaining?
141
-
142
- What works perfectly for Opus might need more detail for Haiku. If you plan to use your Skill across multiple models, aim for instructions that work well with all of them.
143
-
144
- ## Skill structure
145
-
146
- <Note>
147
- **YAML Frontmatter**: The SKILL.md frontmatter requires two fields:
148
-
149
- * `name` - Human-readable name of the Skill (64 characters maximum)
150
- * `description` - One-line description of what the Skill does and when to use it (1024 characters maximum)
151
-
152
- For complete Skill structure details, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure).
153
- </Note>
154
-
155
- ### Naming conventions
156
-
157
- Use consistent naming patterns to make Skills easier to reference and discuss. We recommend using **gerund form** (verb + -ing) for Skill names, as this clearly describes the activity or capability the Skill provides.
158
-
159
- **Good naming examples (gerund form)**:
160
-
161
- * "Processing PDFs"
162
- * "Analyzing spreadsheets"
163
- * "Managing databases"
164
- * "Testing code"
165
- * "Writing documentation"
166
-
167
- **Acceptable alternatives**:
168
-
169
- * Noun phrases: "PDF Processing", "Spreadsheet Analysis"
170
- * Action-oriented: "Process PDFs", "Analyze Spreadsheets"
171
-
172
- **Avoid**:
173
-
174
- * Vague names: "Helper", "Utils", "Tools"
175
- * Overly generic: "Documents", "Data", "Files"
176
- * Inconsistent patterns within your skill collection
177
-
178
- Consistent naming makes it easier to:
179
-
180
- * Reference Skills in documentation and conversations
181
- * Understand what a Skill does at a glance
182
- * Organize and search through multiple Skills
183
- * Maintain a professional, cohesive skill library
184
-
185
- ### Writing effective descriptions
186
-
187
- The `description` field enables Skill discovery and should include both what the Skill does and when to use it.
188
-
189
- <Warning>
190
- **Always write in third person**. The description is injected into the system prompt, and inconsistent point-of-view can cause discovery problems.
191
-
192
- * **Good:** "Processes Excel files and generates reports"
193
- * **Avoid:** "I can help you process Excel files"
194
- * **Avoid:** "You can use this to process Excel files"
195
- </Warning>
196
-
197
- **Be specific and include key terms**. Include both what the Skill does and specific triggers/contexts for when to use it.
198
-
199
- Each Skill has exactly one description field. The description is critical for skill selection: Claude uses it to choose the right Skill from potentially 100+ available Skills. Your description must provide enough detail for Claude to know when to select this Skill, while the rest of SKILL.md provides the implementation details.
200
-
201
- Effective examples:
202
-
203
- **PDF Processing skill:**
204
-
205
- ```yaml theme={null}
206
- description: Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.
207
- ```
208
-
209
- **Excel Analysis skill:**
210
-
211
- ```yaml theme={null}
212
- description: Analyze Excel spreadsheets, create pivot tables, generate charts. Use when analyzing Excel files, spreadsheets, tabular data, or .xlsx files.
213
- ```
214
-
215
- **Git Commit Helper skill:**
216
-
217
- ```yaml theme={null}
218
- description: Generate descriptive commit messages by analyzing git diffs. Use when the user asks for help writing commit messages or reviewing staged changes.
219
- ```
220
-
221
- Avoid vague descriptions like these:
222
-
223
- ```yaml theme={null}
224
- description: Helps with documents
225
- ```
226
-
227
- ```yaml theme={null}
228
- description: Processes data
229
- ```
230
-
231
- ```yaml theme={null}
232
- description: Does stuff with files
233
- ```
234
-
235
- ### Progressive disclosure patterns
236
-
237
- SKILL.md serves as an overview that points Claude to detailed materials as needed, like a table of contents in an onboarding guide. For an explanation of how progressive disclosure works, see [How Skills work](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work) in the overview.
238
-
239
- **Practical guidance:**
240
-
241
- * Keep SKILL.md body under 500 lines for optimal performance
242
- * Split content into separate files when approaching this limit
243
- * Use the patterns below to organize instructions, code, and resources effectively
244
-
245
- #### Visual overview: From simple to complex
246
-
247
- A basic Skill starts with just a SKILL.md file containing metadata and instructions:
248
-
249
- <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=87782ff239b297d9a9e8e1b72ed72db9" alt="Simple SKILL.md file showing YAML frontmatter and markdown body" data-og-width="2048" width="2048" data-og-height="1153" height="1153" data-path="images/agent-skills-simple-file.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=c61cc33b6f5855809907f7fda94cd80e 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=90d2c0c1c76b36e8d485f49e0810dbfd 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=ad17d231ac7b0bea7e5b4d58fb4aeabb 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=f5d0a7a3c668435bb0aee9a3a8f8c329 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=0e927c1af9de5799cfe557d12249f6e6 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=46bbb1a51dd4c8202a470ac8c80a893d 2500w" />
250
-
251
- As your Skill grows, you can bundle additional content that Claude loads only when needed:
252
-
253
- <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=a5e0aa41e3d53985a7e3e43668a33ea3" alt="Bundling additional reference files like reference.md and forms.md." data-og-width="2048" width="2048" data-og-height="1327" height="1327" data-path="images/agent-skills-bundling-content.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=f8a0e73783e99b4a643d79eac86b70a2 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=dc510a2a9d3f14359416b706f067904a 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=82cd6286c966303f7dd914c28170e385 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=56f3be36c77e4fe4b523df209a6824c6 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=d22b5161b2075656417d56f41a74f3dd 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=3dd4bdd6850ffcc96c6c45fcb0acd6eb 2500w" />
254
-
255
- The complete Skill directory structure might look like this:
256
-
257
- ```
258
- pdf/
259
- ├── SKILL.md # Main instructions (loaded when triggered)
260
- ├── FORMS.md # Form-filling guide (loaded as needed)
261
- ├── reference.md # API reference (loaded as needed)
262
- ├── examples.md # Usage examples (loaded as needed)
263
- └── scripts/
264
- ├── analyze_form.py # Utility script (executed, not loaded)
265
- ├── fill_form.py # Form filling script
266
- └── validate.py # Validation script
267
- ```
268
-
269
- #### Pattern 1: High-level guide with references
270
-
271
- ````markdown theme={null}
272
- ---
273
- name: PDF Processing
274
- description: Extracts text and tables from PDF files, fills forms, and merges documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.
275
- ---
276
-
277
- # PDF Processing
278
-
279
- ## Quick start
280
-
281
- Extract text with pdfplumber:
282
- ```python
283
- import pdfplumber
284
- with pdfplumber.open("file.pdf") as pdf:
285
- text = pdf.pages[0].extract_text()
286
- ```
287
-
288
- ## Advanced features
289
-
290
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
291
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
292
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
293
- ````
294
-
295
- Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
296
-
297
- #### Pattern 2: Domain-specific organization
298
-
299
- For Skills with multiple domains, organize content by domain to avoid loading irrelevant context. When a user asks about sales metrics, Claude only needs to read sales-related schemas, not finance or marketing data. This keeps token usage low and context focused.
300
-
301
- ```
302
- bigquery-skill/
303
- ├── SKILL.md (overview and navigation)
304
- └── reference/
305
- ├── finance.md (revenue, billing metrics)
306
- ├── sales.md (opportunities, pipeline)
307
- ├── product.md (API usage, features)
308
- └── marketing.md (campaigns, attribution)
309
- ```
310
-
311
- ````markdown SKILL.md theme={null}
312
- # BigQuery Data Analysis
313
-
314
- ## Available datasets
315
-
316
- **Finance**: Revenue, ARR, billing → See [reference/finance.md](reference/finance.md)
317
- **Sales**: Opportunities, pipeline, accounts → See [reference/sales.md](reference/sales.md)
318
- **Product**: API usage, features, adoption → See [reference/product.md](reference/product.md)
319
- **Marketing**: Campaigns, attribution, email → See [reference/marketing.md](reference/marketing.md)
320
-
321
- ## Quick search
322
-
323
- Find specific metrics using grep:
324
-
325
- ```bash
326
- grep -i "revenue" reference/finance.md
327
- grep -i "pipeline" reference/sales.md
328
- grep -i "api usage" reference/product.md
329
- ```
330
- ````
331
-
332
- #### Pattern 3: Conditional details
333
-
334
- Show basic content, link to advanced content:
335
-
336
- ```markdown theme={null}
337
- # DOCX Processing
338
-
339
- ## Creating documents
340
-
341
- Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
342
-
343
- ## Editing documents
344
-
345
- For simple edits, modify the XML directly.
346
-
347
- **For tracked changes**: See [REDLINING.md](REDLINING.md)
348
- **For OOXML details**: See [OOXML.md](OOXML.md)
349
- ```
350
-
351
- Claude reads REDLINING.md or OOXML.md only when the user needs those features.
352
-
353
- ### Avoid deeply nested references
354
-
355
- Claude may partially read files when they're referenced from other referenced files. When encountering nested references, Claude might use commands like `head -100` to preview content rather than reading entire files, resulting in incomplete information.
356
-
357
- **Keep references one level deep from SKILL.md**. All reference files should link directly from SKILL.md to ensure Claude reads complete files when needed.
358
-
359
- **Bad example: Too deep**:
360
-
361
- ```markdown theme={null}
362
- # SKILL.md
363
- See [advanced.md](advanced.md)...
364
-
365
- # advanced.md
366
- See [details.md](details.md)...
367
-
368
- # details.md
369
- Here's the actual information...
370
- ```
371
-
372
- **Good example: One level deep**:
373
-
374
- ```markdown theme={null}
375
- # SKILL.md
376
-
377
- **Basic usage**: [instructions in SKILL.md]
378
- **Advanced features**: See [advanced.md](advanced.md)
379
- **API reference**: See [reference.md](reference.md)
380
- **Examples**: See [examples.md](examples.md)
381
- ```
382
-
383
- ### Structure longer reference files with table of contents
384
-
385
- For reference files longer than 100 lines, include a table of contents at the top. This ensures Claude can see the full scope of available information even when previewing with partial reads.
386
-
387
- **Example**:
388
-
389
- ```markdown theme={null}
390
- # API Reference
391
-
392
- ## Contents
393
- - Authentication and setup
394
- - Core methods (create, read, update, delete)
395
- - Advanced features (batch operations, webhooks)
396
- - Error handling patterns
397
- - Code examples
398
-
399
- ## Authentication and setup
400
- ...
401
-
402
- ## Core methods
403
- ...
404
- ```
405
-
406
- Claude can then read the complete file or jump to specific sections as needed.
407
-
408
- For details on how this filesystem-based architecture enables progressive disclosure, see the [Runtime environment](#runtime-environment) section in the Advanced section below.
409
-
410
- ## Workflows and feedback loops
411
-
412
- ### Use workflows for complex tasks
413
-
414
- Break complex operations into clear, sequential steps. For particularly complex workflows, provide a checklist that Claude can copy into its response and check off as it progresses.
415
-
416
- **Example 1: Research synthesis workflow** (for Skills without code):
417
-
418
- ````markdown theme={null}
419
- ## Research synthesis workflow
420
-
421
- Copy this checklist and track your progress:
422
-
423
- ```
424
- Research Progress:
425
- - [ ] Step 1: Read all source documents
426
- - [ ] Step 2: Identify key themes
427
- - [ ] Step 3: Cross-reference claims
428
- - [ ] Step 4: Create structured summary
429
- - [ ] Step 5: Verify citations
430
- ```
431
-
432
- **Step 1: Read all source documents**
433
-
434
- Review each document in the `sources/` directory. Note the main arguments and supporting evidence.
435
-
436
- **Step 2: Identify key themes**
437
-
438
- Look for patterns across sources. What themes appear repeatedly? Where do sources agree or disagree?
439
-
440
- **Step 3: Cross-reference claims**
441
-
442
- For each major claim, verify it appears in the source material. Note which source supports each point.
443
-
444
- **Step 4: Create structured summary**
445
-
446
- Organize findings by theme. Include:
447
- - Main claim
448
- - Supporting evidence from sources
449
- - Conflicting viewpoints (if any)
450
-
451
- **Step 5: Verify citations**
452
-
453
- Check that every claim references the correct source document. If citations are incomplete, return to Step 3.
454
- ````
455
-
456
- This example shows how workflows apply to analysis tasks that don't require code. The checklist pattern works for any complex, multi-step process.
457
-
458
- **Example 2: PDF form filling workflow** (for Skills with code):
459
-
460
- ````markdown theme={null}
461
- ## PDF form filling workflow
462
-
463
- Copy this checklist and check off items as you complete them:
464
-
465
- ```
466
- Task Progress:
467
- - [ ] Step 1: Analyze the form (run analyze_form.py)
468
- - [ ] Step 2: Create field mapping (edit fields.json)
469
- - [ ] Step 3: Validate mapping (run validate_fields.py)
470
- - [ ] Step 4: Fill the form (run fill_form.py)
471
- - [ ] Step 5: Verify output (run verify_output.py)
472
- ```
473
-
474
- **Step 1: Analyze the form**
475
-
476
- Run: `python scripts/analyze_form.py input.pdf`
477
-
478
- This extracts form fields and their locations, saving to `fields.json`.
479
-
480
- **Step 2: Create field mapping**
481
-
482
- Edit `fields.json` to add values for each field.
483
-
484
- **Step 3: Validate mapping**
485
-
486
- Run: `python scripts/validate_fields.py fields.json`
487
-
488
- Fix any validation errors before continuing.
489
-
490
- **Step 4: Fill the form**
491
-
492
- Run: `python scripts/fill_form.py input.pdf fields.json output.pdf`
493
-
494
- **Step 5: Verify output**
495
-
496
- Run: `python scripts/verify_output.py output.pdf`
497
-
498
- If verification fails, return to Step 2.
499
- ````
500
-
501
- Clear steps prevent Claude from skipping critical validation. The checklist helps both Claude and you track progress through multi-step workflows.
502
-
503
- ### Implement feedback loops
504
-
505
- **Common pattern**: Run validator → fix errors → repeat
506
-
507
- This pattern greatly improves output quality.
508
-
509
- **Example 1: Style guide compliance** (for Skills without code):
510
-
511
- ```markdown theme={null}
512
- ## Content review process
513
-
514
- 1. Draft your content following the guidelines in STYLE_GUIDE.md
515
- 2. Review against the checklist:
516
- - Check terminology consistency
517
- - Verify examples follow the standard format
518
- - Confirm all required sections are present
519
- 3. If issues found:
520
- - Note each issue with specific section reference
521
- - Revise the content
522
- - Review the checklist again
523
- 4. Only proceed when all requirements are met
524
- 5. Finalize and save the document
525
- ```
526
-
527
- This shows the validation loop pattern using reference documents instead of scripts. The "validator" is STYLE\_GUIDE.md, and Claude performs the check by reading and comparing.
528
-
529
- **Example 2: Document editing process** (for Skills with code):
530
-
531
- ```markdown theme={null}
532
- ## Document editing process
533
-
534
- 1. Make your edits to `word/document.xml`
535
- 2. **Validate immediately**: `python ooxml/scripts/validate.py unpacked_dir/`
536
- 3. If validation fails:
537
- - Review the error message carefully
538
- - Fix the issues in the XML
539
- - Run validation again
540
- 4. **Only proceed when validation passes**
541
- 5. Rebuild: `python ooxml/scripts/pack.py unpacked_dir/ output.docx`
542
- 6. Test the output document
543
- ```
544
-
545
- The validation loop catches errors early.
546
-
547
- ## Content guidelines
548
-
549
- ### Avoid time-sensitive information
550
-
551
- Don't include information that will become outdated:
552
-
553
- **Bad example: Time-sensitive** (will become wrong):
554
-
555
- ```markdown theme={null}
556
- If you're doing this before August 2025, use the old API.
557
- After August 2025, use the new API.
558
- ```
559
-
560
- **Good example** (use "old patterns" section):
561
-
562
- ```markdown theme={null}
563
- ## Current method
564
-
565
- Use the v2 API endpoint: `api.example.com/v2/messages`
566
-
567
- ## Old patterns
568
-
569
- <details>
570
- <summary>Legacy v1 API (deprecated 2025-08)</summary>
571
-
572
- The v1 API used: `api.example.com/v1/messages`
573
-
574
- This endpoint is no longer supported.
575
- </details>
576
- ```
577
-
578
- The old patterns section provides historical context without cluttering the main content.
579
-
580
- ### Use consistent terminology
581
-
582
- Choose one term and use it throughout the Skill:
583
-
584
- **Good - Consistent**:
585
-
586
- * Always "API endpoint"
587
- * Always "field"
588
- * Always "extract"
589
-
590
- **Bad - Inconsistent**:
591
-
592
- * Mix "API endpoint", "URL", "API route", "path"
593
- * Mix "field", "box", "element", "control"
594
- * Mix "extract", "pull", "get", "retrieve"
595
-
596
- Consistency helps Claude understand and follow instructions.
597
-
598
- ## Common patterns
599
-
600
- ### Template pattern
601
-
602
- Provide templates for output format. Match the level of strictness to your needs.
603
-
604
- **For strict requirements** (like API responses or data formats):
605
-
606
- ````markdown theme={null}
607
- ## Report structure
608
-
609
- ALWAYS use this exact template structure:
610
-
611
- ```markdown
612
- # [Analysis Title]
613
-
614
- ## Executive summary
615
- [One-paragraph overview of key findings]
616
-
617
- ## Key findings
618
- - Finding 1 with supporting data
619
- - Finding 2 with supporting data
620
- - Finding 3 with supporting data
621
-
622
- ## Recommendations
623
- 1. Specific actionable recommendation
624
- 2. Specific actionable recommendation
625
- ```
626
- ````
627
-
628
- **For flexible guidance** (when adaptation is useful):
629
-
630
- ````markdown theme={null}
631
- ## Report structure
632
-
633
- Here is a sensible default format, but use your best judgment based on the analysis:
634
-
635
- ```markdown
636
- # [Analysis Title]
637
-
638
- ## Executive summary
639
- [Overview]
640
-
641
- ## Key findings
642
- [Adapt sections based on what you discover]
643
-
644
- ## Recommendations
645
- [Tailor to the specific context]
646
- ```
647
-
648
- Adjust sections as needed for the specific analysis type.
649
- ````
650
-
651
- ### Examples pattern
652
-
653
- For Skills where output quality depends on seeing examples, provide input/output pairs just like in regular prompting:
654
-
655
- ````markdown theme={null}
656
- ## Commit message format
657
-
658
- Generate commit messages following these examples:
659
-
660
- **Example 1:**
661
- Input: Added user authentication with JWT tokens
662
- Output:
663
- ```
664
- feat(auth): implement JWT-based authentication
665
-
666
- Add login endpoint and token validation middleware
667
- ```
668
-
669
- **Example 2:**
670
- Input: Fixed bug where dates displayed incorrectly in reports
671
- Output:
672
- ```
673
- fix(reports): correct date formatting in timezone conversion
674
-
675
- Use UTC timestamps consistently across report generation
676
- ```
677
-
678
- **Example 3:**
679
- Input: Updated dependencies and refactored error handling
680
- Output:
681
- ```
682
- chore: update dependencies and refactor error handling
683
-
684
- - Upgrade lodash to 4.17.21
685
- - Standardize error response format across endpoints
686
- ```
687
-
688
- Follow this style: type(scope): brief description, then detailed explanation.
689
- ````
690
-
691
- Examples help Claude understand the desired style and level of detail more clearly than descriptions alone.
692
-
693
- ### Conditional workflow pattern
694
-
695
- Guide Claude through decision points:
696
-
697
- ```markdown theme={null}
698
- ## Document modification workflow
699
-
700
- 1. Determine the modification type:
701
-
702
- **Creating new content?** → Follow "Creation workflow" below
703
- **Editing existing content?** → Follow "Editing workflow" below
704
-
705
- 2. Creation workflow:
706
- - Use docx-js library
707
- - Build document from scratch
708
- - Export to .docx format
709
-
710
- 3. Editing workflow:
711
- - Unpack existing document
712
- - Modify XML directly
713
- - Validate after each change
714
- - Repack when complete
715
- ```
716
-
717
- <Tip>
718
- If workflows become large or complicated with many steps, consider pushing them into separate files and tell Claude to read the appropriate file based on the task at hand.
719
- </Tip>
720
-
721
- ## Evaluation and iteration
722
-
723
- ### Build evaluations first
724
-
725
- **Create evaluations BEFORE writing extensive documentation.** This ensures your Skill solves real problems rather than documenting imagined ones.
726
-
727
- **Evaluation-driven development:**
728
-
729
- 1. **Identify gaps**: Run Claude on representative tasks without a Skill. Document specific failures or missing context
730
- 2. **Create evaluations**: Build three scenarios that test these gaps
731
- 3. **Establish baseline**: Measure Claude's performance without the Skill
732
- 4. **Write minimal instructions**: Create just enough content to address the gaps and pass evaluations
733
- 5. **Iterate**: Execute evaluations, compare against baseline, and refine
734
-
735
- This approach ensures you're solving actual problems rather than anticipating requirements that may never materialize.
736
-
737
- **Evaluation structure**:
738
-
739
- ```json theme={null}
740
- {
741
- "skills": ["pdf-processing"],
742
- "query": "Extract all text from this PDF file and save it to output.txt",
743
- "files": ["test-files/document.pdf"],
744
- "expected_behavior": [
745
- "Successfully reads the PDF file using an appropriate PDF processing library or command-line tool",
746
- "Extracts text content from all pages in the document without missing any pages",
747
- "Saves the extracted text to a file named output.txt in a clear, readable format"
748
- ]
749
- }
750
- ```
751
-
752
- <Note>
753
- This example demonstrates a data-driven evaluation with a simple testing rubric. We do not currently provide a built-in way to run these evaluations. Users can create their own evaluation system. Evaluations are your source of truth for measuring Skill effectiveness.
754
- </Note>
755
-
756
- ### Develop Skills iteratively with Claude
757
-
758
- The most effective Skill development process involves Claude itself. Work with one instance of Claude ("Claude A") to create a Skill that will be used by other instances ("Claude B"). Claude A helps you design and refine instructions, while Claude B tests them in real tasks. This works because Claude models understand both how to write effective agent instructions and what information agents need.
759
-
760
- **Creating a new Skill:**
761
-
762
- 1. **Complete a task without a Skill**: Work through a problem with Claude A using normal prompting. As you work, you'll naturally provide context, explain preferences, and share procedural knowledge. Notice what information you repeatedly provide.
763
-
764
- 2. **Identify the reusable pattern**: After completing the task, identify what context you provided that would be useful for similar future tasks.
765
-
766
- **Example**: If you worked through a BigQuery analysis, you might have provided table names, field definitions, filtering rules (like "always exclude test accounts"), and common query patterns.
767
-
768
- 3. **Ask Claude A to create a Skill**: "Create a Skill that captures this BigQuery analysis pattern we just used. Include the table schemas, naming conventions, and the rule about filtering test accounts."
769
-
770
- <Tip>
771
- Claude models understand the Skill format and structure natively. You don't need special system prompts or a "writing skills" skill to get Claude to help create Skills. Simply ask Claude to create a Skill and it will generate properly structured SKILL.md content with appropriate frontmatter and body content.
772
- </Tip>
773
-
774
- 4. **Review for conciseness**: Check that Claude A hasn't added unnecessary explanations. Ask: "Remove the explanation about what win rate means - Claude already knows that."
775
-
776
- 5. **Improve information architecture**: Ask Claude A to organize the content more effectively. For example: "Organize this so the table schema is in a separate reference file. We might add more tables later."
777
-
778
- 6. **Test on similar tasks**: Use the Skill with Claude B (a fresh instance with the Skill loaded) on related use cases. Observe whether Claude B finds the right information, applies rules correctly, and handles the task successfully.
779
-
780
- 7. **Iterate based on observation**: If Claude B struggles or misses something, return to Claude A with specifics: "When Claude used this Skill, it forgot to filter by date for Q4. Should we add a section about date filtering patterns?"
781
-
782
- **Iterating on existing Skills:**
783
-
784
- The same hierarchical pattern continues when improving Skills. You alternate between:
785
-
786
- * **Working with Claude A** (the expert who helps refine the Skill)
787
- * **Testing with Claude B** (the agent using the Skill to perform real work)
788
- * **Observing Claude B's behavior** and bringing insights back to Claude A
789
-
790
- 1. **Use the Skill in real workflows**: Give Claude B (with the Skill loaded) actual tasks, not test scenarios
791
-
792
- 2. **Observe Claude B's behavior**: Note where it struggles, succeeds, or makes unexpected choices
793
-
794
- **Example observation**: "When I asked Claude B for a regional sales report, it wrote the query but forgot to filter out test accounts, even though the Skill mentions this rule."
795
-
796
- 3. **Return to Claude A for improvements**: Share the current SKILL.md and describe what you observed. Ask: "I noticed Claude B forgot to filter test accounts when I asked for a regional report. The Skill mentions filtering, but maybe it's not prominent enough?"
797
-
798
- 4. **Review Claude A's suggestions**: Claude A might suggest reorganizing to make rules more prominent, using stronger language like "MUST filter" instead of "always filter", or restructuring the workflow section.
799
-
800
- 5. **Apply and test changes**: Update the Skill with Claude A's refinements, then test again with Claude B on similar requests
801
-
802
- 6. **Repeat based on usage**: Continue this observe-refine-test cycle as you encounter new scenarios. Each iteration improves the Skill based on real agent behavior, not assumptions.
803
-
804
- **Gathering team feedback:**
805
-
806
- 1. Share Skills with teammates and observe their usage
807
- 2. Ask: Does the Skill activate when expected? Are instructions clear? What's missing?
808
- 3. Incorporate feedback to address blind spots in your own usage patterns
809
-
810
- **Why this approach works**: Claude A understands agent needs, you provide domain expertise, Claude B reveals gaps through real usage, and iterative refinement improves Skills based on observed behavior rather than assumptions.
811
-
812
- ### Observe how Claude navigates Skills
813
-
814
- As you iterate on Skills, pay attention to how Claude actually uses them in practice. Watch for:
815
-
816
- * **Unexpected exploration paths**: Does Claude read files in an order you didn't anticipate? This might indicate your structure isn't as intuitive as you thought
817
- * **Missed connections**: Does Claude fail to follow references to important files? Your links might need to be more explicit or prominent
818
- * **Overreliance on certain sections**: If Claude repeatedly reads the same file, consider whether that content should be in the main SKILL.md instead
819
- * **Ignored content**: If Claude never accesses a bundled file, it might be unnecessary or poorly signaled in the main instructions
820
-
821
- Iterate based on these observations rather than assumptions. The 'name' and 'description' in your Skill's metadata are particularly critical. Claude uses these when deciding whether to trigger the Skill in response to the current task. Make sure they clearly describe what the Skill does and when it should be used.
822
-
823
- ## Anti-patterns to avoid
824
-
825
- ### Avoid Windows-style paths
826
-
827
- Always use forward slashes in file paths, even on Windows:
828
-
829
- * ✓ **Good**: `scripts/helper.py`, `reference/guide.md`
830
- * ✗ **Avoid**: `scripts\helper.py`, `reference\guide.md`
831
-
832
- Unix-style paths work across all platforms, while Windows-style paths cause errors on Unix systems.
833
-
834
- ### Avoid offering too many options
835
-
836
- Don't present multiple approaches unless necessary:
837
-
838
- ````markdown theme={null}
839
- **Bad example: Too many choices** (confusing):
840
- "You can use pypdf, or pdfplumber, or PyMuPDF, or pdf2image, or..."
841
-
842
- **Good example: Provide a default** (with escape hatch):
843
- "Use pdfplumber for text extraction:
844
- ```python
845
- import pdfplumber
846
- ```
847
-
848
- For scanned PDFs requiring OCR, use pdf2image with pytesseract instead."
849
- ````
850
-
851
- ## Advanced: Skills with executable code
852
-
853
- The sections below focus on Skills that include executable scripts. If your Skill uses only markdown instructions, skip to [Checklist for effective Skills](#checklist-for-effective-skills).
854
-
855
- ### Solve, don't punt
856
-
857
- When writing scripts for Skills, handle error conditions rather than punting to Claude.
858
-
859
- **Good example: Handle errors explicitly**:
860
-
861
- ```python theme={null}
862
- def process_file(path):
863
- """Process a file, creating it if it doesn't exist."""
864
- try:
865
- with open(path) as f:
866
- return f.read()
867
- except FileNotFoundError:
868
- # Create file with default content instead of failing
869
- print(f"File {path} not found, creating default")
870
- with open(path, 'w') as f:
871
- f.write('')
872
- return ''
873
- except PermissionError:
874
- # Provide alternative instead of failing
875
- print(f"Cannot access {path}, using default")
876
- return ''
877
- ```
878
-
879
- **Bad example: Punt to Claude**:
880
-
881
- ```python theme={null}
882
- def process_file(path):
883
- # Just fail and let Claude figure it out
884
- return open(path).read()
885
- ```
886
-
887
- Configuration parameters should also be justified and documented to avoid "voodoo constants" (Ousterhout's law). If you don't know the right value, how will Claude determine it?
888
-
889
- **Good example: Self-documenting**:
890
-
891
- ```python theme={null}
892
- # HTTP requests typically complete within 30 seconds
893
- # Longer timeout accounts for slow connections
894
- REQUEST_TIMEOUT = 30
895
-
896
- # Three retries balances reliability vs speed
897
- # Most intermittent failures resolve by the second retry
898
- MAX_RETRIES = 3
899
- ```
900
-
901
- **Bad example: Magic numbers**:
902
-
903
- ```python theme={null}
904
- TIMEOUT = 47 # Why 47?
905
- RETRIES = 5 # Why 5?
906
- ```
907
-
908
- ### Provide utility scripts
909
-
910
- Even if Claude could write a script, pre-made scripts offer advantages:
911
-
912
- **Benefits of utility scripts**:
913
-
914
- * More reliable than generated code
915
- * Save tokens (no need to include code in context)
916
- * Save time (no code generation required)
917
- * Ensure consistency across uses
918
-
919
- <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=4bbc45f2c2e0bee9f2f0d5da669bad00" alt="Bundling executable scripts alongside instruction files" data-og-width="2048" width="2048" data-og-height="1154" height="1154" data-path="images/agent-skills-executable-scripts.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=9a04e6535a8467bfeea492e517de389f 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=e49333ad90141af17c0d7651cca7216b 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=954265a5df52223d6572b6214168c428 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=2ff7a2d8f2a83ee8af132b29f10150fd 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=48ab96245e04077f4d15e9170e081cfb 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=0301a6c8b3ee879497cc5b5483177c90 2500w" />
920
-
921
- The diagram above shows how executable scripts work alongside instruction files. The instruction file (forms.md) references the script, and Claude can execute it without loading its contents into context.
922
-
923
- **Important distinction**: Make clear in your instructions whether Claude should:
924
-
925
- * **Execute the script** (most common): "Run `analyze_form.py` to extract fields"
926
- * **Read it as reference** (for complex logic): "See `analyze_form.py` for the field extraction algorithm"
927
-
928
- For most utility scripts, execution is preferred because it's more reliable and efficient. See the [Runtime environment](#runtime-environment) section below for details on how script execution works.
929
-
930
- **Example**:
931
-
932
- ````markdown theme={null}
933
- ## Utility scripts
934
-
935
- **analyze_form.py**: Extract all form fields from PDF
936
-
937
- ```bash
938
- python scripts/analyze_form.py input.pdf > fields.json
939
- ```
940
-
941
- Output format:
942
- ```json
943
- {
944
- "field_name": {"type": "text", "x": 100, "y": 200},
945
- "signature": {"type": "sig", "x": 150, "y": 500}
946
- }
947
- ```
948
-
949
- **validate_boxes.py**: Check for overlapping bounding boxes
950
-
951
- ```bash
952
- python scripts/validate_boxes.py fields.json
953
- # Returns: "OK" or lists conflicts
954
- ```
955
-
956
- **fill_form.py**: Apply field values to PDF
957
-
958
- ```bash
959
- python scripts/fill_form.py input.pdf fields.json output.pdf
960
- ```
961
- ````
962
-
963
- ### Use visual analysis
964
-
965
- When inputs can be rendered as images, have Claude analyze them:
966
-
967
- ````markdown theme={null}
968
- ## Form layout analysis
969
-
970
- 1. Convert PDF to images:
971
- ```bash
972
- python scripts/pdf_to_images.py form.pdf
973
- ```
974
-
975
- 2. Analyze each page image to identify form fields
976
- 3. Claude can see field locations and types visually
977
- ````
978
-
979
- <Note>
980
- In this example, you'd need to write the `pdf_to_images.py` script.
981
- </Note>
982
-
983
- Claude's vision capabilities help understand layouts and structures.
984
-
985
- ### Create verifiable intermediate outputs
986
-
987
- When Claude performs complex, open-ended tasks, it can make mistakes. The "plan-validate-execute" pattern catches errors early by having Claude first create a plan in a structured format, then validate that plan with a script before executing it.
988
-
989
- **Example**: Imagine asking Claude to update 50 form fields in a PDF based on a spreadsheet. Without validation, Claude might reference non-existent fields, create conflicting values, miss required fields, or apply updates incorrectly.
990
-
991
- **Solution**: Use the workflow pattern shown above (PDF form filling), but add an intermediate `changes.json` file that gets validated before applying changes. The workflow becomes: analyze → **create plan file** → **validate plan** → execute → verify.
992
-
993
- **Why this pattern works:**
994
-
995
- * **Catches errors early**: Validation finds problems before changes are applied
996
- * **Machine-verifiable**: Scripts provide objective verification
997
- * **Reversible planning**: Claude can iterate on the plan without touching originals
998
- * **Clear debugging**: Error messages point to specific problems
999
-
1000
- **When to use**: Batch operations, destructive changes, complex validation rules, high-stakes operations.
1001
-
1002
- **Implementation tip**: Make validation scripts verbose with specific error messages like "Field 'signature\_date' not found. Available fields: customer\_name, order\_total, signature\_date\_signed" to help Claude fix issues.
1003
-
1004
- ### Package dependencies
1005
-
1006
- Skills run in the code execution environment with platform-specific limitations:
1007
-
1008
- * **claude.ai**: Can install packages from npm and PyPI and pull from GitHub repositories
1009
- * **Anthropic API**: Has no network access and no runtime package installation
1010
-
1011
- List required packages in your SKILL.md and verify they're available in the [code execution tool documentation](/en/docs/agents-and-tools/tool-use/code-execution-tool).
1012
-
1013
- ### Runtime environment
1014
-
1015
- Skills run in a code execution environment with filesystem access, bash commands, and code execution capabilities. For the conceptual explanation of this architecture, see [The Skills architecture](/en/docs/agents-and-tools/agent-skills/overview#the-skills-architecture) in the overview.
1016
-
1017
- **How this affects your authoring:**
1018
-
1019
- **How Claude accesses Skills:**
1020
-
1021
- 1. **Metadata pre-loaded**: At startup, the name and description from all Skills' YAML frontmatter are loaded into the system prompt
1022
- 2. **Files read on-demand**: Claude uses bash Read tools to access SKILL.md and other files from the filesystem when needed
1023
- 3. **Scripts executed efficiently**: Utility scripts can be executed via bash without loading their full contents into context. Only the script's output consumes tokens
1024
- 4. **No context penalty for large files**: Reference files, data, or documentation don't consume context tokens until actually read
1025
-
1026
- * **File paths matter**: Claude navigates your skill directory like a filesystem. Use forward slashes (`reference/guide.md`), not backslashes
1027
- * **Name files descriptively**: Use names that indicate content: `form_validation_rules.md`, not `doc2.md`
1028
- * **Organize for discovery**: Structure directories by domain or feature
1029
- * Good: `reference/finance.md`, `reference/sales.md`
1030
- * Bad: `docs/file1.md`, `docs/file2.md`
1031
- * **Bundle comprehensive resources**: Include complete API docs, extensive examples, large datasets; no context penalty until accessed
1032
- * **Prefer scripts for deterministic operations**: Write `validate_form.py` rather than asking Claude to generate validation code
1033
- * **Make execution intent clear**:
1034
- * "Run `analyze_form.py` to extract fields" (execute)
1035
- * "See `analyze_form.py` for the extraction algorithm" (read as reference)
1036
- * **Test file access patterns**: Verify Claude can navigate your directory structure by testing with real requests
1037
-
1038
- **Example:**
1039
-
1040
- ```
1041
- bigquery-skill/
1042
- ├── SKILL.md (overview, points to reference files)
1043
- └── reference/
1044
- ├── finance.md (revenue metrics)
1045
- ├── sales.md (pipeline data)
1046
- └── product.md (usage analytics)
1047
- ```
1048
-
1049
- When the user asks about revenue, Claude reads SKILL.md, sees the reference to `reference/finance.md`, and invokes bash to read just that file. The sales.md and product.md files remain on the filesystem, consuming zero context tokens until needed. This filesystem-based model is what enables progressive disclosure. Claude can navigate and selectively load exactly what each task requires.
1050
-
1051
- For complete details on the technical architecture, see [How Skills work](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work) in the Skills overview.
1052
-
1053
- ### MCP tool references
1054
-
1055
- If your Skill uses MCP (Model Context Protocol) tools, always use fully qualified tool names to avoid "tool not found" errors.
1056
-
1057
- **Format**: `ServerName:tool_name`
1058
-
1059
- **Example**:
1060
-
1061
- ```markdown theme={null}
1062
- Use the BigQuery:bigquery_schema tool to retrieve table schemas.
1063
- Use the GitHub:create_issue tool to create issues.
1064
- ```
1065
-
1066
- Where:
1067
-
1068
- * `BigQuery` and `GitHub` are MCP server names
1069
- * `bigquery_schema` and `create_issue` are the tool names within those servers
1070
-
1071
- Without the server prefix, Claude may fail to locate the tool, especially when multiple MCP servers are available.
1072
-
1073
- ### Avoid assuming tools are installed
1074
-
1075
- Don't assume packages are available:
1076
-
1077
- ````markdown theme={null}
1078
- **Bad example: Assumes installation**:
1079
- "Use the pdf library to process the file."
1080
-
1081
- **Good example: Explicit about dependencies**:
1082
- "Install required package: `pip install pypdf`
1083
-
1084
- Then use it:
1085
- ```python
1086
- from pypdf import PdfReader
1087
- reader = PdfReader("file.pdf")
1088
- ```"
1089
- ````
1090
-
1091
- ## Technical notes
1092
-
1093
- ### YAML frontmatter requirements
1094
-
1095
- The SKILL.md frontmatter requires `name` (64 characters max) and `description` (1024 characters max) fields. See the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure) for complete structure details.
1096
-
1097
- ### Token budgets
1098
-
1099
- Keep SKILL.md body under 500 lines for optimal performance. If your content exceeds this, split it into separate files using the progressive disclosure patterns described earlier. For architectural details, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work).
1100
-
1101
- ## Checklist for effective Skills
1102
-
1103
- Before sharing a Skill, verify:
1104
-
1105
- ### Core quality
1106
-
1107
- * [ ] Description is specific and includes key terms
1108
- * [ ] Description includes both what the Skill does and when to use it
1109
- * [ ] SKILL.md body is under 500 lines
1110
- * [ ] Additional details are in separate files (if needed)
1111
- * [ ] No time-sensitive information (or in "old patterns" section)
1112
- * [ ] Consistent terminology throughout
1113
- * [ ] Examples are concrete, not abstract
1114
- * [ ] File references are one level deep
1115
- * [ ] Progressive disclosure used appropriately
1116
- * [ ] Workflows have clear steps
1117
-
1118
- ### Code and scripts
1119
-
1120
- * [ ] Scripts solve problems rather than punt to Claude
1121
- * [ ] Error handling is explicit and helpful
1122
- * [ ] No "voodoo constants" (all values justified)
1123
- * [ ] Required packages listed in instructions and verified as available
1124
- * [ ] Scripts have clear documentation
1125
- * [ ] No Windows-style paths (all forward slashes)
1126
- * [ ] Validation/verification steps for critical operations
1127
- * [ ] Feedback loops included for quality-critical tasks
1128
-
1129
- ### Testing
1130
-
1131
- * [ ] At least three evaluations created
1132
- * [ ] Tested with Haiku, Sonnet, and Opus
1133
- * [ ] Tested with real usage scenarios
1134
- * [ ] Team feedback incorporated (if applicable)
1135
-
1136
- ## Next steps
1137
-
1138
- <CardGroup cols={2}>
1139
- <Card title="Get started with Agent Skills" icon="rocket" href="/en/docs/agents-and-tools/agent-skills/quickstart">
1140
- Create your first Skill
1141
- </Card>
1142
-
1143
- <Card title="Use Skills in Claude Code" icon="terminal" href="/en/docs/claude-code/skills">
1144
- Create and manage Skills in Claude Code
1145
- </Card>
1146
-
1147
- <Card title="Use Skills with the API" icon="code" href="/en/api/skills-guide">
1148
- Upload and use Skills programmatically
1149
- </Card>
1150
- </CardGroup>
1
+ # Skill authoring best practices
2
+
3
+ > Learn how to write effective Skills that Claude can discover and use successfully.
4
+
5
+ Good Skills are concise, well-structured, and tested with real usage. This guide provides practical authoring decisions to help you write Skills that Claude can discover and use effectively.
6
+
7
+ For conceptual background on how Skills work, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview).
8
+
9
+ ## Core principles
10
+
11
+ ### Concise is key
12
+
13
+ The [context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) is a public good. Your Skill shares the context window with everything else Claude needs to know, including:
14
+
15
+ * The system prompt
16
+ * Conversation history
17
+ * Other Skills' metadata
18
+ * Your actual request
19
+
20
+ Not every token in your Skill has an immediate cost. At startup, only the metadata (name and description) from all Skills is pre-loaded. Claude reads SKILL.md only when the Skill becomes relevant, and reads additional files only as needed. However, being concise in SKILL.md still matters: once Claude loads it, every token competes with conversation history and other context.
21
+
22
+ **Default assumption**: Claude is already very smart
23
+
24
+ Only add context Claude doesn't already have. Challenge each piece of information:
25
+
26
+ * "Does Claude really need this explanation?"
27
+ * "Can I assume Claude knows this?"
28
+ * "Does this paragraph justify its token cost?"
29
+
30
+ **Good example: Concise** (approximately 50 tokens):
31
+
32
+ ````markdown theme={null}
33
+ ## Extract PDF text
34
+
35
+ Use pdfplumber for text extraction:
36
+
37
+ ```python
38
+ import pdfplumber
39
+
40
+ with pdfplumber.open("file.pdf") as pdf:
41
+ text = pdf.pages[0].extract_text()
42
+ ```
43
+ ````
44
+
45
+ **Bad example: Too verbose** (approximately 150 tokens):
46
+
47
+ ```markdown theme={null}
48
+ ## Extract PDF text
49
+
50
+ PDF (Portable Document Format) files are a common file format that contains
51
+ text, images, and other content. To extract text from a PDF, you'll need to
52
+ use a library. There are many libraries available for PDF processing, but we
53
+ recommend pdfplumber because it's easy to use and handles most cases well.
54
+ First, you'll need to install it using pip. Then you can use the code below...
55
+ ```
56
+
57
+ The concise version assumes Claude knows what PDFs are and how libraries work.
58
+
59
+ ### Set appropriate degrees of freedom
60
+
61
+ Match the level of specificity to the task's fragility and variability.
62
+
63
+ **High freedom** (text-based instructions):
64
+
65
+ Use when:
66
+
67
+ * Multiple approaches are valid
68
+ * Decisions depend on context
69
+ * Heuristics guide the approach
70
+
71
+ Example:
72
+
73
+ ```markdown theme={null}
74
+ ## Code review process
75
+
76
+ 1. Analyze the code structure and organization
77
+ 2. Check for potential bugs or edge cases
78
+ 3. Suggest improvements for readability and maintainability
79
+ 4. Verify adherence to project conventions
80
+ ```
81
+
82
+ **Medium freedom** (pseudocode or scripts with parameters):
83
+
84
+ Use when:
85
+
86
+ * A preferred pattern exists
87
+ * Some variation is acceptable
88
+ * Configuration affects behavior
89
+
90
+ Example:
91
+
92
+ ````markdown theme={null}
93
+ ## Generate report
94
+
95
+ Use this template and customize as needed:
96
+
97
+ ```python
98
+ def generate_report(data, format="markdown", include_charts=True):
99
+ # Process data
100
+ # Generate output in specified format
101
+ # Optionally include visualizations
102
+ ```
103
+ ````
104
+
105
+ **Low freedom** (specific scripts, few or no parameters):
106
+
107
+ Use when:
108
+
109
+ * Operations are fragile and error-prone
110
+ * Consistency is critical
111
+ * A specific sequence must be followed
112
+
113
+ Example:
114
+
115
+ ````markdown theme={null}
116
+ ## Database migration
117
+
118
+ Run exactly this script:
119
+
120
+ ```bash
121
+ python scripts/migrate.py --verify --backup
122
+ ```
123
+
124
+ Do not modify the command or add additional flags.
125
+ ````
126
+
127
+ **Analogy**: Think of Claude as a robot exploring a path:
128
+
129
+ * **Narrow bridge with cliffs on both sides**: There's only one safe way forward. Provide specific guardrails and exact instructions (low freedom). Example: database migrations that must run in exact sequence.
130
+ * **Open field with no hazards**: Many paths lead to success. Give general direction and trust Claude to find the best route (high freedom). Example: code reviews where context determines the best approach.
131
+
132
+ ### Test with all models you plan to use
133
+
134
+ Skills act as additions to models, so effectiveness depends on the underlying model. Test your Skill with all the models you plan to use it with.
135
+
136
+ **Testing considerations by model**:
137
+
138
+ * **Claude Haiku** (fast, economical): Does the Skill provide enough guidance?
139
+ * **Claude Sonnet** (balanced): Is the Skill clear and efficient?
140
+ * **Claude Opus** (powerful reasoning): Does the Skill avoid over-explaining?
141
+
142
+ What works perfectly for Opus might need more detail for Haiku. If you plan to use your Skill across multiple models, aim for instructions that work well with all of them.
143
+
144
+ ## Skill structure
145
+
146
+ <Note>
147
+ **YAML Frontmatter**: The SKILL.md frontmatter requires two fields:
148
+
149
+ * `name` - Human-readable name of the Skill (64 characters maximum)
150
+ * `description` - One-line description of what the Skill does and when to use it (1024 characters maximum)
151
+
152
+ For complete Skill structure details, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure).
153
+ </Note>
154
+
155
+ ### Naming conventions
156
+
157
+ Use consistent naming patterns to make Skills easier to reference and discuss. We recommend using **gerund form** (verb + -ing) for Skill names, as this clearly describes the activity or capability the Skill provides.
158
+
159
+ **Good naming examples (gerund form)**:
160
+
161
+ * "Processing PDFs"
162
+ * "Analyzing spreadsheets"
163
+ * "Managing databases"
164
+ * "Testing code"
165
+ * "Writing documentation"
166
+
167
+ **Acceptable alternatives**:
168
+
169
+ * Noun phrases: "PDF Processing", "Spreadsheet Analysis"
170
+ * Action-oriented: "Process PDFs", "Analyze Spreadsheets"
171
+
172
+ **Avoid**:
173
+
174
+ * Vague names: "Helper", "Utils", "Tools"
175
+ * Overly generic: "Documents", "Data", "Files"
176
+ * Inconsistent patterns within your skill collection
177
+
178
+ Consistent naming makes it easier to:
179
+
180
+ * Reference Skills in documentation and conversations
181
+ * Understand what a Skill does at a glance
182
+ * Organize and search through multiple Skills
183
+ * Maintain a professional, cohesive skill library
184
+
185
+ ### Writing effective descriptions
186
+
187
+ The `description` field enables Skill discovery and should include both what the Skill does and when to use it.
188
+
189
+ <Warning>
190
+ **Always write in third person**. The description is injected into the system prompt, and inconsistent point-of-view can cause discovery problems.
191
+
192
+ * **Good:** "Processes Excel files and generates reports"
193
+ * **Avoid:** "I can help you process Excel files"
194
+ * **Avoid:** "You can use this to process Excel files"
195
+ </Warning>
196
+
197
+ **Be specific and include key terms**. Include both what the Skill does and specific triggers/contexts for when to use it.
198
+
199
+ Each Skill has exactly one description field. The description is critical for skill selection: Claude uses it to choose the right Skill from potentially 100+ available Skills. Your description must provide enough detail for Claude to know when to select this Skill, while the rest of SKILL.md provides the implementation details.
200
+
201
+ Effective examples:
202
+
203
+ **PDF Processing skill:**
204
+
205
+ ```yaml theme={null}
206
+ description: Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.
207
+ ```
208
+
209
+ **Excel Analysis skill:**
210
+
211
+ ```yaml theme={null}
212
+ description: Analyze Excel spreadsheets, create pivot tables, generate charts. Use when analyzing Excel files, spreadsheets, tabular data, or .xlsx files.
213
+ ```
214
+
215
+ **Git Commit Helper skill:**
216
+
217
+ ```yaml theme={null}
218
+ description: Generate descriptive commit messages by analyzing git diffs. Use when the user asks for help writing commit messages or reviewing staged changes.
219
+ ```
220
+
221
+ Avoid vague descriptions like these:
222
+
223
+ ```yaml theme={null}
224
+ description: Helps with documents
225
+ ```
226
+
227
+ ```yaml theme={null}
228
+ description: Processes data
229
+ ```
230
+
231
+ ```yaml theme={null}
232
+ description: Does stuff with files
233
+ ```
234
+
235
+ ### Progressive disclosure patterns
236
+
237
+ SKILL.md serves as an overview that points Claude to detailed materials as needed, like a table of contents in an onboarding guide. For an explanation of how progressive disclosure works, see [How Skills work](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work) in the overview.
238
+
239
+ **Practical guidance:**
240
+
241
+ * Keep SKILL.md body under 500 lines for optimal performance
242
+ * Split content into separate files when approaching this limit
243
+ * Use the patterns below to organize instructions, code, and resources effectively
244
+
245
+ #### Visual overview: From simple to complex
246
+
247
+ A basic Skill starts with just a SKILL.md file containing metadata and instructions:
248
+
249
+ <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=87782ff239b297d9a9e8e1b72ed72db9" alt="Simple SKILL.md file showing YAML frontmatter and markdown body" data-og-width="2048" width="2048" data-og-height="1153" height="1153" data-path="images/agent-skills-simple-file.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=c61cc33b6f5855809907f7fda94cd80e 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=90d2c0c1c76b36e8d485f49e0810dbfd 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=ad17d231ac7b0bea7e5b4d58fb4aeabb 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=f5d0a7a3c668435bb0aee9a3a8f8c329 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=0e927c1af9de5799cfe557d12249f6e6 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-simple-file.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=46bbb1a51dd4c8202a470ac8c80a893d 2500w" />
250
+
251
+ As your Skill grows, you can bundle additional content that Claude loads only when needed:
252
+
253
+ <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=a5e0aa41e3d53985a7e3e43668a33ea3" alt="Bundling additional reference files like reference.md and forms.md." data-og-width="2048" width="2048" data-og-height="1327" height="1327" data-path="images/agent-skills-bundling-content.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=f8a0e73783e99b4a643d79eac86b70a2 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=dc510a2a9d3f14359416b706f067904a 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=82cd6286c966303f7dd914c28170e385 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=56f3be36c77e4fe4b523df209a6824c6 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=d22b5161b2075656417d56f41a74f3dd 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-bundling-content.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=3dd4bdd6850ffcc96c6c45fcb0acd6eb 2500w" />
254
+
255
+ The complete Skill directory structure might look like this:
256
+
257
+ ```
258
+ pdf/
259
+ ├── SKILL.md # Main instructions (loaded when triggered)
260
+ ├── FORMS.md # Form-filling guide (loaded as needed)
261
+ ├── reference.md # API reference (loaded as needed)
262
+ ├── examples.md # Usage examples (loaded as needed)
263
+ └── scripts/
264
+ ├── analyze_form.py # Utility script (executed, not loaded)
265
+ ├── fill_form.py # Form filling script
266
+ └── validate.py # Validation script
267
+ ```
268
+
269
+ #### Pattern 1: High-level guide with references
270
+
271
+ ````markdown theme={null}
272
+ ---
273
+ name: PDF Processing
274
+ description: Extracts text and tables from PDF files, fills forms, and merges documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.
275
+ ---
276
+
277
+ # PDF Processing
278
+
279
+ ## Quick start
280
+
281
+ Extract text with pdfplumber:
282
+ ```python
283
+ import pdfplumber
284
+ with pdfplumber.open("file.pdf") as pdf:
285
+ text = pdf.pages[0].extract_text()
286
+ ```
287
+
288
+ ## Advanced features
289
+
290
+ **Form filling**: See [FORMS.md](FORMS.md) for complete guide
291
+ **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
292
+ **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
293
+ ````
294
+
295
+ Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
296
+
297
+ #### Pattern 2: Domain-specific organization
298
+
299
+ For Skills with multiple domains, organize content by domain to avoid loading irrelevant context. When a user asks about sales metrics, Claude only needs to read sales-related schemas, not finance or marketing data. This keeps token usage low and context focused.
300
+
301
+ ```
302
+ bigquery-skill/
303
+ ├── SKILL.md (overview and navigation)
304
+ └── reference/
305
+ ├── finance.md (revenue, billing metrics)
306
+ ├── sales.md (opportunities, pipeline)
307
+ ├── product.md (API usage, features)
308
+ └── marketing.md (campaigns, attribution)
309
+ ```
310
+
311
+ ````markdown SKILL.md theme={null}
312
+ # BigQuery Data Analysis
313
+
314
+ ## Available datasets
315
+
316
+ **Finance**: Revenue, ARR, billing → See [reference/finance.md](reference/finance.md)
317
+ **Sales**: Opportunities, pipeline, accounts → See [reference/sales.md](reference/sales.md)
318
+ **Product**: API usage, features, adoption → See [reference/product.md](reference/product.md)
319
+ **Marketing**: Campaigns, attribution, email → See [reference/marketing.md](reference/marketing.md)
320
+
321
+ ## Quick search
322
+
323
+ Find specific metrics using grep:
324
+
325
+ ```bash
326
+ grep -i "revenue" reference/finance.md
327
+ grep -i "pipeline" reference/sales.md
328
+ grep -i "api usage" reference/product.md
329
+ ```
330
+ ````
331
+
332
+ #### Pattern 3: Conditional details
333
+
334
+ Show basic content, link to advanced content:
335
+
336
+ ```markdown theme={null}
337
+ # DOCX Processing
338
+
339
+ ## Creating documents
340
+
341
+ Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
342
+
343
+ ## Editing documents
344
+
345
+ For simple edits, modify the XML directly.
346
+
347
+ **For tracked changes**: See [REDLINING.md](REDLINING.md)
348
+ **For OOXML details**: See [OOXML.md](OOXML.md)
349
+ ```
350
+
351
+ Claude reads REDLINING.md or OOXML.md only when the user needs those features.
352
+
353
+ ### Avoid deeply nested references
354
+
355
+ Claude may partially read files when they're referenced from other referenced files. When encountering nested references, Claude might use commands like `head -100` to preview content rather than reading entire files, resulting in incomplete information.
356
+
357
+ **Keep references one level deep from SKILL.md**. All reference files should link directly from SKILL.md to ensure Claude reads complete files when needed.
358
+
359
+ **Bad example: Too deep**:
360
+
361
+ ```markdown theme={null}
362
+ # SKILL.md
363
+ See [advanced.md](advanced.md)...
364
+
365
+ # advanced.md
366
+ See [details.md](details.md)...
367
+
368
+ # details.md
369
+ Here's the actual information...
370
+ ```
371
+
372
+ **Good example: One level deep**:
373
+
374
+ ```markdown theme={null}
375
+ # SKILL.md
376
+
377
+ **Basic usage**: [instructions in SKILL.md]
378
+ **Advanced features**: See [advanced.md](advanced.md)
379
+ **API reference**: See [reference.md](reference.md)
380
+ **Examples**: See [examples.md](examples.md)
381
+ ```
382
+
383
+ ### Structure longer reference files with table of contents
384
+
385
+ For reference files longer than 100 lines, include a table of contents at the top. This ensures Claude can see the full scope of available information even when previewing with partial reads.
386
+
387
+ **Example**:
388
+
389
+ ```markdown theme={null}
390
+ # API Reference
391
+
392
+ ## Contents
393
+ - Authentication and setup
394
+ - Core methods (create, read, update, delete)
395
+ - Advanced features (batch operations, webhooks)
396
+ - Error handling patterns
397
+ - Code examples
398
+
399
+ ## Authentication and setup
400
+ ...
401
+
402
+ ## Core methods
403
+ ...
404
+ ```
405
+
406
+ Claude can then read the complete file or jump to specific sections as needed.
407
+
408
+ For details on how this filesystem-based architecture enables progressive disclosure, see the [Runtime environment](#runtime-environment) section in the Advanced section below.
409
+
410
+ ## Workflows and feedback loops
411
+
412
+ ### Use workflows for complex tasks
413
+
414
+ Break complex operations into clear, sequential steps. For particularly complex workflows, provide a checklist that Claude can copy into its response and check off as it progresses.
415
+
416
+ **Example 1: Research synthesis workflow** (for Skills without code):
417
+
418
+ ````markdown theme={null}
419
+ ## Research synthesis workflow
420
+
421
+ Copy this checklist and track your progress:
422
+
423
+ ```
424
+ Research Progress:
425
+ - [ ] Step 1: Read all source documents
426
+ - [ ] Step 2: Identify key themes
427
+ - [ ] Step 3: Cross-reference claims
428
+ - [ ] Step 4: Create structured summary
429
+ - [ ] Step 5: Verify citations
430
+ ```
431
+
432
+ **Step 1: Read all source documents**
433
+
434
+ Review each document in the `sources/` directory. Note the main arguments and supporting evidence.
435
+
436
+ **Step 2: Identify key themes**
437
+
438
+ Look for patterns across sources. What themes appear repeatedly? Where do sources agree or disagree?
439
+
440
+ **Step 3: Cross-reference claims**
441
+
442
+ For each major claim, verify it appears in the source material. Note which source supports each point.
443
+
444
+ **Step 4: Create structured summary**
445
+
446
+ Organize findings by theme. Include:
447
+ - Main claim
448
+ - Supporting evidence from sources
449
+ - Conflicting viewpoints (if any)
450
+
451
+ **Step 5: Verify citations**
452
+
453
+ Check that every claim references the correct source document. If citations are incomplete, return to Step 3.
454
+ ````
455
+
456
+ This example shows how workflows apply to analysis tasks that don't require code. The checklist pattern works for any complex, multi-step process.
457
+
458
+ **Example 2: PDF form filling workflow** (for Skills with code):
459
+
460
+ ````markdown theme={null}
461
+ ## PDF form filling workflow
462
+
463
+ Copy this checklist and check off items as you complete them:
464
+
465
+ ```
466
+ Task Progress:
467
+ - [ ] Step 1: Analyze the form (run analyze_form.py)
468
+ - [ ] Step 2: Create field mapping (edit fields.json)
469
+ - [ ] Step 3: Validate mapping (run validate_fields.py)
470
+ - [ ] Step 4: Fill the form (run fill_form.py)
471
+ - [ ] Step 5: Verify output (run verify_output.py)
472
+ ```
473
+
474
+ **Step 1: Analyze the form**
475
+
476
+ Run: `python scripts/analyze_form.py input.pdf`
477
+
478
+ This extracts form fields and their locations, saving to `fields.json`.
479
+
480
+ **Step 2: Create field mapping**
481
+
482
+ Edit `fields.json` to add values for each field.
483
+
484
+ **Step 3: Validate mapping**
485
+
486
+ Run: `python scripts/validate_fields.py fields.json`
487
+
488
+ Fix any validation errors before continuing.
489
+
490
+ **Step 4: Fill the form**
491
+
492
+ Run: `python scripts/fill_form.py input.pdf fields.json output.pdf`
493
+
494
+ **Step 5: Verify output**
495
+
496
+ Run: `python scripts/verify_output.py output.pdf`
497
+
498
+ If verification fails, return to Step 2.
499
+ ````
500
+
501
+ Clear steps prevent Claude from skipping critical validation. The checklist helps both Claude and you track progress through multi-step workflows.
502
+
503
+ ### Implement feedback loops
504
+
505
+ **Common pattern**: Run validator → fix errors → repeat
506
+
507
+ This pattern greatly improves output quality.
508
+
509
+ **Example 1: Style guide compliance** (for Skills without code):
510
+
511
+ ```markdown theme={null}
512
+ ## Content review process
513
+
514
+ 1. Draft your content following the guidelines in STYLE_GUIDE.md
515
+ 2. Review against the checklist:
516
+ - Check terminology consistency
517
+ - Verify examples follow the standard format
518
+ - Confirm all required sections are present
519
+ 3. If issues found:
520
+ - Note each issue with specific section reference
521
+ - Revise the content
522
+ - Review the checklist again
523
+ 4. Only proceed when all requirements are met
524
+ 5. Finalize and save the document
525
+ ```
526
+
527
+ This shows the validation loop pattern using reference documents instead of scripts. The "validator" is STYLE\_GUIDE.md, and Claude performs the check by reading and comparing.
528
+
529
+ **Example 2: Document editing process** (for Skills with code):
530
+
531
+ ```markdown theme={null}
532
+ ## Document editing process
533
+
534
+ 1. Make your edits to `word/document.xml`
535
+ 2. **Validate immediately**: `python ooxml/scripts/validate.py unpacked_dir/`
536
+ 3. If validation fails:
537
+ - Review the error message carefully
538
+ - Fix the issues in the XML
539
+ - Run validation again
540
+ 4. **Only proceed when validation passes**
541
+ 5. Rebuild: `python ooxml/scripts/pack.py unpacked_dir/ output.docx`
542
+ 6. Test the output document
543
+ ```
544
+
545
+ The validation loop catches errors early.
546
+
547
+ ## Content guidelines
548
+
549
+ ### Avoid time-sensitive information
550
+
551
+ Don't include information that will become outdated:
552
+
553
+ **Bad example: Time-sensitive** (will become wrong):
554
+
555
+ ```markdown theme={null}
556
+ If you're doing this before August 2025, use the old API.
557
+ After August 2025, use the new API.
558
+ ```
559
+
560
+ **Good example** (use "old patterns" section):
561
+
562
+ ```markdown theme={null}
563
+ ## Current method
564
+
565
+ Use the v2 API endpoint: `api.example.com/v2/messages`
566
+
567
+ ## Old patterns
568
+
569
+ <details>
570
+ <summary>Legacy v1 API (deprecated 2025-08)</summary>
571
+
572
+ The v1 API used: `api.example.com/v1/messages`
573
+
574
+ This endpoint is no longer supported.
575
+ </details>
576
+ ```
577
+
578
+ The old patterns section provides historical context without cluttering the main content.
579
+
580
+ ### Use consistent terminology
581
+
582
+ Choose one term and use it throughout the Skill:
583
+
584
+ **Good - Consistent**:
585
+
586
+ * Always "API endpoint"
587
+ * Always "field"
588
+ * Always "extract"
589
+
590
+ **Bad - Inconsistent**:
591
+
592
+ * Mix "API endpoint", "URL", "API route", "path"
593
+ * Mix "field", "box", "element", "control"
594
+ * Mix "extract", "pull", "get", "retrieve"
595
+
596
+ Consistency helps Claude understand and follow instructions.
597
+
598
+ ## Common patterns
599
+
600
+ ### Template pattern
601
+
602
+ Provide templates for output format. Match the level of strictness to your needs.
603
+
604
+ **For strict requirements** (like API responses or data formats):
605
+
606
+ ````markdown theme={null}
607
+ ## Report structure
608
+
609
+ ALWAYS use this exact template structure:
610
+
611
+ ```markdown
612
+ # [Analysis Title]
613
+
614
+ ## Executive summary
615
+ [One-paragraph overview of key findings]
616
+
617
+ ## Key findings
618
+ - Finding 1 with supporting data
619
+ - Finding 2 with supporting data
620
+ - Finding 3 with supporting data
621
+
622
+ ## Recommendations
623
+ 1. Specific actionable recommendation
624
+ 2. Specific actionable recommendation
625
+ ```
626
+ ````
627
+
628
+ **For flexible guidance** (when adaptation is useful):
629
+
630
+ ````markdown theme={null}
631
+ ## Report structure
632
+
633
+ Here is a sensible default format, but use your best judgment based on the analysis:
634
+
635
+ ```markdown
636
+ # [Analysis Title]
637
+
638
+ ## Executive summary
639
+ [Overview]
640
+
641
+ ## Key findings
642
+ [Adapt sections based on what you discover]
643
+
644
+ ## Recommendations
645
+ [Tailor to the specific context]
646
+ ```
647
+
648
+ Adjust sections as needed for the specific analysis type.
649
+ ````
650
+
651
+ ### Examples pattern
652
+
653
+ For Skills where output quality depends on seeing examples, provide input/output pairs just like in regular prompting:
654
+
655
+ ````markdown theme={null}
656
+ ## Commit message format
657
+
658
+ Generate commit messages following these examples:
659
+
660
+ **Example 1:**
661
+ Input: Added user authentication with JWT tokens
662
+ Output:
663
+ ```
664
+ feat(auth): implement JWT-based authentication
665
+
666
+ Add login endpoint and token validation middleware
667
+ ```
668
+
669
+ **Example 2:**
670
+ Input: Fixed bug where dates displayed incorrectly in reports
671
+ Output:
672
+ ```
673
+ fix(reports): correct date formatting in timezone conversion
674
+
675
+ Use UTC timestamps consistently across report generation
676
+ ```
677
+
678
+ **Example 3:**
679
+ Input: Updated dependencies and refactored error handling
680
+ Output:
681
+ ```
682
+ chore: update dependencies and refactor error handling
683
+
684
+ - Upgrade lodash to 4.17.21
685
+ - Standardize error response format across endpoints
686
+ ```
687
+
688
+ Follow this style: type(scope): brief description, then detailed explanation.
689
+ ````
690
+
691
+ Examples help Claude understand the desired style and level of detail more clearly than descriptions alone.
692
+
693
+ ### Conditional workflow pattern
694
+
695
+ Guide Claude through decision points:
696
+
697
+ ```markdown theme={null}
698
+ ## Document modification workflow
699
+
700
+ 1. Determine the modification type:
701
+
702
+ **Creating new content?** → Follow "Creation workflow" below
703
+ **Editing existing content?** → Follow "Editing workflow" below
704
+
705
+ 2. Creation workflow:
706
+ - Use docx-js library
707
+ - Build document from scratch
708
+ - Export to .docx format
709
+
710
+ 3. Editing workflow:
711
+ - Unpack existing document
712
+ - Modify XML directly
713
+ - Validate after each change
714
+ - Repack when complete
715
+ ```
716
+
717
+ <Tip>
718
+ If workflows become large or complicated with many steps, consider pushing them into separate files and tell Claude to read the appropriate file based on the task at hand.
719
+ </Tip>
720
+
721
+ ## Evaluation and iteration
722
+
723
+ ### Build evaluations first
724
+
725
+ **Create evaluations BEFORE writing extensive documentation.** This ensures your Skill solves real problems rather than documenting imagined ones.
726
+
727
+ **Evaluation-driven development:**
728
+
729
+ 1. **Identify gaps**: Run Claude on representative tasks without a Skill. Document specific failures or missing context
730
+ 2. **Create evaluations**: Build three scenarios that test these gaps
731
+ 3. **Establish baseline**: Measure Claude's performance without the Skill
732
+ 4. **Write minimal instructions**: Create just enough content to address the gaps and pass evaluations
733
+ 5. **Iterate**: Execute evaluations, compare against baseline, and refine
734
+
735
+ This approach ensures you're solving actual problems rather than anticipating requirements that may never materialize.
736
+
737
+ **Evaluation structure**:
738
+
739
+ ```json theme={null}
740
+ {
741
+ "skills": ["pdf-processing"],
742
+ "query": "Extract all text from this PDF file and save it to output.txt",
743
+ "files": ["test-files/document.pdf"],
744
+ "expected_behavior": [
745
+ "Successfully reads the PDF file using an appropriate PDF processing library or command-line tool",
746
+ "Extracts text content from all pages in the document without missing any pages",
747
+ "Saves the extracted text to a file named output.txt in a clear, readable format"
748
+ ]
749
+ }
750
+ ```
751
+
752
+ <Note>
753
+ This example demonstrates a data-driven evaluation with a simple testing rubric. We do not currently provide a built-in way to run these evaluations. Users can create their own evaluation system. Evaluations are your source of truth for measuring Skill effectiveness.
754
+ </Note>
755
+
756
+ ### Develop Skills iteratively with Claude
757
+
758
+ The most effective Skill development process involves Claude itself. Work with one instance of Claude ("Claude A") to create a Skill that will be used by other instances ("Claude B"). Claude A helps you design and refine instructions, while Claude B tests them in real tasks. This works because Claude models understand both how to write effective agent instructions and what information agents need.
759
+
760
+ **Creating a new Skill:**
761
+
762
+ 1. **Complete a task without a Skill**: Work through a problem with Claude A using normal prompting. As you work, you'll naturally provide context, explain preferences, and share procedural knowledge. Notice what information you repeatedly provide.
763
+
764
+ 2. **Identify the reusable pattern**: After completing the task, identify what context you provided that would be useful for similar future tasks.
765
+
766
+ **Example**: If you worked through a BigQuery analysis, you might have provided table names, field definitions, filtering rules (like "always exclude test accounts"), and common query patterns.
767
+
768
+ 3. **Ask Claude A to create a Skill**: "Create a Skill that captures this BigQuery analysis pattern we just used. Include the table schemas, naming conventions, and the rule about filtering test accounts."
769
+
770
+ <Tip>
771
+ Claude models understand the Skill format and structure natively. You don't need special system prompts or a "writing skills" skill to get Claude to help create Skills. Simply ask Claude to create a Skill and it will generate properly structured SKILL.md content with appropriate frontmatter and body content.
772
+ </Tip>
773
+
774
+ 4. **Review for conciseness**: Check that Claude A hasn't added unnecessary explanations. Ask: "Remove the explanation about what win rate means - Claude already knows that."
775
+
776
+ 5. **Improve information architecture**: Ask Claude A to organize the content more effectively. For example: "Organize this so the table schema is in a separate reference file. We might add more tables later."
777
+
778
+ 6. **Test on similar tasks**: Use the Skill with Claude B (a fresh instance with the Skill loaded) on related use cases. Observe whether Claude B finds the right information, applies rules correctly, and handles the task successfully.
779
+
780
+ 7. **Iterate based on observation**: If Claude B struggles or misses something, return to Claude A with specifics: "When Claude used this Skill, it forgot to filter by date for Q4. Should we add a section about date filtering patterns?"
781
+
782
+ **Iterating on existing Skills:**
783
+
784
+ The same hierarchical pattern continues when improving Skills. You alternate between:
785
+
786
+ * **Working with Claude A** (the expert who helps refine the Skill)
787
+ * **Testing with Claude B** (the agent using the Skill to perform real work)
788
+ * **Observing Claude B's behavior** and bringing insights back to Claude A
789
+
790
+ 1. **Use the Skill in real workflows**: Give Claude B (with the Skill loaded) actual tasks, not test scenarios
791
+
792
+ 2. **Observe Claude B's behavior**: Note where it struggles, succeeds, or makes unexpected choices
793
+
794
+ **Example observation**: "When I asked Claude B for a regional sales report, it wrote the query but forgot to filter out test accounts, even though the Skill mentions this rule."
795
+
796
+ 3. **Return to Claude A for improvements**: Share the current SKILL.md and describe what you observed. Ask: "I noticed Claude B forgot to filter test accounts when I asked for a regional report. The Skill mentions filtering, but maybe it's not prominent enough?"
797
+
798
+ 4. **Review Claude A's suggestions**: Claude A might suggest reorganizing to make rules more prominent, using stronger language like "MUST filter" instead of "always filter", or restructuring the workflow section.
799
+
800
+ 5. **Apply and test changes**: Update the Skill with Claude A's refinements, then test again with Claude B on similar requests
801
+
802
+ 6. **Repeat based on usage**: Continue this observe-refine-test cycle as you encounter new scenarios. Each iteration improves the Skill based on real agent behavior, not assumptions.
803
+
804
+ **Gathering team feedback:**
805
+
806
+ 1. Share Skills with teammates and observe their usage
807
+ 2. Ask: Does the Skill activate when expected? Are instructions clear? What's missing?
808
+ 3. Incorporate feedback to address blind spots in your own usage patterns
809
+
810
+ **Why this approach works**: Claude A understands agent needs, you provide domain expertise, Claude B reveals gaps through real usage, and iterative refinement improves Skills based on observed behavior rather than assumptions.
811
+
812
+ ### Observe how Claude navigates Skills
813
+
814
+ As you iterate on Skills, pay attention to how Claude actually uses them in practice. Watch for:
815
+
816
+ * **Unexpected exploration paths**: Does Claude read files in an order you didn't anticipate? This might indicate your structure isn't as intuitive as you thought
817
+ * **Missed connections**: Does Claude fail to follow references to important files? Your links might need to be more explicit or prominent
818
+ * **Overreliance on certain sections**: If Claude repeatedly reads the same file, consider whether that content should be in the main SKILL.md instead
819
+ * **Ignored content**: If Claude never accesses a bundled file, it might be unnecessary or poorly signaled in the main instructions
820
+
821
+ Iterate based on these observations rather than assumptions. The 'name' and 'description' in your Skill's metadata are particularly critical. Claude uses these when deciding whether to trigger the Skill in response to the current task. Make sure they clearly describe what the Skill does and when it should be used.
822
+
823
+ ## Anti-patterns to avoid
824
+
825
+ ### Avoid Windows-style paths
826
+
827
+ Always use forward slashes in file paths, even on Windows:
828
+
829
+ * ✓ **Good**: `scripts/helper.py`, `reference/guide.md`
830
+ * ✗ **Avoid**: `scripts\helper.py`, `reference\guide.md`
831
+
832
+ Unix-style paths work across all platforms, while Windows-style paths cause errors on Unix systems.
833
+
834
+ ### Avoid offering too many options
835
+
836
+ Don't present multiple approaches unless necessary:
837
+
838
+ ````markdown theme={null}
839
+ **Bad example: Too many choices** (confusing):
840
+ "You can use pypdf, or pdfplumber, or PyMuPDF, or pdf2image, or..."
841
+
842
+ **Good example: Provide a default** (with escape hatch):
843
+ "Use pdfplumber for text extraction:
844
+ ```python
845
+ import pdfplumber
846
+ ```
847
+
848
+ For scanned PDFs requiring OCR, use pdf2image with pytesseract instead."
849
+ ````
850
+
851
+ ## Advanced: Skills with executable code
852
+
853
+ The sections below focus on Skills that include executable scripts. If your Skill uses only markdown instructions, skip to [Checklist for effective Skills](#checklist-for-effective-skills).
854
+
855
+ ### Solve, don't punt
856
+
857
+ When writing scripts for Skills, handle error conditions rather than punting to Claude.
858
+
859
+ **Good example: Handle errors explicitly**:
860
+
861
+ ```python theme={null}
862
+ def process_file(path):
863
+ """Process a file, creating it if it doesn't exist."""
864
+ try:
865
+ with open(path) as f:
866
+ return f.read()
867
+ except FileNotFoundError:
868
+ # Create file with default content instead of failing
869
+ print(f"File {path} not found, creating default")
870
+ with open(path, 'w') as f:
871
+ f.write('')
872
+ return ''
873
+ except PermissionError:
874
+ # Provide alternative instead of failing
875
+ print(f"Cannot access {path}, using default")
876
+ return ''
877
+ ```
878
+
879
+ **Bad example: Punt to Claude**:
880
+
881
+ ```python theme={null}
882
+ def process_file(path):
883
+ # Just fail and let Claude figure it out
884
+ return open(path).read()
885
+ ```
886
+
887
+ Configuration parameters should also be justified and documented to avoid "voodoo constants" (Ousterhout's law). If you don't know the right value, how will Claude determine it?
888
+
889
+ **Good example: Self-documenting**:
890
+
891
+ ```python theme={null}
892
+ # HTTP requests typically complete within 30 seconds
893
+ # Longer timeout accounts for slow connections
894
+ REQUEST_TIMEOUT = 30
895
+
896
+ # Three retries balances reliability vs speed
897
+ # Most intermittent failures resolve by the second retry
898
+ MAX_RETRIES = 3
899
+ ```
900
+
901
+ **Bad example: Magic numbers**:
902
+
903
+ ```python theme={null}
904
+ TIMEOUT = 47 # Why 47?
905
+ RETRIES = 5 # Why 5?
906
+ ```
907
+
908
+ ### Provide utility scripts
909
+
910
+ Even if Claude could write a script, pre-made scripts offer advantages:
911
+
912
+ **Benefits of utility scripts**:
913
+
914
+ * More reliable than generated code
915
+ * Save tokens (no need to include code in context)
916
+ * Save time (no code generation required)
917
+ * Ensure consistency across uses
918
+
919
+ <img src="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=4bbc45f2c2e0bee9f2f0d5da669bad00" alt="Bundling executable scripts alongside instruction files" data-og-width="2048" width="2048" data-og-height="1154" height="1154" data-path="images/agent-skills-executable-scripts.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=280&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=9a04e6535a8467bfeea492e517de389f 280w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=560&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=e49333ad90141af17c0d7651cca7216b 560w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=840&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=954265a5df52223d6572b6214168c428 840w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=1100&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=2ff7a2d8f2a83ee8af132b29f10150fd 1100w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=1650&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=48ab96245e04077f4d15e9170e081cfb 1650w, https://mintcdn.com/anthropic-claude-docs/4Bny2bjzuGBK7o00/images/agent-skills-executable-scripts.png?w=2500&fit=max&auto=format&n=4Bny2bjzuGBK7o00&q=85&s=0301a6c8b3ee879497cc5b5483177c90 2500w" />
920
+
921
+ The diagram above shows how executable scripts work alongside instruction files. The instruction file (forms.md) references the script, and Claude can execute it without loading its contents into context.
922
+
923
+ **Important distinction**: Make clear in your instructions whether Claude should:
924
+
925
+ * **Execute the script** (most common): "Run `analyze_form.py` to extract fields"
926
+ * **Read it as reference** (for complex logic): "See `analyze_form.py` for the field extraction algorithm"
927
+
928
+ For most utility scripts, execution is preferred because it's more reliable and efficient. See the [Runtime environment](#runtime-environment) section below for details on how script execution works.
929
+
930
+ **Example**:
931
+
932
+ ````markdown theme={null}
933
+ ## Utility scripts
934
+
935
+ **analyze_form.py**: Extract all form fields from PDF
936
+
937
+ ```bash
938
+ python scripts/analyze_form.py input.pdf > fields.json
939
+ ```
940
+
941
+ Output format:
942
+ ```json
943
+ {
944
+ "field_name": {"type": "text", "x": 100, "y": 200},
945
+ "signature": {"type": "sig", "x": 150, "y": 500}
946
+ }
947
+ ```
948
+
949
+ **validate_boxes.py**: Check for overlapping bounding boxes
950
+
951
+ ```bash
952
+ python scripts/validate_boxes.py fields.json
953
+ # Returns: "OK" or lists conflicts
954
+ ```
955
+
956
+ **fill_form.py**: Apply field values to PDF
957
+
958
+ ```bash
959
+ python scripts/fill_form.py input.pdf fields.json output.pdf
960
+ ```
961
+ ````
962
+
963
+ ### Use visual analysis
964
+
965
+ When inputs can be rendered as images, have Claude analyze them:
966
+
967
+ ````markdown theme={null}
968
+ ## Form layout analysis
969
+
970
+ 1. Convert PDF to images:
971
+ ```bash
972
+ python scripts/pdf_to_images.py form.pdf
973
+ ```
974
+
975
+ 2. Analyze each page image to identify form fields
976
+ 3. Claude can see field locations and types visually
977
+ ````
978
+
979
+ <Note>
980
+ In this example, you'd need to write the `pdf_to_images.py` script.
981
+ </Note>
982
+
983
+ Claude's vision capabilities help understand layouts and structures.
984
+
985
+ ### Create verifiable intermediate outputs
986
+
987
+ When Claude performs complex, open-ended tasks, it can make mistakes. The "plan-validate-execute" pattern catches errors early by having Claude first create a plan in a structured format, then validate that plan with a script before executing it.
988
+
989
+ **Example**: Imagine asking Claude to update 50 form fields in a PDF based on a spreadsheet. Without validation, Claude might reference non-existent fields, create conflicting values, miss required fields, or apply updates incorrectly.
990
+
991
+ **Solution**: Use the workflow pattern shown above (PDF form filling), but add an intermediate `changes.json` file that gets validated before applying changes. The workflow becomes: analyze → **create plan file** → **validate plan** → execute → verify.
992
+
993
+ **Why this pattern works:**
994
+
995
+ * **Catches errors early**: Validation finds problems before changes are applied
996
+ * **Machine-verifiable**: Scripts provide objective verification
997
+ * **Reversible planning**: Claude can iterate on the plan without touching originals
998
+ * **Clear debugging**: Error messages point to specific problems
999
+
1000
+ **When to use**: Batch operations, destructive changes, complex validation rules, high-stakes operations.
1001
+
1002
+ **Implementation tip**: Make validation scripts verbose with specific error messages like "Field 'signature\_date' not found. Available fields: customer\_name, order\_total, signature\_date\_signed" to help Claude fix issues.
1003
+
1004
+ ### Package dependencies
1005
+
1006
+ Skills run in the code execution environment with platform-specific limitations:
1007
+
1008
+ * **claude.ai**: Can install packages from npm and PyPI and pull from GitHub repositories
1009
+ * **Anthropic API**: Has no network access and no runtime package installation
1010
+
1011
+ List required packages in your SKILL.md and verify they're available in the [code execution tool documentation](/en/docs/agents-and-tools/tool-use/code-execution-tool).
1012
+
1013
+ ### Runtime environment
1014
+
1015
+ Skills run in a code execution environment with filesystem access, bash commands, and code execution capabilities. For the conceptual explanation of this architecture, see [The Skills architecture](/en/docs/agents-and-tools/agent-skills/overview#the-skills-architecture) in the overview.
1016
+
1017
+ **How this affects your authoring:**
1018
+
1019
+ **How Claude accesses Skills:**
1020
+
1021
+ 1. **Metadata pre-loaded**: At startup, the name and description from all Skills' YAML frontmatter are loaded into the system prompt
1022
+ 2. **Files read on-demand**: Claude uses bash Read tools to access SKILL.md and other files from the filesystem when needed
1023
+ 3. **Scripts executed efficiently**: Utility scripts can be executed via bash without loading their full contents into context. Only the script's output consumes tokens
1024
+ 4. **No context penalty for large files**: Reference files, data, or documentation don't consume context tokens until actually read
1025
+
1026
+ * **File paths matter**: Claude navigates your skill directory like a filesystem. Use forward slashes (`reference/guide.md`), not backslashes
1027
+ * **Name files descriptively**: Use names that indicate content: `form_validation_rules.md`, not `doc2.md`
1028
+ * **Organize for discovery**: Structure directories by domain or feature
1029
+ * Good: `reference/finance.md`, `reference/sales.md`
1030
+ * Bad: `docs/file1.md`, `docs/file2.md`
1031
+ * **Bundle comprehensive resources**: Include complete API docs, extensive examples, large datasets; no context penalty until accessed
1032
+ * **Prefer scripts for deterministic operations**: Write `validate_form.py` rather than asking Claude to generate validation code
1033
+ * **Make execution intent clear**:
1034
+ * "Run `analyze_form.py` to extract fields" (execute)
1035
+ * "See `analyze_form.py` for the extraction algorithm" (read as reference)
1036
+ * **Test file access patterns**: Verify Claude can navigate your directory structure by testing with real requests
1037
+
1038
+ **Example:**
1039
+
1040
+ ```
1041
+ bigquery-skill/
1042
+ ├── SKILL.md (overview, points to reference files)
1043
+ └── reference/
1044
+ ├── finance.md (revenue metrics)
1045
+ ├── sales.md (pipeline data)
1046
+ └── product.md (usage analytics)
1047
+ ```
1048
+
1049
+ When the user asks about revenue, Claude reads SKILL.md, sees the reference to `reference/finance.md`, and invokes bash to read just that file. The sales.md and product.md files remain on the filesystem, consuming zero context tokens until needed. This filesystem-based model is what enables progressive disclosure. Claude can navigate and selectively load exactly what each task requires.
1050
+
1051
+ For complete details on the technical architecture, see [How Skills work](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work) in the Skills overview.
1052
+
1053
+ ### MCP tool references
1054
+
1055
+ If your Skill uses MCP (Model Context Protocol) tools, always use fully qualified tool names to avoid "tool not found" errors.
1056
+
1057
+ **Format**: `ServerName:tool_name`
1058
+
1059
+ **Example**:
1060
+
1061
+ ```markdown theme={null}
1062
+ Use the BigQuery:bigquery_schema tool to retrieve table schemas.
1063
+ Use the GitHub:create_issue tool to create issues.
1064
+ ```
1065
+
1066
+ Where:
1067
+
1068
+ * `BigQuery` and `GitHub` are MCP server names
1069
+ * `bigquery_schema` and `create_issue` are the tool names within those servers
1070
+
1071
+ Without the server prefix, Claude may fail to locate the tool, especially when multiple MCP servers are available.
1072
+
1073
+ ### Avoid assuming tools are installed
1074
+
1075
+ Don't assume packages are available:
1076
+
1077
+ ````markdown theme={null}
1078
+ **Bad example: Assumes installation**:
1079
+ "Use the pdf library to process the file."
1080
+
1081
+ **Good example: Explicit about dependencies**:
1082
+ "Install required package: `pip install pypdf`
1083
+
1084
+ Then use it:
1085
+ ```python
1086
+ from pypdf import PdfReader
1087
+ reader = PdfReader("file.pdf")
1088
+ ```"
1089
+ ````
1090
+
1091
+ ## Technical notes
1092
+
1093
+ ### YAML frontmatter requirements
1094
+
1095
+ The SKILL.md frontmatter requires `name` (64 characters max) and `description` (1024 characters max) fields. See the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#skill-structure) for complete structure details.
1096
+
1097
+ ### Token budgets
1098
+
1099
+ Keep SKILL.md body under 500 lines for optimal performance. If your content exceeds this, split it into separate files using the progressive disclosure patterns described earlier. For architectural details, see the [Skills overview](/en/docs/agents-and-tools/agent-skills/overview#how-skills-work).
1100
+
1101
+ ## Checklist for effective Skills
1102
+
1103
+ Before sharing a Skill, verify:
1104
+
1105
+ ### Core quality
1106
+
1107
+ * [ ] Description is specific and includes key terms
1108
+ * [ ] Description includes both what the Skill does and when to use it
1109
+ * [ ] SKILL.md body is under 500 lines
1110
+ * [ ] Additional details are in separate files (if needed)
1111
+ * [ ] No time-sensitive information (or in "old patterns" section)
1112
+ * [ ] Consistent terminology throughout
1113
+ * [ ] Examples are concrete, not abstract
1114
+ * [ ] File references are one level deep
1115
+ * [ ] Progressive disclosure used appropriately
1116
+ * [ ] Workflows have clear steps
1117
+
1118
+ ### Code and scripts
1119
+
1120
+ * [ ] Scripts solve problems rather than punt to Claude
1121
+ * [ ] Error handling is explicit and helpful
1122
+ * [ ] No "voodoo constants" (all values justified)
1123
+ * [ ] Required packages listed in instructions and verified as available
1124
+ * [ ] Scripts have clear documentation
1125
+ * [ ] No Windows-style paths (all forward slashes)
1126
+ * [ ] Validation/verification steps for critical operations
1127
+ * [ ] Feedback loops included for quality-critical tasks
1128
+
1129
+ ### Testing
1130
+
1131
+ * [ ] At least three evaluations created
1132
+ * [ ] Tested with Haiku, Sonnet, and Opus
1133
+ * [ ] Tested with real usage scenarios
1134
+ * [ ] Team feedback incorporated (if applicable)
1135
+
1136
+ ## Next steps
1137
+
1138
+ <CardGroup cols={2}>
1139
+ <Card title="Get started with Agent Skills" icon="rocket" href="/en/docs/agents-and-tools/agent-skills/quickstart">
1140
+ Create your first Skill
1141
+ </Card>
1142
+
1143
+ <Card title="Use Skills in Claude Code" icon="terminal" href="/en/docs/claude-code/skills">
1144
+ Create and manage Skills in Claude Code
1145
+ </Card>
1146
+
1147
+ <Card title="Use Skills with the API" icon="code" href="/en/api/skills-guide">
1148
+ Upload and use Skills programmatically
1149
+ </Card>
1150
+ </CardGroup>