Skip to content

Commit edb3990

Browse files
committed
feat: readme with examples
1 parent cf2c3ec commit edb3990

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

skills/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,39 @@ Skills are principle-based guides that help coding agents (Claude Code, Cursor,
1010

1111
```bash
1212
# Install via npx skills
13-
npx skills add katanemo/plano-agent-skills
13+
npx skills add katanemo/plano
1414
```
1515

16+
This skills collection is published from the `skills/` directory in the `katanemo/plano` monorepo.
17+
18+
## Using Skills in Agents
19+
20+
After installation, these skills are available to your coding agent and can be invoked with normal language. You do not need special syntax unless your tooling requires it.
21+
22+
### Natural Language Invocation Examples
23+
24+
- "Use the Plano skills to validate this `config.yaml` and fix issues."
25+
- "Apply Plano routing best practices to improve model/provider selection."
26+
- "Review this agent listener config with the orchestration rules."
27+
- "Refactor this filter chain to follow guardrail ordering best practices."
28+
- "Audit this setup against Plano deployment and security recommendations."
29+
30+
### Prompting Tips for Better Results
31+
32+
- Name your goal and file: "Harden `config.yaml` for production."
33+
- Ask for an action: "Generate a patch," "fix directly," or "explain the changes."
34+
- Include runtime context when relevant: trace output, logs, listener errors.
35+
- Ask for verification: "Run a final validation check after edits."
36+
37+
### Invoke by Skill Area (Optional)
38+
39+
- **Configuration:** "Use Plano configuration fundamentals on this config."
40+
- **Routing:** "Use routing/model-selection skills to tune defaults and aliases."
41+
- **Agent orchestration:** "Use agent orchestration skills to improve routing accuracy."
42+
- **Filters/guardrails:** "Use filter-chain skills to harden input/output safety."
43+
- **Observability:** "Use observability skills to add traceability and debug routing."
44+
- **CLI/deployment:** "Use CLI and deployment skills to produce a startup checklist."
45+
1646
## Structure
1747

1848
```

0 commit comments

Comments
 (0)