Copy of the legacy ~/.pi/agent/docs tree rebuilt as the command-center knowledge base: concept files promoted to path identity, index listings stripped of frontmatter, all wikilinks/relative links resolved, every checkable claim verified against the live fleet (Dankserver = Ryzen 7 7700X + RTX 3090; Strix Halo is Dankclaw), unverifiable claims tagged. kb-lint exits 0.
2.1 KiB
2.1 KiB
type, title, description, tags, timestamp, verified
| type | title | description | tags | timestamp | verified | ||||
|---|---|---|---|---|---|---|---|---|---|
| guide | Skill Author Best Practices | Tips for writing good skill descriptions, organizing files, and distributing pi packages on npm. |
|
2026-07-18 | 2026-08-28 |
Best Practices for Skill Authors
Description Writing
- Be specific about capabilities — "Extracts text and tables from PDF files, fills forms, merges documents" vs "Helps with documents"
- Include trigger phrases — "Use when working with PDF files or when user mentions PDFs, forms, or document extraction"
- Keep under 1024 characters
- Write in third person
- First sentence = what it does, second sentence = when to use it
File Organization
- Use progressive disclosure — Keep SKILL.md focused; reference detailed docs in
references/ - Add scripts for deterministic operations — When the same code would be generated repeatedly, scripts save tokens and improve reliability
- Split files when content exceeds ~500 lines — Agents load the entire file on activation
- Include a config.json for configurable paths or settings
- Add tests — Include test scripts and mock data for validation
Security
- Review skill content before use — Skills can instruct the model to perform any action
- Scripts run with your full system permissions — Only install from trusted sources
- Document dependencies clearly — List all required tools, API keys, and setup steps
Distribution
- Add
pi-packagekeyword to package.json for npm discoverability - Include
videoorimagefields in the pi manifest for the gallery - Use peerDependencies for pi-provided packages:
@earendil-works/pi-coding-agent,@earendil-works/pi-ai,typebox - List runtime deps in
dependencies— They get installed automatically
Related
- Package Structure — How to structure your npm package
- Installation — How users will install your skills