@cleocode/cleo 2026.2.8 → 2026.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -13
- package/dist/cli/index.js +22676 -26012
- package/dist/cli/index.js.map +4 -4
- package/dist/mcp/index.js +1651 -802
- package/dist/mcp/index.js.map +4 -4
- package/drizzle/20260301053344_careless_changeling/migration.sql +27 -0
- package/drizzle/20260301053344_careless_changeling/snapshot.json +2598 -0
- package/package.json +3 -4
- package/packages/ct-skills/skills/ct-cleo/SKILL.md +49 -22
- package/templates/CLEO-INJECTION.md +32 -138
- package/templates/cleo-gitignore +66 -49
- package/templates/git-hooks/pre-commit +24 -6
- package/schemas/archive/agent-configs.schema.json +0 -120
- package/schemas/archive/agent-registry.schema.json +0 -132
- package/schemas/archive/archive.schema.json +0 -450
- package/schemas/archive/claudedocs-frontmatter.schema.json +0 -162
- package/schemas/archive/commands-index.schema.json +0 -158
- package/schemas/archive/contribution.schema.json +0 -722
- package/schemas/archive/critical-path.schema.json +0 -246
- package/schemas/archive/deps-cache.schema.json +0 -97
- package/schemas/archive/doctor-output.schema.json +0 -283
- package/schemas/archive/error.schema.json +0 -161
- package/schemas/archive/export-package.schema.json +0 -375
- package/schemas/archive/global-config.schema.json +0 -219
- package/schemas/archive/log.schema.json +0 -250
- package/schemas/archive/metrics.schema.json +0 -328
- package/schemas/archive/migrations.schema.json +0 -150
- package/schemas/archive/nexus-registry.schema.json +0 -90
- package/schemas/archive/output.schema.json +0 -164
- package/schemas/archive/rcsd-consensus-report.schema.json +0 -491
- package/schemas/archive/rcsd-hitl-resolution.schema.json +0 -216
- package/schemas/archive/rcsd-index.schema.json +0 -384
- package/schemas/archive/rcsd-manifest.schema.json +0 -264
- package/schemas/archive/rcsd-research-output.schema.json +0 -564
- package/schemas/archive/rcsd-spec-frontmatter.schema.json +0 -225
- package/schemas/archive/releases.schema.json +0 -267
- package/schemas/archive/skills-manifest.schema.json +0 -91
- package/schemas/archive/skillsmp.schema.json +0 -208
- package/schemas/archive/spec-index.schema.json +0 -196
- package/schemas/archive/todo.schema.json +0 -995
- package/schemas/claudedocs-frontmatter.schema.json +0 -162
- package/schemas/commands-index.schema.json +0 -158
- package/schemas/rcsd-consensus-report.schema.json +0 -494
- package/schemas/rcsd-hitl-resolution.schema.json +0 -219
- package/schemas/rcsd-index.schema.json +0 -387
- package/schemas/rcsd-manifest.schema.json +0 -267
- package/schemas/rcsd-research-output.schema.json +0 -567
- package/schemas/rcsd-spec-frontmatter.schema.json +0 -225
- package/schemas/todo.schema.json +0 -994
- package/skills/_shared/cleo-style-guide.md +0 -84
- package/skills/_shared/manifest-operations.md +0 -810
- package/skills/_shared/placeholders.json +0 -433
- package/skills/_shared/skill-chaining-patterns.md +0 -240
- package/skills/_shared/subagent-protocol-base.md +0 -221
- package/skills/_shared/task-system-integration.md +0 -232
- package/skills/_shared/testing-framework-config.md +0 -110
- package/skills/agentskills-integrate.md +0 -104
- package/skills/agentskills-specs.md +0 -255
- package/skills/agentskills-what-are-skills.md +0 -75
- package/skills/manifest.json +0 -510
- package/templates/AGENT-INJECTION.md +0 -166
- /package/schemas/{research-manifest.schema.json → archive/research-manifest.schema.json} +0 -0
|
@@ -1,255 +0,0 @@
|
|
|
1
|
-
# Specification
|
|
2
|
-
|
|
3
|
-
> The complete format specification for Agent Skills.
|
|
4
|
-
|
|
5
|
-
This document defines the Agent Skills format.
|
|
6
|
-
|
|
7
|
-
## Directory structure
|
|
8
|
-
|
|
9
|
-
A skill is a directory containing at minimum a `SKILL.md` file:
|
|
10
|
-
|
|
11
|
-
```
|
|
12
|
-
skill-name/
|
|
13
|
-
└── SKILL.md # Required
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
<Tip>
|
|
17
|
-
You can optionally include [additional directories](#optional-directories) such as `scripts/`, `references/`, and `assets/` to support your skill.
|
|
18
|
-
</Tip>
|
|
19
|
-
|
|
20
|
-
## SKILL.md format
|
|
21
|
-
|
|
22
|
-
The `SKILL.md` file must contain YAML frontmatter followed by Markdown content.
|
|
23
|
-
|
|
24
|
-
### Frontmatter (required)
|
|
25
|
-
|
|
26
|
-
```yaml theme={null}
|
|
27
|
-
---
|
|
28
|
-
name: skill-name
|
|
29
|
-
description: A description of what this skill does and when to use it.
|
|
30
|
-
---
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
With optional fields:
|
|
34
|
-
|
|
35
|
-
```yaml theme={null}
|
|
36
|
-
---
|
|
37
|
-
name: pdf-processing
|
|
38
|
-
description: Extract text and tables from PDF files, fill forms, merge documents.
|
|
39
|
-
license: Apache-2.0
|
|
40
|
-
metadata:
|
|
41
|
-
author: example-org
|
|
42
|
-
version: "1.0"
|
|
43
|
-
---
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
| Field | Required | Constraints |
|
|
47
|
-
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
48
|
-
| `name` | Yes | Max 64 characters. Lowercase letters, numbers, and hyphens only. Must not start or end with a hyphen. |
|
|
49
|
-
| `description` | Yes | Max 1024 characters. Non-empty. Describes what the skill does and when to use it. |
|
|
50
|
-
| `license` | No | License name or reference to a bundled license file. |
|
|
51
|
-
| `compatibility` | No | Max 500 characters. Indicates environment requirements (intended product, system packages, network access, etc.). |
|
|
52
|
-
| `metadata` | No | Arbitrary key-value mapping for additional metadata. |
|
|
53
|
-
| `allowed-tools` | No | Space-delimited list of pre-approved tools the skill may use. (Experimental) |
|
|
54
|
-
|
|
55
|
-
#### `name` field
|
|
56
|
-
|
|
57
|
-
The required `name` field:
|
|
58
|
-
|
|
59
|
-
* Must be 1-64 characters
|
|
60
|
-
* May only contain unicode lowercase alphanumeric characters and hyphens (`a-z` and `-`)
|
|
61
|
-
* Must not start or end with `-`
|
|
62
|
-
* Must not contain consecutive hyphens (`--`)
|
|
63
|
-
* Must match the parent directory name
|
|
64
|
-
|
|
65
|
-
Valid examples:
|
|
66
|
-
|
|
67
|
-
```yaml theme={null}
|
|
68
|
-
name: pdf-processing
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
```yaml theme={null}
|
|
72
|
-
name: data-analysis
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
```yaml theme={null}
|
|
76
|
-
name: code-review
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Invalid examples:
|
|
80
|
-
|
|
81
|
-
```yaml theme={null}
|
|
82
|
-
name: PDF-Processing # uppercase not allowed
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
```yaml theme={null}
|
|
86
|
-
name: -pdf # cannot start with hyphen
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
```yaml theme={null}
|
|
90
|
-
name: pdf--processing # consecutive hyphens not allowed
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
#### `description` field
|
|
94
|
-
|
|
95
|
-
The required `description` field:
|
|
96
|
-
|
|
97
|
-
* Must be 1-1024 characters
|
|
98
|
-
* Should describe both what the skill does and when to use it
|
|
99
|
-
* Should include specific keywords that help agents identify relevant tasks
|
|
100
|
-
|
|
101
|
-
Good example:
|
|
102
|
-
|
|
103
|
-
```yaml theme={null}
|
|
104
|
-
description: Extracts text and tables from PDF files, fills PDF forms, and merges multiple PDFs. Use when working with PDF documents or when the user mentions PDFs, forms, or document extraction.
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Poor example:
|
|
108
|
-
|
|
109
|
-
```yaml theme={null}
|
|
110
|
-
description: Helps with PDFs.
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
#### `license` field
|
|
114
|
-
|
|
115
|
-
The optional `license` field:
|
|
116
|
-
|
|
117
|
-
* Specifies the license applied to the skill
|
|
118
|
-
* We recommend keeping it short (either the name of a license or the name of a bundled license file)
|
|
119
|
-
|
|
120
|
-
Example:
|
|
121
|
-
|
|
122
|
-
```yaml theme={null}
|
|
123
|
-
license: Proprietary. LICENSE.txt has complete terms
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
#### `compatibility` field
|
|
127
|
-
|
|
128
|
-
The optional `compatibility` field:
|
|
129
|
-
|
|
130
|
-
* Must be 1-500 characters if provided
|
|
131
|
-
* Should only be included if your skill has specific environment requirements
|
|
132
|
-
* Can indicate intended product, required system packages, network access needs, etc.
|
|
133
|
-
|
|
134
|
-
Examples:
|
|
135
|
-
|
|
136
|
-
```yaml theme={null}
|
|
137
|
-
compatibility: Designed for Claude Code (or similar products)
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
```yaml theme={null}
|
|
141
|
-
compatibility: Requires git, docker, jq, and access to the internet
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
<Note>
|
|
145
|
-
Most skills do not need the `compatibility` field.
|
|
146
|
-
</Note>
|
|
147
|
-
|
|
148
|
-
#### `metadata` field
|
|
149
|
-
|
|
150
|
-
The optional `metadata` field:
|
|
151
|
-
|
|
152
|
-
* A map from string keys to string values
|
|
153
|
-
* Clients can use this to store additional properties not defined by the Agent Skills spec
|
|
154
|
-
* We recommend making your key names reasonably unique to avoid accidental conflicts
|
|
155
|
-
|
|
156
|
-
Example:
|
|
157
|
-
|
|
158
|
-
```yaml theme={null}
|
|
159
|
-
metadata:
|
|
160
|
-
author: example-org
|
|
161
|
-
version: "1.0"
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
#### `allowed-tools` field
|
|
165
|
-
|
|
166
|
-
The optional `allowed-tools` field:
|
|
167
|
-
|
|
168
|
-
* A space-delimited list of tools that are pre-approved to run
|
|
169
|
-
* Experimental. Support for this field may vary between agent implementations
|
|
170
|
-
|
|
171
|
-
Example:
|
|
172
|
-
|
|
173
|
-
```yaml theme={null}
|
|
174
|
-
allowed-tools: Bash(git:*) Bash(jq:*) Read
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
### Body content
|
|
178
|
-
|
|
179
|
-
The Markdown body after the frontmatter contains the skill instructions. There are no format restrictions. Write whatever helps agents perform the task effectively.
|
|
180
|
-
|
|
181
|
-
Recommended sections:
|
|
182
|
-
|
|
183
|
-
* Step-by-step instructions
|
|
184
|
-
* Examples of inputs and outputs
|
|
185
|
-
* Common edge cases
|
|
186
|
-
|
|
187
|
-
Note that the agent will load this entire file once it's decided to activate a skill. Consider splitting longer `SKILL.md` content into referenced files.
|
|
188
|
-
|
|
189
|
-
## Optional directories
|
|
190
|
-
|
|
191
|
-
### scripts/
|
|
192
|
-
|
|
193
|
-
Contains executable code that agents can run. Scripts should:
|
|
194
|
-
|
|
195
|
-
* Be self-contained or clearly document dependencies
|
|
196
|
-
* Include helpful error messages
|
|
197
|
-
* Handle edge cases gracefully
|
|
198
|
-
|
|
199
|
-
Supported languages depend on the agent implementation. Common options include Python, Bash, and JavaScript.
|
|
200
|
-
|
|
201
|
-
### references/
|
|
202
|
-
|
|
203
|
-
Contains additional documentation that agents can read when needed:
|
|
204
|
-
|
|
205
|
-
* `REFERENCE.md` - Detailed technical reference
|
|
206
|
-
* `FORMS.md` - Form templates or structured data formats
|
|
207
|
-
* Domain-specific files (`finance.md`, `legal.md`, etc.)
|
|
208
|
-
|
|
209
|
-
Keep individual [reference files](#file-references) focused. Agents load these on demand, so smaller files mean less use of context.
|
|
210
|
-
|
|
211
|
-
### assets/
|
|
212
|
-
|
|
213
|
-
Contains static resources:
|
|
214
|
-
|
|
215
|
-
* Templates (document templates, configuration templates)
|
|
216
|
-
* Images (diagrams, examples)
|
|
217
|
-
* Data files (lookup tables, schemas)
|
|
218
|
-
|
|
219
|
-
## Progressive disclosure
|
|
220
|
-
|
|
221
|
-
Skills should be structured for efficient use of context:
|
|
222
|
-
|
|
223
|
-
1. **Metadata** (\~100 tokens): The `name` and `description` fields are loaded at startup for all skills
|
|
224
|
-
2. **Instructions** (\< 5000 tokens recommended): The full `SKILL.md` body is loaded when the skill is activated
|
|
225
|
-
3. **Resources** (as needed): Files (e.g. those in `scripts/`, `references/`, or `assets/`) are loaded only when required
|
|
226
|
-
|
|
227
|
-
Keep your main `SKILL.md` under 500 lines. Move detailed reference material to separate files.
|
|
228
|
-
|
|
229
|
-
## File references
|
|
230
|
-
|
|
231
|
-
When referencing other files in your skill, use relative paths from the skill root:
|
|
232
|
-
|
|
233
|
-
```markdown theme={null}
|
|
234
|
-
See [the reference guide](references/REFERENCE.md) for details.
|
|
235
|
-
|
|
236
|
-
Run the extraction script:
|
|
237
|
-
scripts/extract.py
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
Keep file references one level deep from `SKILL.md`. Avoid deeply nested reference chains.
|
|
241
|
-
|
|
242
|
-
## Validation
|
|
243
|
-
|
|
244
|
-
Use the [skills-ref](https://github.com/agentskills/agentskills/tree/main/skills-ref) reference library to validate your skills:
|
|
245
|
-
|
|
246
|
-
```bash theme={null}
|
|
247
|
-
skills-ref validate ./my-skill
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
This checks that your `SKILL.md` frontmatter is valid and follows all naming conventions.
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
---
|
|
254
|
-
|
|
255
|
-
> To find navigation and other pages in this documentation, fetch the llms.txt file at: https://agentskills.io/llms.txt
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
# What are skills?
|
|
2
|
-
|
|
3
|
-
> Agent Skills are a lightweight, open format for extending AI agent capabilities with specialized knowledge and workflows.
|
|
4
|
-
|
|
5
|
-
At its core, a skill is a folder containing a `SKILL.md` file. This file includes metadata (`name` and `description`, at minimum) and instructions that tell an agent how to perform a specific task. Skills can also bundle scripts, templates, and reference materials.
|
|
6
|
-
|
|
7
|
-
```directory theme={null}
|
|
8
|
-
my-skill/
|
|
9
|
-
├── SKILL.md # Required: instructions + metadata
|
|
10
|
-
├── scripts/ # Optional: executable code
|
|
11
|
-
├── references/ # Optional: documentation
|
|
12
|
-
└── assets/ # Optional: templates, resources
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## How skills work
|
|
16
|
-
|
|
17
|
-
Skills use **progressive disclosure** to manage context efficiently:
|
|
18
|
-
|
|
19
|
-
1. **Discovery**: At startup, agents load only the name and description of each available skill, just enough to know when it might be relevant.
|
|
20
|
-
|
|
21
|
-
2. **Activation**: When a task matches a skill's description, the agent reads the full `SKILL.md` instructions into context.
|
|
22
|
-
|
|
23
|
-
3. **Execution**: The agent follows the instructions, optionally loading referenced files or executing bundled code as needed.
|
|
24
|
-
|
|
25
|
-
This approach keeps agents fast while giving them access to more context on demand.
|
|
26
|
-
|
|
27
|
-
## The SKILL.md file
|
|
28
|
-
|
|
29
|
-
Every skill starts with a `SKILL.md` file containing YAML frontmatter and Markdown instructions:
|
|
30
|
-
|
|
31
|
-
```mdx theme={null}
|
|
32
|
-
---
|
|
33
|
-
name: pdf-processing
|
|
34
|
-
description: Extract text and tables from PDF files, fill forms, merge documents.
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
# PDF Processing
|
|
38
|
-
|
|
39
|
-
## When to use this skill
|
|
40
|
-
Use this skill when the user needs to work with PDF files...
|
|
41
|
-
|
|
42
|
-
## How to extract text
|
|
43
|
-
1. Use pdfplumber for text extraction...
|
|
44
|
-
|
|
45
|
-
## How to fill forms
|
|
46
|
-
...
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
The following frontmatter is required at the top of `SKILL.md`:
|
|
50
|
-
|
|
51
|
-
* `name`: A short identifier
|
|
52
|
-
* `description`: When to use this skill
|
|
53
|
-
|
|
54
|
-
The Markdown body contains the actual instructions and has no specific restrictions on structure or content.
|
|
55
|
-
|
|
56
|
-
This simple format has some key advantages:
|
|
57
|
-
|
|
58
|
-
* **Self-documenting**: A skill author or user can read a `SKILL.md` and understand what it does, making skills easy to audit and improve.
|
|
59
|
-
|
|
60
|
-
* **Extensible**: Skills can range in complexity from just text instructions to executable code, assets, and templates.
|
|
61
|
-
|
|
62
|
-
* **Portable**: Skills are just files, so they're easy to edit, version, and share.
|
|
63
|
-
|
|
64
|
-
## Next steps
|
|
65
|
-
|
|
66
|
-
* [View the specification](/specification) to understand the full format.
|
|
67
|
-
* [Add skills support to your agent](/integrate-skills) to build a compatible client.
|
|
68
|
-
* [See example skills](https://github.com/anthropics/skills) on GitHub.
|
|
69
|
-
* [Read authoring best practices](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) for writing effective skills.
|
|
70
|
-
* [Use the reference library](https://github.com/agentskills/agentskills/tree/main/skills-ref) to validate skills and generate prompt XML.
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
> To find navigation and other pages in this documentation, fetch the llms.txt file at: https://agentskills.io/llms.txt
|