@agent-smith/feat-agents 0.0.1 → 0.0.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.
- package/README.md +138 -37
- package/dist/agents/agent-smith-assistant.yml +6 -4
- package/dist/agents/agent-smith-code.yml +9 -4
- package/dist/agents/agent-smith-doc.yml +5 -15
- package/dist/agents/agent-smith-help-assistant.yml +2 -3
- package/dist/agents/agent-smith-help-light.yml +2 -5
- package/dist/agents/agent-smith.yml +1 -0
- package/dist/skills/create-project-docs/SKILL.md +232 -60
- package/dist/skills/create-readme/SKILL.md +5 -4
- package/dist/skills/create-task-from-template/SKILL.md +108 -0
- package/dist/skills/document-package/SKILL.md +19 -48
- package/dist/skills/execute-task-solo/SKILL.md +1 -0
- package/dist/skills/execute-task-team/SKILL.md +2 -0
- package/dist/skills/smart-explore/SKILL.md +47 -0
- package/dist/skills/update-codebase-summary/SKILL.md +13 -5
- package/dist/skills/update-project-nav/SKILL.md +20 -19
- package/dist/tasks/update-project-doc/goals.md +27 -0
- package/dist/tasks/update-project-doc/notes.md +35 -0
- package/dist/tasks/update-project-doc/plan.md +212 -0
- package/dist/tasks/update-project-doc/state.md +42 -0
- package/package.json +1 -1
- package/dist/skills/update-doc-map/SKILL.md +0 -8
- package/dist/skills/update-doc-map/scripts/generate-doc-map.mjs +0 -197
|
@@ -9,12 +9,15 @@ Create or update the documentation files that help AI agents navigate a codebase
|
|
|
9
9
|
|
|
10
10
|
| File | Scope | Purpose |
|
|
11
11
|
|------|-------|---------|
|
|
12
|
-
| `AGENTS.md` | Project root | Index with
|
|
13
|
-
|
|
|
12
|
+
| `AGENTS.md` | Project root | Index with mission, conventions, quick start, and doc links |
|
|
13
|
+
| `<repo>/AGENTS.md` | Each repo (multi-repo only) | Localized context for agents working in that repo |
|
|
14
|
+
| `.agents/documentation/decision-tree.md` | Project root only | Quick guide: find the right doc for your task |
|
|
15
|
+
| `.agents/documentation/project-overview.md` | Project root only | Concise project overview (~1 page) |
|
|
16
|
+
| `.agents/documentation/codebase-summary.md` | Every repo/module | Standardized technical summary (7 core + optional sections) |
|
|
14
17
|
| `.agents/documentation/project-nav.md` | Project root only | Comprehensive navigation map |
|
|
15
18
|
|
|
16
|
-
> **Single-repo projects**: All
|
|
17
|
-
> **Multi-repo projects**: `AGENTS.md` and `project-nav.md` at workspace root; each repo gets its own `AGENTS.md` and `codebase-summary.md`.
|
|
19
|
+
> **Single-repo projects**: All 5 files live at the project root.
|
|
20
|
+
> **Multi-repo projects**: `AGENTS.md`, `decision-tree.md`, `project-overview.md`, and `project-nav.md` at workspace root; each repo gets its own `AGENTS.md` and `codebase-summary.md`.
|
|
18
21
|
|
|
19
22
|
## Workflow
|
|
20
23
|
|
|
@@ -22,103 +25,272 @@ Execute steps in order:
|
|
|
22
25
|
|
|
23
26
|
### 1. Explore the Project
|
|
24
27
|
|
|
25
|
-
Walk the directory tree. Identify repos, packages/modules, entry points, dependencies, and key files. Read manifest or config files to understand structure and language.
|
|
28
|
+
Walk the directory tree. Identify repos, packages/modules, entry points, dependencies, and key files. Read manifest or config files to understand structure and language. Identify key conventions and patterns used by the project.
|
|
26
29
|
|
|
27
30
|
### 2. Create AGENTS.md (Project Root)
|
|
28
31
|
|
|
32
|
+
Use this exact structure:
|
|
33
|
+
|
|
29
34
|
```markdown
|
|
30
35
|
# <Project Name>
|
|
31
36
|
|
|
32
|
-
##
|
|
37
|
+
## Mission
|
|
38
|
+
<One-line mission statement describing what the project does and its core capabilities.>
|
|
33
39
|
|
|
34
|
-
|
|
35
|
-
2. **Comprehensive reference** → `.agents/documentation/project-nav.md` — Full project map
|
|
36
|
-
3. **Technical summary** → `.agents/documentation/codebase-summary.md` — Dependencies, entry points, key files
|
|
37
|
-
4. **Per-repo navigation** → Each repo has its own `AGENTS.md` and `.agents/documentation/codebase-summary.md`
|
|
40
|
+
## Repositories
|
|
38
41
|
|
|
39
|
-
|
|
42
|
+
| Repo | Path | Purpose |
|
|
43
|
+
|------|------|---------|
|
|
44
|
+
| `<repo-name>` | `</workspace/repo-path/>` | <One-line description> |
|
|
40
45
|
|
|
41
|
-
|
|
46
|
+
## Conventions (for AI Agents)
|
|
42
47
|
|
|
43
|
-
-
|
|
48
|
+
- **<Convention name>**: <Brief description of the pattern>
|
|
44
49
|
- ...
|
|
45
50
|
|
|
46
|
-
|
|
51
|
+
## Quick Start for AI Agents
|
|
52
|
+
|
|
53
|
+
1. Read `.agents/documentation/decision-tree.md` to find the right doc for your task
|
|
54
|
+
2. Read `.agents/documentation/project-overview.md` for high-level context
|
|
55
|
+
3. Read `.agents/documentation/project-nav.md` for detailed navigation and dependency graph
|
|
56
|
+
4. Navigate to the relevant repo/package and read its `.agents/documentation/codebase-summary.md`
|
|
47
57
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
-
|
|
58
|
+
## Documentation
|
|
59
|
+
|
|
60
|
+
- `.agents/documentation/decision-tree.md` — Quick guide: find the right doc for your task
|
|
61
|
+
- `.agents/documentation/codebase-summary.md` — Top-level codebase summary (structured, machine-readable)
|
|
62
|
+
- `.agents/documentation/project-overview.md` — Concise project overview (~1 page)
|
|
63
|
+
- `.agents/documentation/project-nav.md` — Detailed navigation map with dependency graph
|
|
64
|
+
- `<repo>/.agents/documentation/codebase-summary.md` — <Repo> summary
|
|
65
|
+
- ...
|
|
66
|
+
|
|
67
|
+
Each package or library directory has `.agents/documentation/codebase-summary.md`. Use them to navigate in the codebase easily.
|
|
51
68
|
```
|
|
52
69
|
|
|
53
|
-
|
|
70
|
+
**Rules for AGENTS.md**:
|
|
71
|
+
- **Mission**: One concise sentence capturing the project's purpose and capabilities
|
|
72
|
+
- **Repositories table**: Include all repos with path and one-line purpose
|
|
73
|
+
- **Conventions**: List 3-5 key patterns AI agents need to know (tool formats, file structures, state management, etc.)
|
|
74
|
+
- **Quick Start**: Always list `decision-tree.md` FIRST, then `project-overview.md`, then `project-nav.md`, then per-repo summaries
|
|
75
|
+
- **Documentation**: List all doc files with brief descriptions
|
|
76
|
+
|
|
77
|
+
### 3. Create Per-Repo AGENTS.md (Multi-Repo Projects Only)
|
|
54
78
|
|
|
55
|
-
|
|
79
|
+
For multi-repo projects, create an `AGENTS.md` in each repository so agents navigating directly to a repo have localized context:
|
|
56
80
|
|
|
57
81
|
```markdown
|
|
58
|
-
# <
|
|
82
|
+
# <Repo Name>
|
|
59
83
|
|
|
60
|
-
##
|
|
61
|
-
One
|
|
84
|
+
## Mission
|
|
85
|
+
<One-line mission statement for this specific repo.>
|
|
62
86
|
|
|
63
|
-
##
|
|
64
|
-
- `<internal-dep>` — what it provides
|
|
65
|
-
- External: `<library>` (<purpose>)
|
|
87
|
+
## Structure
|
|
66
88
|
|
|
67
|
-
|
|
68
|
-
|
|
89
|
+
| Directory | Purpose |
|
|
90
|
+
|-----------|---------|
|
|
91
|
+
| `<dir>` | <One-line description> |
|
|
69
92
|
|
|
70
|
-
##
|
|
71
|
-
- `<path>` — one-line description
|
|
93
|
+
## Conventions
|
|
72
94
|
|
|
73
|
-
|
|
74
|
-
| File | Purpose |
|
|
75
|
-
|------|---------|
|
|
76
|
-
| `<path>` | One-line: what the file does |
|
|
95
|
+
- **<Convention>**: <Brief description> (repo-specific patterns)
|
|
77
96
|
|
|
78
|
-
##
|
|
79
|
-
- 2–4 bullets on design patterns and data flow.
|
|
97
|
+
## Quick Start for AI Agents
|
|
80
98
|
|
|
81
|
-
|
|
82
|
-
|
|
99
|
+
1. Read `.agents/documentation/codebase-summary.md` for technical summary
|
|
100
|
+
2. Explore key files listed in codebase-summary.md
|
|
101
|
+
3. <Build/run instructions specific to this repo>
|
|
83
102
|
|
|
84
103
|
## Documentation
|
|
104
|
+
|
|
105
|
+
- `.agents/documentation/codebase-summary.md` — Technical summary of this repo
|
|
106
|
+
- `../../AGENTS.md` — Project-wide context and conventions (workspace root)
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
**Rules for per-repo AGENTS.md**:
|
|
110
|
+
- **Self-contained**: Should be useful for agents working directly in that repo
|
|
111
|
+
- **Structure table**: List key directories with one-line purposes
|
|
112
|
+
- **Conventions**: Include repo-specific conventions (subset of or additions to root conventions)
|
|
113
|
+
- **Quick Start**: Always reference the local codebase-summary.md first
|
|
114
|
+
- **Documentation**: Always link back to root `../../AGENTS.md` for project-wide context
|
|
115
|
+
- **Skip for single-repo**: Only create when there are multiple repos
|
|
116
|
+
|
|
117
|
+
### 4. Create decision-tree.md (Project Root Only)
|
|
118
|
+
|
|
119
|
+
Quick guide helping agents find the right documentation based on their task:
|
|
120
|
+
|
|
121
|
+
```markdown
|
|
122
|
+
# Documentation Decision Tree
|
|
123
|
+
|
|
124
|
+
> Quick guide: What to read based on your task
|
|
125
|
+
|
|
126
|
+
## I need to understand the project
|
|
127
|
+
|
|
128
|
+
- High-level overview → `.agents/documentation/project-overview.md`
|
|
129
|
+
- Full navigation map → `.agents/documentation/project-nav.md`
|
|
130
|
+
- Structured summary → `.agents/documentation/codebase-summary.md`
|
|
131
|
+
|
|
132
|
+
## I need to work on a specific repo/package
|
|
133
|
+
|
|
134
|
+
- `<repo>` → `<repo>/.agents/documentation/codebase-summary.md`
|
|
135
|
+
- ...
|
|
136
|
+
|
|
137
|
+
<!-- OPTIONAL: For monorepos with sub-packages, add this section -->
|
|
138
|
+
## I need to work on a specific package
|
|
139
|
+
|
|
140
|
+
- `<package-name>` → `<repo>/packages/<package>/.agents/documentation/codebase-summary.md`
|
|
141
|
+
- ...
|
|
142
|
+
|
|
143
|
+
## I need detailed documentation
|
|
144
|
+
|
|
145
|
+
- `<topic>` → `<path-to-docs>`
|
|
146
|
+
- ...
|
|
147
|
+
|
|
148
|
+
## Common Tasks (Quick Reference)
|
|
149
|
+
|
|
150
|
+
| Task | Go To |
|
|
151
|
+
|------|-------|
|
|
152
|
+
| <Task description> | `<path>` |
|
|
153
|
+
|
|
154
|
+
## Conventions
|
|
155
|
+
|
|
156
|
+
- <Convention> — <Brief description>
|
|
157
|
+
|
|
158
|
+
→ See `AGENTS.md` for full conventions summary.
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
**Rules for decision-tree.md**:
|
|
162
|
+
- Organize by task type (understand project, work on specific area, detailed docs)
|
|
163
|
+
- Include a "Common Tasks" table mapping tasks to paths
|
|
164
|
+
- End with reference to AGENTS.md for full conventions
|
|
165
|
+
- **Optional**: For monorepos with sub-packages, add a "I need to work on a specific package" section listing individual packages
|
|
166
|
+
|
|
167
|
+
### 5. Create project-overview.md (Project Root Only)
|
|
168
|
+
|
|
169
|
+
Concise ~1 page overview with these sections:
|
|
170
|
+
|
|
171
|
+
```markdown
|
|
172
|
+
# <Project Name> — Project Overview
|
|
173
|
+
|
|
174
|
+
> **Role**: Concise "what is this" for context loading (~1 page overview).
|
|
175
|
+
> **See also**: `.agents/documentation/decision-tree.md` to find the right doc for your task.
|
|
176
|
+
> **See also**: `.agents/documentation/project-nav.md` for detailed navigation and task references.
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## What is <Project Name>?
|
|
181
|
+
|
|
182
|
+
<One paragraph describing the project, its purpose, and core capabilities.>
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## Core Capabilities
|
|
187
|
+
|
|
188
|
+
- **<Capability 1>** — <Brief description>
|
|
189
|
+
- **<Capability 2>** — <Brief description>
|
|
190
|
+
- ...
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Repository Structure
|
|
195
|
+
|
|
196
|
+
| Repo | Path | Purpose |
|
|
197
|
+
|------|------|---------|
|
|
198
|
+
| `<repo>` | `<path>` | <Purpose> |
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
<!-- OPTIONAL: For monorepos with internal packages, add this section after Repository Structure -->
|
|
203
|
+
## Runtime Packages (`<repo>/packages/`)
|
|
204
|
+
|
|
205
|
+
| Package | Purpose |
|
|
206
|
+
|---------|---------|
|
|
207
|
+
| `<package>` | <One-line purpose> |
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Key Architecture Patterns
|
|
212
|
+
|
|
213
|
+
- **<Pattern>**: <Brief description>
|
|
214
|
+
- ...
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## Quick Reference: Common Tasks
|
|
219
|
+
|
|
220
|
+
| Task | Go To |
|
|
221
|
+
|------|-------|
|
|
222
|
+
| <Task> | `<path>` |
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## Code Snippets
|
|
227
|
+
|
|
228
|
+
### <Snippet Title>
|
|
229
|
+
```<language>
|
|
230
|
+
# Example code showing typical usage
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## Documentation Links
|
|
236
|
+
|
|
85
237
|
| Resource | Path |
|
|
86
238
|
|----------|------|
|
|
87
|
-
|
|
|
88
|
-
|
|
239
|
+
| <Resource name> | `<path>` |
|
|
240
|
+
|
|
241
|
+
**Rules for project-overview.md**:
|
|
242
|
+
- Keep to ~1 page
|
|
243
|
+
- Include header notes referencing decision-tree.md and project-nav.md
|
|
244
|
+
- Include code snippets showing typical usage patterns
|
|
245
|
+
- End with documentation links table
|
|
246
|
+
- **Optional**: For monorepos with internal packages, add a "Runtime Packages" table after Repository Structure
|
|
247
|
+
|
|
248
|
+
### 6. Create codebase-summary.md (Every Repo/Module)
|
|
89
249
|
|
|
90
|
-
|
|
250
|
+
Load and follow the `update-codebase-summary` skill for each repo/module. This specialized skill defines the standardized 7-section format (Summary, Dependencies, Used By, Entry Point, Key Files, Architecture, Related).
|
|
91
251
|
|
|
92
|
-
|
|
252
|
+
> **Note**: Include the optional "Documentation" section ONLY in the project root `codebase-summary.md` — lists all doc resources with paths. Omit from per-repo/module summaries.
|
|
93
253
|
|
|
94
|
-
|
|
254
|
+
### 7. Create project-nav.md (Project Root Only)
|
|
95
255
|
|
|
96
|
-
|
|
97
|
-
2. **Architecture Principles** — Table: Principle | Detail | Key Files
|
|
98
|
-
3. **Dependency Graph** — ASCII art showing module dependencies + prose explanation
|
|
99
|
-
4. **Packages/Modules** — Per-module: Purpose, Key files, Key types/classes
|
|
100
|
-
5. **Server** (if applicable) — Routes, key files, patterns
|
|
101
|
-
6. **Plugins** (if applicable) — Categories, plugins table, key files
|
|
102
|
-
7. **UI** (if applicable) — Components, services, themes, extensions
|
|
103
|
-
8. **Apps** (if applicable) — Extensions, dependencies
|
|
104
|
-
9. **Code Snippets** — Language-appropriate examples showing typical usage
|
|
105
|
-
10. **Navigation Quick Reference** — Task → Path table for common development tasks
|
|
106
|
-
11. **Documentation Links** — All doc resources with paths
|
|
107
|
-
12. **Key Conventions & Patterns** — Naming, file structure, tool formats, etc.
|
|
256
|
+
Load and follow the `update-project-nav` skill. This specialized skill defines all required sections (Project Overview, Architecture Principles, Dependency Graph, Packages/Modules, Code Snippets, Navigation Quick Reference, Documentation Links, Key Conventions & Patterns) and optional sections (Server, Plugins, UI, Apps, project-specific).
|
|
108
257
|
|
|
109
|
-
|
|
258
|
+
> **Tip**: Number sections sequentially based on which ones you include. Skip numbers for omitted optional sections.
|
|
110
259
|
|
|
111
|
-
|
|
260
|
+
> **Note**: Include the header note: `> Purpose: Single-reference map for AI coding agents to understand, navigate, and modify the <Project Name> codebase.`
|
|
112
261
|
|
|
113
|
-
|
|
114
|
-
|
|
262
|
+
### 8. Cross-Reference and Verify
|
|
263
|
+
|
|
264
|
+
- Root `AGENTS.md` → links to decision-tree.md, project-overview.md, project-nav.md, codebase-summary.md, and per-repo AGENTS.md files
|
|
265
|
+
- Per-repo `AGENTS.md` → links to local codebase-summary.md; links back to root `../../AGENTS.md` for project-wide context
|
|
266
|
+
- `decision-tree.md` → references all doc files; ends with link to root AGENTS.md for conventions
|
|
267
|
+
- `project-overview.md` → header notes reference decision-tree.md and project-nav.md
|
|
268
|
+
- `codebase-summary.md` → Related section points to related modules
|
|
115
269
|
- `project-nav.md` → no external cross-references needed (it's the primary source)
|
|
116
|
-
|
|
270
|
+
|
|
271
|
+
**No duplicated content across files**:
|
|
272
|
+
- Project description, architecture patterns, code snippets, and quick-reference tables live ONLY in `project-nav.md` and `project-overview.md`
|
|
273
|
+
- Per-module technical details (entry points, key files, dependencies) live in `codebase-summary.md`
|
|
274
|
+
- Conventions summary lives in root `AGENTS.md`; decision-tree.md references it
|
|
275
|
+
- Per-repo context (structure, repo-specific conventions) lives in per-repo `AGENTS.md`
|
|
117
276
|
|
|
118
277
|
## Rules
|
|
119
278
|
|
|
120
279
|
- **No redundancy**: Each piece of information lives in exactly one file
|
|
121
|
-
- **codebase-summary.md
|
|
280
|
+
- **codebase-summary.md core format**: The 7-section structure (Summary, Dependencies, Used By, Entry Point, Key Files, Architecture, Related) is standardized — do not change the order or rename sections. Optional "Documentation" section may be added at the end for the project root only.
|
|
122
281
|
- **Information-dense**: Keep files short. Use tables, bullets, one-line descriptions
|
|
123
282
|
- **project-nav.md is canonical**: Single source of truth for project overview, architecture, snippets, and quick references
|
|
283
|
+
- **decision-tree.md first**: Always the first file agents should read to find the right doc
|
|
124
284
|
- **Language-agnostic**: Adapt examples and conventions to the project's language and ecosystem
|
|
285
|
+
- **Adapt optional sections**: Include optional sections (sub-packages in decision-tree, Runtime Packages in project-overview, Documentation in codebase-summary, conditional sections in project-nav) only when they add value for the specific project
|
|
286
|
+
|
|
287
|
+
## Related Skills
|
|
288
|
+
|
|
289
|
+
| Skill | When to Use |
|
|
290
|
+
|-------|-------------|
|
|
291
|
+
| `update-codebase-summary` | Used in **step 6** to create/update each module's `.agents/documentation/codebase-summary.md` |
|
|
292
|
+
| `update-project-nav` | Used in **step 7** to create/update the project root `.agents/documentation/project-nav.md` |
|
|
293
|
+
| `document-package` | Create/update documentation for a package in the project docsite |
|
|
294
|
+
| `update-doc-map` | Regenerate the documentation map (runs a script) |
|
|
295
|
+
|
|
296
|
+
> **Tip**: Steps 6 and 7 load these specialized skills during initial creation. Use them again for ongoing targeted updates after code changes.
|
|
@@ -11,12 +11,13 @@ description: use this to create comprehensive README file for a given package or
|
|
|
11
11
|
3. Locate target in the codebase summary (note its position, dependencies, and purpose)
|
|
12
12
|
|
|
13
13
|
### Phase 2: Deep Dive
|
|
14
|
-
3.
|
|
15
|
-
4.
|
|
16
|
-
5. Read documentation
|
|
14
|
+
3. Use the `smart-explore` skill to walk the module's directory tree
|
|
15
|
+
4. Navigate to directory: `/workspace/agent-smith/packages/{package-name}/` for a package, adapt the path
|
|
16
|
+
5. Read `.agents/documentation/codebase-summary.md` for architecture, key files, and usage patterns
|
|
17
|
+
6. Read documentation from `/workspace/agent-smith/docsite/public/doc/libraries/{package-name}/*.md` if it exists
|
|
17
18
|
|
|
18
19
|
### Phase 3: Synthesis & Writing
|
|
19
|
-
|
|
20
|
+
7. Create `README.md` with this structure:
|
|
20
21
|
- **Npm badge**: example:
|
|
21
22
|
```
|
|
22
23
|
[](https://www.npmjs.com/package/this-package-name)
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-task-from-template
|
|
3
|
+
description: create an executable task by instantiating a task template with project-specific values
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Create Task from Template
|
|
7
|
+
|
|
8
|
+
This skill creates an executable task by instantiating a reusable task template. Templates live in `.agents/task-templates/` and contain placeholder variables that get replaced with actual values.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
### Step 1: Identify the Template
|
|
13
|
+
|
|
14
|
+
1. Determine which template to use based on the task type
|
|
15
|
+
2. Available templates are in `.agents/task-templates/`
|
|
16
|
+
3. Load the template's `template.md` to understand required variables
|
|
17
|
+
|
|
18
|
+
**Available Templates:**
|
|
19
|
+
|
|
20
|
+
| Template | Purpose |
|
|
21
|
+
|----------|---------|
|
|
22
|
+
| `maintain-agent-docs` | Create/update agent navigation documentation (AGENTS.md, codebase-summary.md, project-nav.md, etc.) |
|
|
23
|
+
|
|
24
|
+
### Step 2: Load the Template
|
|
25
|
+
|
|
26
|
+
1. Read `template.md` to get metadata and required variables
|
|
27
|
+
2. Read all template files (`goals.md`, `plan.md`, `state.md`)
|
|
28
|
+
3. Identify all placeholder variables (format: `{variable-name}`)
|
|
29
|
+
|
|
30
|
+
### Step 3: Gather Variable Values
|
|
31
|
+
|
|
32
|
+
For each required variable:
|
|
33
|
+
- **Infer from context** if possible (e.g., project name from AGENTS.md)
|
|
34
|
+
- **Ask the user** if the value cannot be determined
|
|
35
|
+
- Use these common sources:
|
|
36
|
+
- `AGENTS.md` — project name, repos, conventions
|
|
37
|
+
- `.agents/documentation/project-nav.md` — repo paths, architecture
|
|
38
|
+
- User's task description — specific scope and goals
|
|
39
|
+
|
|
40
|
+
### Step 4: Instantiate the Task
|
|
41
|
+
|
|
42
|
+
1. Create directory: `.agents/tasks/[task-name]/`
|
|
43
|
+
2. For each template file:
|
|
44
|
+
- Read the template content
|
|
45
|
+
- Replace all `{variable-name}` placeholders with actual values
|
|
46
|
+
- Write the instantiated file to the task directory
|
|
47
|
+
3. Generate a unique task name (e.g., `maintain-agent-docs-[date]` or user-specified name)
|
|
48
|
+
|
|
49
|
+
### Step 5: Verify and Report
|
|
50
|
+
|
|
51
|
+
1. Verify all placeholders were replaced (no remaining `{...}` patterns)
|
|
52
|
+
2. Check that the instantiated task is coherent
|
|
53
|
+
3. Report to user with summary
|
|
54
|
+
|
|
55
|
+
## Output Format
|
|
56
|
+
|
|
57
|
+
After instantiation:
|
|
58
|
+
|
|
59
|
+
```
|
|
60
|
+
Task Created from Template: [template-name]
|
|
61
|
+
Task Name: [generated-task-name]
|
|
62
|
+
Location: .agents/tasks/[task-name]/
|
|
63
|
+
|
|
64
|
+
Variables Used:
|
|
65
|
+
- {variable1}: value1
|
|
66
|
+
- {variable2}: value2
|
|
67
|
+
|
|
68
|
+
Files Created:
|
|
69
|
+
- goals.md
|
|
70
|
+
- plan.md
|
|
71
|
+
- state.md
|
|
72
|
+
- [additional files if template includes them]
|
|
73
|
+
|
|
74
|
+
Next Step: Review the task and execute with `execute-task-solo` or `execute-task-team`
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Placeholder Conventions
|
|
78
|
+
|
|
79
|
+
- All placeholders use `{variable-name}` format
|
|
80
|
+
- Common variables:
|
|
81
|
+
- `{project-name}` — Project name
|
|
82
|
+
- `{repo-path}` — Path to repository
|
|
83
|
+
- `{module-name}` — Module/package name
|
|
84
|
+
- `{task-scope}` — Specific scope of this task instance
|
|
85
|
+
- `{changed-files}` — Files that changed (for update tasks)
|
|
86
|
+
- `{target-path}` — Where output should be placed
|
|
87
|
+
|
|
88
|
+
## Example: Instantiating maintain-agent-docs Template
|
|
89
|
+
|
|
90
|
+
**User Request:** "Update documentation for agent-smith-plugins after adding a new plugin"
|
|
91
|
+
|
|
92
|
+
**Process:**
|
|
93
|
+
1. Load `maintain-agent-docs` template
|
|
94
|
+
2. Read `template.md` → requires: `{project-name}`, `{repo-path}`, `{changed-files}`
|
|
95
|
+
3. Infer values:
|
|
96
|
+
- `{project-name}` = "Agent Smith" (from AGENTS.md)
|
|
97
|
+
- `{repo-path}` = "/workspace/agent-smith-plugins/"
|
|
98
|
+
- `{changed-files}` = User specifies: "new video plugin added"
|
|
99
|
+
4. Instantiate task at `.agents/tasks/maintain-agent-docs-video-plugin/`
|
|
100
|
+
5. All placeholders replaced, task is ready for execution
|
|
101
|
+
|
|
102
|
+
## Rules
|
|
103
|
+
|
|
104
|
+
- **Never skip variable gathering** — All required variables must have values
|
|
105
|
+
- **Preserve template structure** — The instantiated task follows the same file layout
|
|
106
|
+
- **Task name uniqueness** — Each instantiation gets a unique name
|
|
107
|
+
- **Template is read-only** — Never modify the original template files
|
|
108
|
+
- **Verify completeness** — Check no placeholders remain after instantiation
|
|
@@ -1,83 +1,54 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: document-package
|
|
3
|
-
description: use when asked to create or update package
|
|
3
|
+
description: use when asked to create or update documentation for a package or module in the project docsite
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
This skill describes the workflow to document a package for the
|
|
6
|
+
This skill describes the workflow to document a package or module for the project's documentation site.
|
|
7
7
|
|
|
8
8
|
## Workflow
|
|
9
9
|
|
|
10
|
-
Execute
|
|
10
|
+
Execute these steps in order:
|
|
11
11
|
|
|
12
12
|
1. **Locate the package** — Read `.agents/documentation/codebase-summary.md` to find the package path
|
|
13
13
|
|
|
14
|
-
2. **Read codebase summary** — Read `[package-path]
|
|
14
|
+
2. **Read codebase summary** — Read `[package-path]/.agents/documentation/codebase-summary.md`. This provides a quick overview of tools, agents, dependencies, and architecture.
|
|
15
15
|
|
|
16
|
-
3. **Read source code** — Inspect `src
|
|
16
|
+
3. **Read source code** — Inspect `src/` directories to identify key exports, capabilities, and usage patterns.
|
|
17
17
|
|
|
18
|
-
4. **Find next number** — List existing docs in
|
|
18
|
+
4. **Find next number** — List existing docs in the documentation directory. Use the next available number (e.g., if 1-8 exist, use 9).
|
|
19
19
|
|
|
20
|
-
5. **Write the doc** at
|
|
20
|
+
5. **Write the doc** at `<docsite-path>/<category>/<N>.<name>.md` using this structure:
|
|
21
21
|
|
|
22
22
|
```markdown
|
|
23
23
|
# <PackageName>
|
|
24
24
|
|
|
25
|
-

|
|
26
|
-
|
|
27
25
|
One-line description of what the package does.
|
|
28
26
|
|
|
29
27
|
## Install
|
|
30
28
|
|
|
31
|
-
|
|
32
|
-
npm i -g @agent-smith/feat-<name>
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Add the package to your `config.yml` file and run the `conf` command:
|
|
36
|
-
|
|
37
|
-
```yml
|
|
38
|
-
plugins:
|
|
39
|
-
- "@agent-smith/feat-<name>"
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
lm conf
|
|
44
|
-
```
|
|
29
|
+
<Installation instructions appropriate for the project's ecosystem>
|
|
45
30
|
|
|
46
|
-
##
|
|
31
|
+
## Features and Capabilities
|
|
47
32
|
|
|
48
33
|
### <category>
|
|
49
34
|
|
|
50
|
-
Available
|
|
51
|
-
|
|
52
|
-
- <kbd>tool-name</kbd> one-line description of what it does (include container image if applicable)
|
|
53
|
-
|
|
54
|
-
## Agents
|
|
35
|
+
Available features:
|
|
55
36
|
|
|
56
|
-
|
|
37
|
+
- <kbd>feature-name</kbd> one-line description of what it does
|
|
57
38
|
|
|
58
|
-
|
|
59
|
-
- `tool-a` — purpose
|
|
60
|
-
- `tool-b` — purpose
|
|
39
|
+
## Usage
|
|
61
40
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
```yaml
|
|
65
|
-
description: A brief description
|
|
66
|
-
model: qwen4b
|
|
67
|
-
toolsList:
|
|
68
|
-
- agent-name # this tool is a subagent
|
|
69
|
-
```
|
|
41
|
+
<Example code showing typical usage>
|
|
70
42
|
|
|
71
43
|
## Links
|
|
72
44
|
|
|
73
|
-
Add
|
|
74
|
-
|
|
75
|
-
<a href="javascript:openLink('/plugins/overview')">Back: Overview</a>
|
|
45
|
+
Add navigation links to related documentation.
|
|
76
46
|
```
|
|
77
47
|
|
|
78
48
|
## Rules
|
|
79
49
|
|
|
80
|
-
- Keep it short and information-dense — match the style of
|
|
81
|
-
- Use `<kbd>
|
|
82
|
-
- Use backticks `for
|
|
83
|
-
- End with navigation
|
|
50
|
+
- **Keep it short and information-dense** — match the style of existing docs
|
|
51
|
+
- Use `<kbd>feature-name</kbd>` for all tools/features
|
|
52
|
+
- Use backticks `` ` `` for feature names in prose
|
|
53
|
+
- End with navigation links to overview or related packages
|
|
54
|
+
- **Language-agnostic**: Adapt installation, examples, and conventions to the project's ecosystem
|
|
@@ -5,6 +5,8 @@ description: use this to execute a team task (coordinator delegates phases to ex
|
|
|
5
5
|
|
|
6
6
|
# Coordinator Agent Instructions (Task Execution)
|
|
7
7
|
|
|
8
|
+
Use the `load-task` tool to load the task.
|
|
9
|
+
|
|
8
10
|
## Your Role
|
|
9
11
|
You are the **Coordinator Agent**. Delegate phases to executor agents.
|
|
10
12
|
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: smart-explore
|
|
3
|
+
description: use when exploring a project directory to discover structure while excluding noise (dependencies, build artifacts, version control)
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Smart directory exploration for any project type. Discovers repos, packages, entry points, and key files while excluding noise that bloats context.
|
|
7
|
+
|
|
8
|
+
## Exclusions
|
|
9
|
+
|
|
10
|
+
### Always exclude
|
|
11
|
+
`.git`, `node_modules`, `vendor`, `.venv`, `venv`, `dist`, `build`, `target`, `__pycache__`, `.cache`, `coverage`, `.idea`, `.vscode`, `.DS_Store`
|
|
12
|
+
|
|
13
|
+
### Add when detected
|
|
14
|
+
- Python: `.tox`, `.nox`, `.pytest_cache`, `.mypy_cache`
|
|
15
|
+
- Rust: `.cargo/`
|
|
16
|
+
- Java: `.gradle/`, `.mvn/`
|
|
17
|
+
- .NET: `bin/`, `obj/`
|
|
18
|
+
- Ruby: `.bundle/`, `tmp/`
|
|
19
|
+
- PHP: `.composer/`
|
|
20
|
+
|
|
21
|
+
## Workflow
|
|
22
|
+
|
|
23
|
+
### 1. Read `.gitignore` (if exists)
|
|
24
|
+
Add any additional exclusion patterns.
|
|
25
|
+
|
|
26
|
+
### 2. Detect project type
|
|
27
|
+
Check for manifest files: `package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`, `Gemfile`, `pom.xml`, `composer.json`, `*.csproj`, `CMakeLists.txt`
|
|
28
|
+
|
|
29
|
+
### 3. Walk directory tree
|
|
30
|
+
Use `find` with exclusions. Start shallow (`-maxdepth 2`), go deeper only when needed.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
find /workspace/<project> -maxdepth 2 -type d -not -path '*/node_modules/*' -not -path '*/.git/*' | head -50
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 4. Find packages
|
|
37
|
+
Locate manifest files to identify all packages/repos.
|
|
38
|
+
|
|
39
|
+
### 5. Read manifests
|
|
40
|
+
For each package discovered, read its manifest to understand dependencies and structure.
|
|
41
|
+
|
|
42
|
+
## Rules
|
|
43
|
+
|
|
44
|
+
- Use `-maxdepth` to control depth; start shallow
|
|
45
|
+
- Limit results with `head` to avoid overwhelming context
|
|
46
|
+
- Adapt exclusions based on detected language/ecosystem
|
|
47
|
+
- Skip binary files and large artifacts
|