Skip to content

Commit abb3674

Browse files
authored
feat: improve skill scores across all examples (#23)
Hullo 👋 @shreyas-lyzr I ran your skills through `tessl skill review` at work and found some targeted improvements. Here's the full before/after: | Skill | Before | After | Change | |-------|--------|-------|--------| | regulatory-analysis | 44% | 94% | +50% | | code-review | 53% | 94% | +41% | | export-agent | 55% | 94% | +39% | | research | 55% | 89% | +34% | | document-review | 49% | 79% | +30% | | create-agent | 60% | 90% | +30% | | run-agent | 60% | 90% | +30% | | get-started | 66% | 95% | +29% | | manage-skills | 66% | 94% | +28% | ## What Improved all 9 example skills across the `examples/` directory — descriptions, trigger terms, concrete examples, and workflow clarity. ## Why The skill descriptions lacked explicit "Use when..." clauses and specific trigger terms, making it harder for agents to select the right skill. Content was solid but missing concrete examples and validation steps in several cases. <details> <summary>Changes made</summary> **Description improvements (all 9 skills):** - Added explicit "Use when..." clauses with natural trigger keywords - Expanded descriptions with specific concrete actions and domain terms - Switched from vague "Help users..." to third-person action verbs - Added specific framework/tool names as trigger terms **Content improvements:** - `document-review`: Added structured output format with example finding (FINRA 2210 violation) - `regulatory-analysis`: Added citation validation step and example finding with rule reference - `create-agent`: Replaced "When to Use" with actionable Quick Start workflow (5 numbered steps) - `export-agent`: Replaced "When to Use" with export verification step - `run-agent`: Added troubleshooting section for common authentication errors - `research`: Added complete example output demonstrating expected quality - `code-review`: Added example finding with before/after code fix (SQL injection) - `manage-skills`: Added installation verification step - `get-started`: Improved description specificity (content already scored 100%) </details> ## How Tested - [x] `tessl skill review` passed on all 9 skills with score improvements - [x] YAML frontmatter validates correctly (all skills pass validation checks) - [x] No changes to agent.yaml files or directory structure ## Checklist - [x] My code follows the existing style of this project - [x] I have updated documentation (if applicable) - [x] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) --- Honest disclosure — I work at @tesslio where we build tooling around skills like these. Not a pitch - just saw room for improvement and wanted to contribute. Want to self-improve your skills? Just point your agent (Claude Code, Codex, etc.) at [this Tessl guide](https://docs.tessl.io/evaluate/optimize-a-skill-using-best-practices) and ask it to optimize your skill. Ping me - [@popey](https://github.com/popey) - if you hit any snags. Thanks in advance 🙏
1 parent dcac5ce commit abb3674

File tree

9 files changed

+109
-13
lines changed

9 files changed

+109
-13
lines changed

examples/full/skills/document-review/SKILL.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: document-review
3-
description: Review financial documents for completeness and compliance
3+
description: "Reviews financial documents (prospectuses, ADVs, marketing materials) for FINRA 2210 compliance, required disclosures, and balanced presentation. Use when reviewing financial statements, audit documents, regulatory filings, or when the user mentions compliance checks, financial audits, or document verification."
44
license: proprietary
55
allowed-tools: search-regulations generate-report
66
metadata:
@@ -29,3 +29,23 @@ When reviewing a financial document:
2929
- [ ] Proper disclaimers included
3030
- [ ] Correct classification (correspondence/retail/institutional)
3131
- [ ] Principal pre-approval status verified (if retail communication)
32+
33+
## Output Format
34+
35+
For each finding, produce:
36+
37+
```
38+
### [SEVERITY] — [Rule Reference]
39+
- **Issue**: [What was found]
40+
- **Location**: [Section/page reference]
41+
- **Recommended action**: [Specific fix]
42+
```
43+
44+
### Example Finding
45+
46+
```
47+
### WARNING — FINRA 2210(d)(1)(A)
48+
- **Issue**: Performance claim "consistently outperforms the market" lacks supporting data and time period
49+
- **Location**: Page 2, paragraph 3
50+
- **Recommended action**: Add specific time period, benchmark comparison, and standardized performance data per SEC Rule 482
51+
```

examples/full/skills/regulatory-analysis/SKILL.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: regulatory-analysis
3-
description: Analyze documents and processes for regulatory compliance
3+
description: "Analyzes documents and processes against FINRA, SEC, Federal Reserve, and CFPB regulatory frameworks. Identifies compliance gaps, classifies findings by severity, and recommends remediation. Use when performing compliance audits, regulatory reviews, gap analyses, or verifying policy adherence to financial regulations."
44
license: proprietary
55
allowed-tools: search-regulations
66
metadata:
@@ -22,6 +22,7 @@ When analyzing a document or process for regulatory compliance:
2222
4. **Classify findings** — Rate each finding by severity (CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL)
2323
5. **Recommend remediation** — Provide specific, actionable steps to address each finding
2424
6. **Assess confidence** — Rate your confidence in each finding (HIGH, MEDIUM, LOW)
25+
7. **Validate citations** — Verify all cited rules exist and are current before finalizing
2526

2627
## Regulatory Priority Order
2728
When multiple frameworks apply, prioritize in this order:
@@ -66,3 +67,14 @@ When multiple frameworks apply, prioritize in this order:
6667
### Disclaimer
6768
This analysis is for informational purposes only and does not constitute legal advice.
6869
```
70+
71+
### Example Finding
72+
73+
```
74+
#### CRITICAL
75+
- **Inadequate Suitability Disclosure** — FINRA Rule 2111
76+
- Issue: Customer account agreement lacks suitability questionnaire for complex products
77+
- Evidence: Section 4.2 references "suitable investments" without defining suitability criteria or risk tolerance assessment
78+
- Remediation: Add suitability assessment form per FINRA Rule 2111.05 (Supplementary Material) before account opening
79+
- Confidence: HIGH
80+
```

examples/gitagent-helper/skills/create-agent/SKILL.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: create-agent
3-
description: Guide users through agent.yaml configuration, SOUL.md writing, and directory structure
3+
description: "Creates and configures agent.yaml files, writes SOUL.md personality definitions, and sets up agent directory structures with skills, tools, and knowledge. Use when the user wants to configure an agent, create agent.yaml, write SOUL.md, set up agent directory structure, or customize agent settings."
44
license: MIT
55
metadata:
66
author: gitagent
@@ -10,8 +10,13 @@ metadata:
1010

1111
# Create & Configure Agents
1212

13-
## When to Use
14-
When a user wants to customize their agent.yaml, write a good SOUL.md, add skills/tools/knowledge, or set up compliance.
13+
## Quick Start
14+
15+
1. Create directory structure: `mkdir -p my-agent/skills`
16+
2. Write `agent.yaml` with required fields (see below)
17+
3. Create `SOUL.md` with agent identity
18+
4. Add skills, tools, and knowledge as needed
19+
5. Validate: `gitagent validate -d ./my-agent`
1520

1621
## agent.yaml Reference
1722

examples/gitagent-helper/skills/export-agent/SKILL.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: export-agent
3-
description: Help users export agents to other frameworks and import from existing tools
3+
description: "Converts agent definitions between frameworks — exports to Claude Code, OpenAI, CrewAI, Lyzr, and GitHub Models formats, and imports from Claude, Cursor, and CrewAI projects. Use when the user wants to convert an agent, migrate to another framework, export to LangChain/AutoGen/CrewAI, or import from existing automation tools."
44
license: MIT
55
metadata:
66
author: gitagent
@@ -10,8 +10,14 @@ metadata:
1010

1111
# Export & Import Agents
1212

13-
## When to Use
14-
When a user wants to convert their agent to another framework format, or import an existing agent into gitagent.
13+
## Verify Export
14+
15+
After exporting, check the output matches expectations:
16+
17+
```bash
18+
# Verify export file was created and contains agent name
19+
gitagent export -f system-prompt -d ./my-agent | head -5
20+
```
1521

1622
## Export
1723

examples/gitagent-helper/skills/get-started/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: get-started
3-
description: Help users install gitagent and create their first agent from scratch
3+
description: "Guides installation of gitagent and creation of first agent with scaffolding, configuration, and validation. Use when the user is new to gitagent, asks how to get started, wants to install gitagent, set up their first agent, or says 'how do I start?'"
44
license: MIT
55
metadata:
66
author: gitagent

examples/gitagent-helper/skills/manage-skills/SKILL.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: manage-skills
3-
description: Help users search, install, create, and manage agent skills
3+
description: "Searches the SkillsMP registry, installs skills locally or globally, creates custom skills with SKILL.md frontmatter, and manages the skill lifecycle. Use when the user wants to find skills, add new capabilities, install a skill, browse available skills, create a custom skill, or manage the skills system."
44
license: MIT
55
metadata:
66
author: gitagent
@@ -13,6 +13,14 @@ metadata:
1313
## When to Use
1414
When a user wants to find skills, install them, create new ones, or understand the skills system.
1515

16+
## Verify Installation
17+
18+
After installing a skill, confirm it's available:
19+
20+
```bash
21+
gitagent skills list -d ./my-agent | grep "code-review"
22+
```
23+
1624
## Search Skills
1725

1826
```bash

examples/gitagent-helper/skills/run-agent/SKILL.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: run-agent
3-
description: Help users run agents with different adapters Claude, OpenAI, Lyzr, GitHub Models, and more
3+
description: "Configures and runs agents with different adapters including Claude, OpenAI, CrewAI, Lyzr, and GitHub Models. Supports local execution, remote git repos, and one-shot prompts. Use when the user wants to run an agent, switch LLM providers, configure adapter settings, or launch agents from git repositories."
44
license: MIT
55
metadata:
66
author: gitagent
@@ -13,6 +13,14 @@ metadata:
1313
## When to Use
1414
When a user wants to run an agent locally, from a git repo, or with a specific adapter/framework.
1515

16+
## Troubleshooting
17+
18+
If you see authentication errors:
19+
- **Claude**: Ensure Claude Code is authenticated (`claude auth status`)
20+
- **OpenAI**: Verify `OPENAI_API_KEY` is set and valid
21+
- **GitHub**: Check `GITHUB_TOKEN` has correct permissions
22+
- **Lyzr**: Confirm `LYZR_API_KEY` is active
23+
1624
## Basic Usage
1725

1826
```bash

examples/lyzr-agent/skills/research/SKILL.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: research
3-
description: Research a topic and produce a structured summary with key findings
3+
description: "Researches a topic by breaking it into subtopics, gathering factual information with reasoning, and producing a structured summary with key findings and open questions. Use when the user asks to research, investigate, look up, summarize a topic, or says 'what is known about...' or 'learn about...'"
44
license: MIT
55
metadata:
66
author: gitagent-examples
@@ -34,3 +34,26 @@ When researching a topic:
3434
## Suggested Follow-ups
3535
- [Related questions the user might want to explore]
3636
```
37+
38+
### Example Output
39+
40+
```
41+
## TL;DR
42+
WebAssembly (Wasm) is a binary instruction format that enables near-native performance in browsers and increasingly in server-side contexts.
43+
44+
## Research Findings
45+
46+
### Browser Support & Adoption
47+
- All major browsers support Wasm since 2017 — Chrome, Firefox, Safari, Edge
48+
- Used in production by Figma (rendering engine), Google Earth (3D), and AutoCAD (web port)
49+
50+
### Performance Characteristics
51+
- Typically 1.1-1.5x native speed for compute-heavy tasks
52+
- **Uncertain**: Exact overhead varies significantly by workload type and runtime
53+
54+
## Open Questions
55+
- How will the component model proposal affect cross-language interop?
56+
57+
## Suggested Follow-ups
58+
- Compare Wasm vs JavaScript performance for specific use cases
59+
```

examples/standard/skills/code-review/SKILL.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: code-review
3-
description: Review code changes for quality, security, and best practices
3+
description: "Reviews code diffs and files for security vulnerabilities (OWASP Top 10), error handling, complexity, naming conventions, and performance issues. Use when the user asks to review a PR, pull request, diff, merge request, or code changes."
44
license: MIT
55
allowed-tools: lint-check complexity-analysis
66
metadata:
@@ -40,3 +40,17 @@ When reviewing code:
4040
## What's Done Well
4141
- [Positive observations]
4242
```
43+
44+
### Example Finding
45+
46+
```
47+
### CRITICAL
48+
- **Line 42**: SQL injection vulnerability — user input concatenated directly into query string.
49+
Fix: Use parameterized queries instead of string concatenation.
50+
```python
51+
# Before (vulnerable)
52+
cursor.execute(f"SELECT * FROM users WHERE id = {user_id}")
53+
# After (safe)
54+
cursor.execute("SELECT * FROM users WHERE id = %s", (user_id,))
55+
```
56+
```

0 commit comments

Comments
 (0)