@agent-smith/feat-agents 0.0.1
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 +267 -0
- package/dist/agents/agent-smith-assistant.yml +31 -0
- package/dist/agents/agent-smith-code.yml +33 -0
- package/dist/agents/agent-smith-colab.yml +38 -0
- package/dist/agents/agent-smith-doc-colab.yml +55 -0
- package/dist/agents/agent-smith-doc.yml +52 -0
- package/dist/agents/agent-smith-help-assistant.yml +46 -0
- package/dist/agents/agent-smith-help-light.yml +44 -0
- package/dist/agents/agent-smith-help.yml +43 -0
- package/dist/agents/agent-smith-light.yml +19 -0
- package/dist/agents/agent-smith-project.yml +43 -0
- package/dist/agents/agent-smith-search.yml +40 -0
- package/dist/agents/agent-smith-sql.yml +31 -0
- package/dist/agents/agent-smith-state.yml +40 -0
- package/dist/agents/agent-smith.yml +42 -0
- package/dist/agents/collaborator.yml +16 -0
- package/dist/agents/infer.yml +12 -0
- package/dist/fragments/ctx-helper-files.md +6 -0
- package/dist/fragments/workspace.md +6 -0
- package/dist/skills/create-project-docs/SKILL.md +124 -0
- package/dist/skills/create-readme/SKILL.md +103 -0
- package/dist/skills/create-task/SKILL.md +55 -0
- package/dist/skills/create-task-solo/SKILL.md +146 -0
- package/dist/skills/create-task-team/SKILL.md +119 -0
- package/dist/skills/document-package/SKILL.md +83 -0
- package/dist/skills/execute-task-phase/SKILL.md +25 -0
- package/dist/skills/execute-task-solo/SKILL.md +64 -0
- package/dist/skills/execute-task-team/SKILL.md +49 -0
- package/dist/skills/task-mode/SKILL.md +99 -0
- package/dist/skills/update-codebase-summary/SKILL.md +44 -0
- package/dist/skills/update-doc-map/SKILL.md +8 -0
- package/dist/skills/update-doc-map/scripts/generate-doc-map.mjs +197 -0
- package/dist/skills/update-project-nav/SKILL.md +97 -0
- package/dist/skills/use-tasks/SKILL.md +103 -0
- package/dist/workflows/agent-smith-config-info.yml +9 -0
- package/dist/workflows/agent-smith-db.yml +9 -0
- package/dist/workflows/q.yml +3 -0
- package/dist/workflows/vision.yml +3 -0
- package/package.json +15 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
tool:
|
|
2
|
+
name: agent-smith-search
|
|
3
|
+
description: run web search or open web pages
|
|
4
|
+
arguments:
|
|
5
|
+
prompt:
|
|
6
|
+
description: the web search to perform or question about a web page
|
|
7
|
+
required: true
|
|
8
|
+
description: An agent to run web search or open web pages
|
|
9
|
+
category: "agent-smith"
|
|
10
|
+
prompt: |-
|
|
11
|
+
{prompt}
|
|
12
|
+
template:
|
|
13
|
+
system: |-
|
|
14
|
+
You are a web search agent for the Agent Smith project, a toolkit to run AI agents.
|
|
15
|
+
|
|
16
|
+
{file:../fragments/workspace.md}
|
|
17
|
+
|
|
18
|
+
Project's context helper files:
|
|
19
|
+
|
|
20
|
+
- `AGENTS.md`: general high level context map of the project to navigate
|
|
21
|
+
model: qwen35b
|
|
22
|
+
backend: llamaccp
|
|
23
|
+
inferParams:
|
|
24
|
+
min_p: 0
|
|
25
|
+
top_k: 20
|
|
26
|
+
top_p: 0.85
|
|
27
|
+
temperature: 0.6
|
|
28
|
+
repetition_penalty: 1
|
|
29
|
+
chat_template_kwargs:
|
|
30
|
+
enable_thinking: true
|
|
31
|
+
preserve_thinking: true
|
|
32
|
+
variables:
|
|
33
|
+
required:
|
|
34
|
+
workspace:
|
|
35
|
+
description: The local directory path where to operate
|
|
36
|
+
toolsList:
|
|
37
|
+
- shell
|
|
38
|
+
- python
|
|
39
|
+
- ddsearch
|
|
40
|
+
- read-webpage
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
tool:
|
|
2
|
+
description: retrieve data from the Agent Smith config database that references agents, actions, workflows and other features
|
|
3
|
+
arguments:
|
|
4
|
+
prompt:
|
|
5
|
+
description: the question about the config or data to retrieve
|
|
6
|
+
description: Create an sql query
|
|
7
|
+
category: internal/doc
|
|
8
|
+
prompt: |-
|
|
9
|
+
Schema:
|
|
10
|
+
{schema}
|
|
11
|
+
|
|
12
|
+
Question: {prompt}
|
|
13
|
+
|
|
14
|
+
Important: output ONLY raw SQL code. Example: SELECT * FROM tablename
|
|
15
|
+
model: text2sql
|
|
16
|
+
template:
|
|
17
|
+
system: |-
|
|
18
|
+
You are given a database schema and a natural language question. Generate the SQL query that answers the question.
|
|
19
|
+
|
|
20
|
+
- Use only tables and columns from the provided schema
|
|
21
|
+
- Use uppercase SQL keywords (SELECT, FROM, WHERE, etc.)
|
|
22
|
+
- Use SQLite-compatible syntax
|
|
23
|
+
assistant: "```sql\n"
|
|
24
|
+
stop:
|
|
25
|
+
- "```"
|
|
26
|
+
inferParams:
|
|
27
|
+
temperature: 0
|
|
28
|
+
variables:
|
|
29
|
+
required:
|
|
30
|
+
schema:
|
|
31
|
+
description: the database sql schema
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
description: A project state mananagement agent
|
|
2
|
+
category: internal
|
|
3
|
+
prompt: |-
|
|
4
|
+
Check if the project has all the necessary context and documentation files:
|
|
5
|
+
|
|
6
|
+
- `AGENTS.md`: general high level context map of the project
|
|
7
|
+
- `.agents/documentation/codebase-summary.md`: high level codebase summary
|
|
8
|
+
- `.agents/documentation/project-overview.md`: a high level project overview
|
|
9
|
+
|
|
10
|
+
Output only a report in this format:
|
|
11
|
+
|
|
12
|
+
```yaml
|
|
13
|
+
- `AGENTS.md`: ok (or todo)
|
|
14
|
+
- `.agents/documentation/codebase-summary.md`: ok (or todo)
|
|
15
|
+
- `.agents/documentation/project-overview.md`: ok (or todo)
|
|
16
|
+
```
|
|
17
|
+
template:
|
|
18
|
+
system: |-
|
|
19
|
+
You are Agent Smith, an AI project manager agent.
|
|
20
|
+
|
|
21
|
+
{file:../fragments/workspace.md}
|
|
22
|
+
model: qwen4b
|
|
23
|
+
inferParams:
|
|
24
|
+
min_p: 0
|
|
25
|
+
top_k: 20
|
|
26
|
+
top_p: 0.95
|
|
27
|
+
temperature: 0.6
|
|
28
|
+
repetition_penalty: 1
|
|
29
|
+
chat_template_kwargs:
|
|
30
|
+
enable_thinking: true
|
|
31
|
+
preserve_thinking: true
|
|
32
|
+
variables:
|
|
33
|
+
required:
|
|
34
|
+
workspace:
|
|
35
|
+
description: The local directory path where to operate
|
|
36
|
+
toolsList:
|
|
37
|
+
- readfile
|
|
38
|
+
- shell
|
|
39
|
+
- python
|
|
40
|
+
- load-skill
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
description: An agent to manage Agent Smith's documentation
|
|
2
|
+
category: "agent-smith"
|
|
3
|
+
prompt: |-
|
|
4
|
+
{prompt}
|
|
5
|
+
template:
|
|
6
|
+
system: |-
|
|
7
|
+
You are Agent Smith, an AI coordinator agent. Your job is to organise the workflow of other agents. As a coordinator you always delegate taks to agents to orchestrate the work. Your job is to coordinate the team of agents. Available agents:
|
|
8
|
+
|
|
9
|
+
- `agent-smith-assistant`: a fork of yourself, the default agent. Run it by default to accomplish any task.
|
|
10
|
+
- `agent-smith-search`: a web search and web page reader agent. Use to search information or for questions about some web pages.
|
|
11
|
+
|
|
12
|
+
{file:../fragments/workspace.md}
|
|
13
|
+
{file:../fragments/ctx-helper-files.md}
|
|
14
|
+
|
|
15
|
+
Your workflow to answer a user request:
|
|
16
|
+
|
|
17
|
+
- Analyze the user request
|
|
18
|
+
- Decompose the task to subtasks if necessary and plan the work to do
|
|
19
|
+
- Call agent(s) one after the other to accomplish the subtasks, use `agent-smith-assistant` by default if no specialized agent matches. Only call one agent at the time.
|
|
20
|
+
model: qwen35b
|
|
21
|
+
inferParams:
|
|
22
|
+
min_p: 0
|
|
23
|
+
top_k: 20
|
|
24
|
+
top_p: 0.85
|
|
25
|
+
temperature: 0.6
|
|
26
|
+
repetition_penalty: 1
|
|
27
|
+
presence_penalty: 1.5
|
|
28
|
+
chat_template_kwargs:
|
|
29
|
+
enable_thinking: true
|
|
30
|
+
preserve_thinking: true
|
|
31
|
+
variables:
|
|
32
|
+
required:
|
|
33
|
+
workspace:
|
|
34
|
+
description: The local directory path where to operate
|
|
35
|
+
toolsList:
|
|
36
|
+
- readfile
|
|
37
|
+
- edit-search-replace
|
|
38
|
+
- shell
|
|
39
|
+
- python
|
|
40
|
+
- run-agent
|
|
41
|
+
- load-skill
|
|
42
|
+
- notify-user
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
description: A collaborator agent
|
|
2
|
+
category: internal/experimental
|
|
3
|
+
type: worker
|
|
4
|
+
prompt: |-
|
|
5
|
+
You are on collaborator mode. Your role is: {role}. Main agent request:
|
|
6
|
+
|
|
7
|
+
{prompt}
|
|
8
|
+
model: qwen35b
|
|
9
|
+
variables:
|
|
10
|
+
required:
|
|
11
|
+
workspace:
|
|
12
|
+
description: The local directory path where to operate
|
|
13
|
+
role:
|
|
14
|
+
description: The role of the collaborator
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
Project's context helper files:
|
|
2
|
+
|
|
3
|
+
- `AGENTS.md`: general high level context map of the project. Read this first.
|
|
4
|
+
- `.agents/documentation/project-nav.md`: a map of the project repositories and overview of the project
|
|
5
|
+
|
|
6
|
+
To navigate the code always read local directories `.agents/documentation/codebase-summary.md` files
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
You are operating on a Linux filesystem in a workspace located at /workspace. The current directory is /. If a user refers to a path prepend /workspace to it for shell commands: example: ls /workspace/src if user refers to a `src` directory.
|
|
2
|
+
|
|
3
|
+
Directories for AI agents:
|
|
4
|
+
|
|
5
|
+
- `.agents/documentation`: where the documentation to navigate the codebase is
|
|
6
|
+
- `.agents/tasks`: where we store tasks for AI agents. If the user refers to a task check this directory
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-project-docs
|
|
3
|
+
description: use when asked to create or update helper documentation so AI agents can navigate a project
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Create or update the documentation files that help AI agents navigate a codebase. Works for single-repo or multi-repo projects.
|
|
7
|
+
|
|
8
|
+
## Files to Create/Update
|
|
9
|
+
|
|
10
|
+
| File | Scope | Purpose |
|
|
11
|
+
|------|-------|---------|
|
|
12
|
+
| `AGENTS.md` | Project root | Index with reading order + links to other docs |
|
|
13
|
+
| `.agents/documentation/codebase-summary.md` | Every repo/module | Standardized technical summary (7 sections) |
|
|
14
|
+
| `.agents/documentation/project-nav.md` | Project root only | Comprehensive navigation map |
|
|
15
|
+
|
|
16
|
+
> **Single-repo projects**: All 3 files live at the project root.
|
|
17
|
+
> **Multi-repo projects**: `AGENTS.md` and `project-nav.md` at workspace root; each repo gets its own `AGENTS.md` and `codebase-summary.md`.
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
Execute steps in order:
|
|
22
|
+
|
|
23
|
+
### 1. Explore the Project
|
|
24
|
+
|
|
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.
|
|
26
|
+
|
|
27
|
+
### 2. Create AGENTS.md (Project Root)
|
|
28
|
+
|
|
29
|
+
```markdown
|
|
30
|
+
# <Project Name>
|
|
31
|
+
|
|
32
|
+
## Reading Order for AI Agents
|
|
33
|
+
|
|
34
|
+
1. **Start here** → This file is your index
|
|
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`
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
This is a <language> project for <purpose>. It contains these repositories:
|
|
42
|
+
|
|
43
|
+
- `<repo-name>` — <one-line description>
|
|
44
|
+
- ...
|
|
45
|
+
|
|
46
|
+
Documentation:
|
|
47
|
+
|
|
48
|
+
- `.agents/documentation/codebase-summary.md`: top-level codebase summary
|
|
49
|
+
- `.agents/documentation/project-nav.md`: navigation map
|
|
50
|
+
- `<repo>/.agents/documentation/codebase-summary.md`: per-repo summaries
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 3. Create codebase-summary.md (Every Repo/Module)
|
|
54
|
+
|
|
55
|
+
Use exactly these 7 sections in this order:
|
|
56
|
+
|
|
57
|
+
```markdown
|
|
58
|
+
# <module-name>
|
|
59
|
+
|
|
60
|
+
## Summary
|
|
61
|
+
One sentence: what the module does.
|
|
62
|
+
|
|
63
|
+
## Dependencies
|
|
64
|
+
- `<internal-dep>` — what it provides
|
|
65
|
+
- External: `<library>` (<purpose>)
|
|
66
|
+
|
|
67
|
+
## Used By
|
|
68
|
+
- `<consumer>` — why it uses this module
|
|
69
|
+
|
|
70
|
+
## Entry Point
|
|
71
|
+
- `<path>` — one-line description
|
|
72
|
+
|
|
73
|
+
## Key Files
|
|
74
|
+
| File | Purpose |
|
|
75
|
+
|------|---------|
|
|
76
|
+
| `<path>` | One-line: what the file does |
|
|
77
|
+
|
|
78
|
+
## Architecture
|
|
79
|
+
- 2–4 bullets on design patterns and data flow.
|
|
80
|
+
|
|
81
|
+
## Related
|
|
82
|
+
- See `<module>` — how they work together
|
|
83
|
+
|
|
84
|
+
## Documentation
|
|
85
|
+
| Resource | Path |
|
|
86
|
+
|----------|------|
|
|
87
|
+
| Full docsite | `<path>` |
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
**Rules**: Information-dense, short. No project description (that's in project-nav.md). No architecture patterns duplicated from project-nav.md.
|
|
91
|
+
|
|
92
|
+
### 4. Create project-nav.md (Project Root Only)
|
|
93
|
+
|
|
94
|
+
Comprehensive map with these sections:
|
|
95
|
+
|
|
96
|
+
1. **Project Overview** — What it does, repos/modules table, core capabilities
|
|
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.
|
|
108
|
+
|
|
109
|
+
Add header note: `> **Primary reference** — Comprehensive navigation map for the project.`
|
|
110
|
+
|
|
111
|
+
### 5. Cross-Reference and Verify
|
|
112
|
+
|
|
113
|
+
- `AGENTS.md` → links to project-nav.md and codebase-summary.md
|
|
114
|
+
- `codebase-summary.md` → Related section points to project-nav.md for overview
|
|
115
|
+
- `project-nav.md` → no external cross-references needed (it's the primary source)
|
|
116
|
+
- No duplicated content across files: project description, architecture patterns, quick-reference tables, and code snippets live ONLY in project-nav.md
|
|
117
|
+
|
|
118
|
+
## Rules
|
|
119
|
+
|
|
120
|
+
- **No redundancy**: Each piece of information lives in exactly one file
|
|
121
|
+
- **codebase-summary.md preserves format**: The 7-section structure is standardized — do not change it
|
|
122
|
+
- **Information-dense**: Keep files short. Use tables, bullets, one-line descriptions
|
|
123
|
+
- **project-nav.md is canonical**: Single source of truth for project overview, architecture, snippets, and quick references
|
|
124
|
+
- **Language-agnostic**: Adapt examples and conventions to the project's language and ecosystem
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-readme
|
|
3
|
+
description: use this to create comprehensive README file for a given package or plugin or repository
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Workflow: README Creation
|
|
7
|
+
|
|
8
|
+
### Phase 1: Discovery
|
|
9
|
+
1. Read `/workspace/AGENTS.md` and `/workspace/.agents/documentation/project-nav.md` to understand project structure
|
|
10
|
+
2. Read `/workspace/agent-smith/.agents/documentation/codebase-summary.md` and `/workspace/agent-smith/.agents/documentation/dpcumentation-map.md`
|
|
11
|
+
3. Locate target in the codebase summary (note its position, dependencies, and purpose)
|
|
12
|
+
|
|
13
|
+
### Phase 2: Deep Dive
|
|
14
|
+
3. Navigate to directory: `/workspace/agent-smith/packages/{package-name}/` for a package, adapt the path
|
|
15
|
+
4. Read `.agents/documentation/codebase-summary.md` for architecture, key files, and usage patterns
|
|
16
|
+
5. Read documentation from `/workspace/agent-smith/docsite/public/doc/libraries/{package-name}/*.md` (get_started, usage, api)
|
|
17
|
+
|
|
18
|
+
### Phase 3: Synthesis & Writing
|
|
19
|
+
6. Create `README.md` with this structure:
|
|
20
|
+
- **Npm badge**: example:
|
|
21
|
+
```
|
|
22
|
+
[](https://www.npmjs.com/package/this-package-name)
|
|
23
|
+
```
|
|
24
|
+
- **Title & Tagline**: Package name + one-sentence description. Mention that this package is part of the Agent Smith toolkit (repository: https://github.com/lynxai-team/agent-smith)
|
|
25
|
+
- **Features**: Bullet list of key capabilities (use emojis for visual hierarchy)
|
|
26
|
+
- **Documentation**: REQUIRED section with specific structure (see below)
|
|
27
|
+
- **Installation**: npm/yarn command in code block
|
|
28
|
+
- **Quick Start**: Minimal working example showing creation, init, and basic operations
|
|
29
|
+
- **Usage**: Detailed patterns with code examples (creation, initialization, verbose mode, reading/writing, error handling)
|
|
30
|
+
- **Complete Example**: Full working async function demonstrating all operations
|
|
31
|
+
- **API Reference**: Factory function signature + parameters table + interface + method summary table
|
|
32
|
+
- **Important Notes**: Browser-only warnings, limitations, related packages
|
|
33
|
+
- **Documentation Links**: References to full docsite
|
|
34
|
+
- **License**: MIT/appropriate license
|
|
35
|
+
|
|
36
|
+
### Documentation Section Structure (REQUIRED)
|
|
37
|
+
|
|
38
|
+
Every README must include a **Documentation** section with this exact structure: two subsections — "For AI Agents" and "For Humans" — providing appropriate links for each audience.
|
|
39
|
+
|
|
40
|
+
#### Required Format
|
|
41
|
+
|
|
42
|
+
```markdown
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
### For AI Agents
|
|
46
|
+
- [Codebase Summary](.agents/documentation/codebase-summary.md) — Architecture, key files, and patterns for the {package-name} package
|
|
47
|
+
- [Doc1](https://raw.githubusercontent.com/lynxai-team/agent-smith/refs/heads/main/docsite/public/doc/libraries/{package-name}/1.get_started.md) — Description
|
|
48
|
+
- [Doc2](https://raw.githubusercontent.com/lynxai-team/agent-smith/refs/heads/main/docsite/public/doc/libraries/{package-name}/2.topic.md) — Description
|
|
49
|
+
|
|
50
|
+
### For Humans
|
|
51
|
+
- [Doc1](https://lynxai-team.github.io/agent-smith/libraries/{package-name}/) — Description
|
|
52
|
+
- [Doc2](https://lynxai-team.github.io/agent-smith/libraries/{package-name}/topic) — Description
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
#### Rules
|
|
56
|
+
|
|
57
|
+
1. **For AI Agents subsection**:
|
|
58
|
+
- Always start with a link to `.agents/documentation/codebase-summary.md` (relative path)
|
|
59
|
+
- List all relevant documentation files from `/workspace/agent-smith/docsite/public/doc/libraries/{package-name}/`
|
|
60
|
+
- Use raw GitHub URLs: `https://raw.githubusercontent.com/lynxai-team/agent-smith/refs/heads/main/docsite/public/doc/libraries/{package-name}/{filename}.md`
|
|
61
|
+
- Include a brief description after each link (after `—`)
|
|
62
|
+
|
|
63
|
+
2. **For Humans subsection**:
|
|
64
|
+
- Use the docsite URL: `https://lynxai-team.github.io/agent-smith/libraries/{package-name}/`
|
|
65
|
+
- Convert paths: replace `docsite/public/doc/libraries/{package-name}/` with `libraries/{package-name}/`
|
|
66
|
+
- Remove file numbering prefixes (e.g., `1.get_started.md` → `/`)
|
|
67
|
+
- Include a brief description after each link (after `—`)
|
|
68
|
+
|
|
69
|
+
#### Example from the types package README
|
|
70
|
+
|
|
71
|
+
```markdown
|
|
72
|
+
## Documentation
|
|
73
|
+
|
|
74
|
+
### For AI Agents
|
|
75
|
+
- [Codebase Summary](.agents/documentation/codebase-summary.md) — Architecture, key files, and patterns for the Agent Smith libraries
|
|
76
|
+
- [Get Started](https://raw.githubusercontent.com/lynxai-team/agent-smith/refs/heads/main/docsite/public/doc/libraries/types/1.get_started.md) — Overview and installation
|
|
77
|
+
- [Interfaces](https://raw.githubusercontent.com/lynxai-team/agent-smith/refs/heads/main/docsite/public/doc/libraries/types/2.interfaces.md) — Complete API reference of all exported types
|
|
78
|
+
|
|
79
|
+
### For Humans
|
|
80
|
+
- [Get Started](https://lynxai-team.github.io/agent-smith/libraries/types/) — Overview and usage guide
|
|
81
|
+
- [Interfaces](https://lynxai-team.github.io/agent-smith/libraries/types/interfaces) — Full interface reference with tables
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Key Principles
|
|
85
|
+
- **Information Density**: Every section must convey unique value; avoid repetition between Quick Start and Usage
|
|
86
|
+
- **Code Examples**: All examples must be complete, runnable TypeScript with proper async/await
|
|
87
|
+
- **Type Safety**: Show generic type parameters explicitly (e.g., `get<string>()`)
|
|
88
|
+
- **Error Handling**: Document error cases explicitly with try/catch examples
|
|
89
|
+
- **Browser vs Node**: Clearly state environment constraints early in the README
|
|
90
|
+
- **Visual Hierarchy**: Use emojis for feature bullets, clear section headers, and tables for API reference
|
|
91
|
+
|
|
92
|
+
### Output Validation
|
|
93
|
+
Before finalizing, verify:
|
|
94
|
+
- [ ] All code blocks are syntactically valid TypeScript
|
|
95
|
+
- [ ] API signatures match actual implementation (check source files if needed)
|
|
96
|
+
- [ ] Installation command uses correct package name (`@agent-smith/{package-name}`)
|
|
97
|
+
- [ ] Documentation section follows the required structure with "For AI Agents" and "For Humans" subsections
|
|
98
|
+
- [ ] Documentation links follow consistent pattern (raw GitHub URLs for AI agents, docsite URLs for humans)
|
|
99
|
+
- [ ] No internal paths or implementation details leak into public documentation
|
|
100
|
+
|
|
101
|
+
Documentation links base url: https://lynxai-team.github.io/agent-smith/
|
|
102
|
+
|
|
103
|
+
Notify the user when the task is completed
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-task
|
|
3
|
+
description: entry point for creating tasks - analyzes request, chooses execution mode, creates task
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Create Task (Entry Point)
|
|
7
|
+
|
|
8
|
+
This is the entry point skill for creating new tasks. It orchestrates the full workflow: analyze → decide mode → create task.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
### Step 1: Analyze Request
|
|
13
|
+
1. Read and understand the user's task request
|
|
14
|
+
2. Identify scope, complexity, and requirements
|
|
15
|
+
3. Note any special constraints or dependencies
|
|
16
|
+
|
|
17
|
+
### Step 2: Choose Execution Mode
|
|
18
|
+
1. Load the `task-mode` skill
|
|
19
|
+
2. Evaluate the task against the decision checklist
|
|
20
|
+
3. Determine whether to use `create-task-solo` (single agent) or `create-task-team` (multi-agent)
|
|
21
|
+
4. Report your decision with reasoning
|
|
22
|
+
|
|
23
|
+
### Step 3: Create Task
|
|
24
|
+
1. Based on the mode decision, load either `create-task-solo` or `create-task-team` skill
|
|
25
|
+
2. Execute that skill to create the task files
|
|
26
|
+
3. Show the created structure to the user
|
|
27
|
+
|
|
28
|
+
## Output Format
|
|
29
|
+
|
|
30
|
+
After analysis and mode selection:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
Task Analysis: [Brief summary of what needs to be done]
|
|
34
|
+
Mode Decision: [create-task-solo | create-task-team]
|
|
35
|
+
Reasoning: [Why this mode was chosen]
|
|
36
|
+
Next Step: Creating task using [create-task-solo | create-task-team] skill...
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
After task creation:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
Task Created: [.agents/tasks/task-name/]
|
|
43
|
+
Files Created:
|
|
44
|
+
- goals.md
|
|
45
|
+
- plan.md
|
|
46
|
+
- state.md
|
|
47
|
+
- [additional files based on mode]
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Important Notes
|
|
51
|
+
|
|
52
|
+
- Always use `task-mode` skill before creating a task
|
|
53
|
+
- Never skip the mode selection step
|
|
54
|
+
- Report decision to user before proceeding
|
|
55
|
+
- The `create-task-solo` and `create-task-team` skills handle their own confirmation workflows
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-task-solo
|
|
3
|
+
description: use this to create a new task with proper structure for single-agent (solo) execution
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Create Task Instructions (Single Agent)
|
|
7
|
+
|
|
8
|
+
## Task Directory Structure
|
|
9
|
+
|
|
10
|
+
Tasks are located in `.agents/tasks/[task-name]/`. Structure:
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
[task-name]/
|
|
14
|
+
├── goals.md # Goals and success criteria
|
|
15
|
+
├── plan.md # Full execution plan with all phases
|
|
16
|
+
├── state.md # Progress tracking
|
|
17
|
+
└── notes.md # Optional: additional context/notes
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Creating Task Files
|
|
21
|
+
|
|
22
|
+
### 1. `goals.md` — Goals & Success Criteria
|
|
23
|
+
|
|
24
|
+
```md
|
|
25
|
+
# Goals and Success Criteria: [task-name]
|
|
26
|
+
|
|
27
|
+
## Primary Goal
|
|
28
|
+
[Clear statement of what the task achieves]
|
|
29
|
+
|
|
30
|
+
## Success Criteria
|
|
31
|
+
- [ ] Criterion 1
|
|
32
|
+
- [ ] Criterion 2
|
|
33
|
+
|
|
34
|
+
## Files Modified
|
|
35
|
+
- `path/to/file` — description of changes
|
|
36
|
+
|
|
37
|
+
## Exclusions
|
|
38
|
+
[What is NOT included in this task]
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 2. `plan.md` — Full Execution Plan
|
|
42
|
+
|
|
43
|
+
Contains all phases inline with step-by-step instructions. The agent retains context between phases, so steps can be concise.
|
|
44
|
+
|
|
45
|
+
```md
|
|
46
|
+
# Task Plan: [task-name]
|
|
47
|
+
|
|
48
|
+
## Phase 1: [Phase Name]
|
|
49
|
+
**Goal:** [What this phase achieves]
|
|
50
|
+
|
|
51
|
+
### Step 1.1: [Step Name]
|
|
52
|
+
- **File:** `path/to/file`
|
|
53
|
+
- **Action:** [Detailed instructions on what to do]
|
|
54
|
+
- **Verify:** [Verifiable success criteria]
|
|
55
|
+
|
|
56
|
+
### Step 1.2: [Step Name]
|
|
57
|
+
- **File:** `path/to/file`
|
|
58
|
+
- **Action:** [Detailed instructions]
|
|
59
|
+
- **Verify:** [Verifiable success criteria]
|
|
60
|
+
|
|
61
|
+
## Phase 2: [Phase Name]
|
|
62
|
+
**Goal:** [What this phase achieves]
|
|
63
|
+
|
|
64
|
+
### Step 2.1: [Step Name]
|
|
65
|
+
- **File:** `path/to/file`
|
|
66
|
+
- **Action:** [Detailed instructions]
|
|
67
|
+
- **Verify:** [Verifiable success criteria]
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**Plan rules:**
|
|
71
|
+
- Each phase has a clear goal
|
|
72
|
+
- Each step specifies the file to modify, the action to take, and how to verify success
|
|
73
|
+
- Success criteria must be verifiable (e.g., "test passes", "file contains X", "code compiles")
|
|
74
|
+
- Steps should be atomic — one clear action per step
|
|
75
|
+
|
|
76
|
+
### 3. `state.md` — Progress Tracking
|
|
77
|
+
|
|
78
|
+
```md
|
|
79
|
+
# Task State: [task-name]
|
|
80
|
+
|
|
81
|
+
## Status: [planned | in-progress | completed]
|
|
82
|
+
|
|
83
|
+
## Phases
|
|
84
|
+
- [ ] Phase 1: [name]
|
|
85
|
+
- [ ] Step 1.1
|
|
86
|
+
- [ ] Step 1.2
|
|
87
|
+
- [ ] Phase 2: [name]
|
|
88
|
+
- [ ] Step 2.1
|
|
89
|
+
|
|
90
|
+
## Notes
|
|
91
|
+
- Next: Phase X, Step Y
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 4. `notes.md` — Optional Context
|
|
95
|
+
|
|
96
|
+
Use this file for any additional context, references, or information the agent should keep in mind while executing the task.
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## Task Execution Workflow (Single Agent)
|
|
101
|
+
|
|
102
|
+
When executing a task created with this skill, follow this workflow:
|
|
103
|
+
|
|
104
|
+
### 1. Start/Resume Task
|
|
105
|
+
1. Read `state.md` to determine current progress
|
|
106
|
+
2. Identify the next step to execute
|
|
107
|
+
3. If status is `completed`, notify user and exit
|
|
108
|
+
|
|
109
|
+
### 2. Execute Steps
|
|
110
|
+
For each step:
|
|
111
|
+
1. Read the step instructions from `plan.md`
|
|
112
|
+
2. Perform the action (edit files, run commands, etc.)
|
|
113
|
+
3. Verify success criteria
|
|
114
|
+
4. If verification fails, fix issues and re-verify
|
|
115
|
+
5. Once verified, mark step as complete in `state.md`
|
|
116
|
+
|
|
117
|
+
### 3. Update State
|
|
118
|
+
After completing each phase:
|
|
119
|
+
1. Mark all steps in that phase as `[x]` with `✓`
|
|
120
|
+
2. Mark the phase as `[x]`
|
|
121
|
+
3. Update "Next" note to point to the next phase/step
|
|
122
|
+
4. If all phases complete, set status to `completed`
|
|
123
|
+
|
|
124
|
+
### 4. Completion
|
|
125
|
+
1. When all phases are done, notify user
|
|
126
|
+
2. Ask user to verify the results
|
|
127
|
+
3. Only delete the task directory if user confirms everything is correct
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Task Creation Workflow
|
|
132
|
+
|
|
133
|
+
When creating a new task:
|
|
134
|
+
|
|
135
|
+
1. **Analyze Request:** Understand what the user wants to accomplish
|
|
136
|
+
2. **Define Goals:** Write `goals.md` with clear success criteria
|
|
137
|
+
3. **Create Plan:** Write `plan.md` breaking work into phases and steps
|
|
138
|
+
4. **Initialize State:** Write `state.md` with all items unchecked, status `planned`
|
|
139
|
+
5. **Report to User:** Show the created task structure before execution
|
|
140
|
+
6. **Wait for Confirmation:** Only execute if user approves the plan
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Choosing Execution Mode
|
|
145
|
+
|
|
146
|
+
Use the `task-mode` skill to decide between single-agent (`create-task-solo`) and multi-agent (`create-task-team`) execution before creating a task. The `task-mode` skill provides a checklist and decision framework based on context isolation needs vs unified context requirements.
|