@vodailoc/kilo-kit-mcp 1.2.0 → 1.3.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 +200 -360
- package/mcp/README.md +33 -11
- package/mcp/dist/formatters.js +5 -7
- package/mcp/dist/init.js +217 -0
- package/mcp/dist/orchestrator.js +22 -33
- package/mcp/dist/server.js +50 -4
- package/mcp/dist/smoke.js +24 -13
- package/mcp/package.json +6 -2
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,449 +1,289 @@
|
|
|
1
|
-
|
|
2
|
-
<img src="assets/social-preview.png" alt="Kilo-Kit social preview" width="100%">
|
|
3
|
-
</p>
|
|
1
|
+
# Kilo-Kit
|
|
4
2
|
|
|
5
|
-
|
|
6
|
-
<a href="https://github.com/VoDaiLocz/KILO-KIT/stargazers"><img src="https://img.shields.io/github/stars/VoDaiLocz/KILO-KIT?style=for-the-badge&logo=github&label=Stars&color=18181b&labelColor=0f172a" alt="GitHub stars"></a>
|
|
7
|
-
<a href="https://github.com/VoDaiLocz/KILO-KIT/commits/main"><img src="https://img.shields.io/github/last-commit/VoDaiLocz/KILO-KIT?style=for-the-badge&logo=git&label=Last%20commit&color=22c55e&labelColor=0f172a" alt="Last commit"></a>
|
|
8
|
-
<a href="https://github.com/VoDaiLocz/KILO-KIT/graphs/contributors"><img src="https://img.shields.io/github/contributors/VoDaiLocz/KILO-KIT?style=for-the-badge&logo=github&label=Contributors&color=f97316&labelColor=0f172a" alt="Contributors"></a>
|
|
9
|
-
<a href="https://github.com/VoDaiLocz/KILO-KIT/actions/workflows/publish.yml"><img src="https://img.shields.io/github/actions/workflow/status/VoDaiLocz/KILO-KIT/publish.yml?style=for-the-badge&logo=githubactions&label=Publish&color=22c55e&labelColor=0f172a" alt="Publish workflow"></a>
|
|
10
|
-
<a href="https://www.npmjs.com/package/@vodailoc/kilo-kit-mcp"><img src="https://img.shields.io/npm/v/@vodailoc/kilo-kit-mcp?style=for-the-badge&logo=npm&label=npm&color=ef4444&labelColor=0f172a" alt="npm version"></a>
|
|
11
|
-
<a href="https://www.npmjs.com/package/@vodailoc/kilo-kit-mcp"><img src="https://img.shields.io/npm/dm/@vodailoc/kilo-kit-mcp?style=for-the-badge&logo=npm&label=downloads&color=0284c7&labelColor=0f172a" alt="npm downloads"></a>
|
|
12
|
-
<a href="LICENSE"><img src="https://img.shields.io/github/license/VoDaiLocz/KILO-KIT?style=for-the-badge&label=License&color=64748b&labelColor=0f172a" alt="License"></a>
|
|
13
|
-
</p>
|
|
3
|
+
Kilo-Kit is a local-first skill and orchestration framework for MCP-capable coding agents.
|
|
14
4
|
|
|
15
|
-
|
|
16
|
-
<img src="https://img.shields.io/badge/skills-134-06b6d4?style=for-the-badge&labelColor=0f172a" alt="134 skills">
|
|
17
|
-
<img src="https://img.shields.io/badge/MCP-ready-14b8a6?style=for-the-badge&logo=modelcontextprotocol&labelColor=0f172a" alt="MCP ready">
|
|
18
|
-
<img src="https://img.shields.io/badge/Codex-ready-111827?style=for-the-badge&logo=openai&labelColor=0f172a" alt="Codex ready">
|
|
19
|
-
<img src="https://img.shields.io/badge/Trusted%20Publishing-OIDC-8b5cf6?style=for-the-badge&logo=githubactions&labelColor=0f172a" alt="Trusted publishing">
|
|
20
|
-
<img src="https://img.shields.io/badge/Node-%3E%3D20-339933?style=for-the-badge&logo=nodedotjs&labelColor=0f172a" alt="Node >=20">
|
|
21
|
-
<img src="https://img.shields.io/badge/TypeScript-5.9-3178c6?style=for-the-badge&logo=typescript&labelColor=0f172a" alt="TypeScript 5.9">
|
|
22
|
-
</p>
|
|
5
|
+
It packages a curated `skills/` library, an MCP server, and a C4 orchestration gate that turns a user request into an auditable workflow:
|
|
23
6
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
> **Version:** 1.0.0
|
|
27
|
-
> **Author:** Kilo-Kit Team
|
|
28
|
-
> **License:** Apache 2.0
|
|
29
|
-
|
|
30
|
-
## 🎯 What is Kilo-Kit?
|
|
31
|
-
|
|
32
|
-
**Kilo-Kit** is a comprehensive, modular framework for building and managing AI agent systems at scale (kilo-code = thousands of lines, hundreds of files). It introduces a revolutionary **Cognitive Flow Architecture (CFA)** that treats AI interactions as continuous flows rather than discrete events.
|
|
33
|
-
|
|
34
|
-
### Core Philosophy
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
🧠 "Anticipate needs before they arise"
|
|
38
|
-
🔄 "Learn from every interaction"
|
|
39
|
-
📐 "Modularity enables scalability"
|
|
40
|
-
🎯 "Quality over quantity in every token"
|
|
41
|
-
💰 "Cost-aware intelligence"
|
|
7
|
+
```text
|
|
8
|
+
request -> route -> brainstorming gate -> memory confirmation -> workflow release -> verification gate
|
|
42
9
|
```
|
|
43
10
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
| Innovation | Description |
|
|
47
|
-
|------------|-------------|
|
|
48
|
-
| **Predictive Context Engine (PCE)** | Pre-loads context before you need it |
|
|
49
|
-
| **Composable Behavior Units (CBU)** | Build workflows from micro-behaviors |
|
|
50
|
-
| **Token Economy Manager (TEM)** | Smart budgeting for cost/quality balance |
|
|
51
|
-
| **Decision Audit Trail (DAT)** | Full explainability for all decisions |
|
|
52
|
-
| **Skill Effectiveness Tracker (SET)** | Self-improving skill system |
|
|
53
|
-
| **Adaptive Routing** | Learns optimal skill selection over time |
|
|
11
|
+
The published package is `@vodailoc/kilo-kit-mcp`.
|
|
54
12
|
|
|
55
|
-
##
|
|
13
|
+
## What It Provides
|
|
56
14
|
|
|
57
|
-
|
|
|
58
|
-
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
|
65
|
-
| **Security First** | Input validation, parameterized queries, no hardcoded secrets |
|
|
66
|
-
| **Multi-Stack Support** | TypeScript, Python, .NET, Go ready |
|
|
15
|
+
| Area | Purpose |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| Skill library | Installable `SKILL.md` workflows grouped by engineering, productivity, debugging, design, operations, docs, and more. |
|
|
18
|
+
| MCP server | stdio server exposing routing, skill loading, validation, C4 orchestration, memory, and route reports. |
|
|
19
|
+
| C4 gate | A closed-loop workflow gate that blocks substantive work until the real brainstorming skill has been followed and approved. |
|
|
20
|
+
| Memory | Optional SQLite-backed facts, decisions, sessions, and workflow outcomes. |
|
|
21
|
+
| Audit | Optional JSONL trail for C4 state transitions and route decisions. |
|
|
22
|
+
| Verification | A returned verification gate that agents must satisfy before claiming completion. |
|
|
67
23
|
|
|
68
|
-
##
|
|
24
|
+
## Install In Two Steps
|
|
69
25
|
|
|
70
|
-
|
|
26
|
+
Step 1: install the MCP server in your client.
|
|
71
27
|
|
|
72
|
-
|
|
73
|
-
|-------|---------|
|
|
74
|
-
| `skills/kilo-kit/` | Core Kilo-Kit framework skills and Hard-Gate workflows |
|
|
75
|
-
| `skills/<category>/<skill>/` | Expanded skill library organized by execution domain |
|
|
76
|
-
| `skills/README.md` | Human-facing catalog with category summaries and install commands |
|
|
77
|
-
| `skills/SKILLS_INDEX.md` | Lightweight agent index for Predictive Context Engine prefetching |
|
|
28
|
+
Use the published package in any MCP-capable host:
|
|
78
29
|
|
|
79
|
-
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"mcpServers": {
|
|
33
|
+
"kilo-kit": {
|
|
34
|
+
"command": "npx",
|
|
35
|
+
"args": ["-y", "@vodailoc/kilo-kit-mcp"]
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
80
40
|
|
|
81
|
-
|
|
41
|
+
Step 2: bootstrap the host-agent rule in your project.
|
|
82
42
|
|
|
83
43
|
```bash
|
|
84
|
-
npx
|
|
44
|
+
npx -y --package=@vodailoc/kilo-kit-mcp kilo-kit-init init --client gemini
|
|
45
|
+
npx -y --package=@vodailoc/kilo-kit-mcp kilo-kit-init init --client codex
|
|
46
|
+
npx -y --package=@vodailoc/kilo-kit-mcp kilo-kit-init init --client claude
|
|
85
47
|
```
|
|
86
48
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
### Install a Category
|
|
90
|
-
|
|
91
|
-
Use a category path when you only want one execution domain:
|
|
49
|
+
Or initialize all supported host files:
|
|
92
50
|
|
|
93
51
|
```bash
|
|
94
|
-
npx
|
|
52
|
+
npx -y --package=@vodailoc/kilo-kit-mcp kilo-kit-init init --client all
|
|
95
53
|
```
|
|
96
54
|
|
|
97
|
-
|
|
55
|
+
This writes an idempotent Kilo-Kit C4 block to:
|
|
98
56
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
57
|
+
| Client | File |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| Gemini CLI | `GEMINI.md` |
|
|
60
|
+
| OpenAI Codex | `AGENTS.md` |
|
|
61
|
+
| Claude Code | `CLAUDE.md` |
|
|
102
62
|
|
|
103
|
-
|
|
63
|
+
The block is wrapped in `KILO-KIT:C4` markers, so running the command again updates the Kilo-Kit section without deleting your existing project rules.
|
|
104
64
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
│ └── instructions.md
|
|
114
|
-
├── .cursor-plugin/ # Cursor IDE entry point
|
|
115
|
-
│ └── instructions.md
|
|
116
|
-
├── .codex/ # OpenAI Codex entry point
|
|
117
|
-
│ └── instructions.md
|
|
118
|
-
├── .opencode/ # OpenCode entry point
|
|
119
|
-
│ └── instructions.md
|
|
120
|
-
│
|
|
121
|
-
├── skills/ # Installable skill packs
|
|
122
|
-
│ ├── README.md # Human-facing skill catalog
|
|
123
|
-
│ ├── SKILLS_INDEX.md # Lightweight agent skill index
|
|
124
|
-
│ ├── kilo-kit/ # Core Kilo-Kit skills
|
|
125
|
-
│ │ ├── _template/ # Skill template
|
|
126
|
-
│ │ ├── debugging/ # Debugging skills
|
|
127
|
-
│ │ ├── development/ # Development skills
|
|
128
|
-
│ │ └── quality/ # Quality assurance skills
|
|
129
|
-
│ ├── engineering/ # Engineering and framework skills
|
|
130
|
-
│ ├── productivity/ # Agent workflow skills
|
|
131
|
-
│ ├── problem-solving/ # Debugging/reasoning skills
|
|
132
|
-
│ ├── design/ # UI/design skills
|
|
133
|
-
│ └── ... # Games, ops, docs, AI media, security
|
|
134
|
-
│
|
|
135
|
-
├── commands/ # Workflow commands
|
|
136
|
-
│ ├── quality-gate.md # Quality gate workflow
|
|
137
|
-
│ ├── init-skill.md # Skill initialization
|
|
138
|
-
│ └── validate-skill.md # Skill validation
|
|
139
|
-
│
|
|
140
|
-
├── src/ # Core system source
|
|
141
|
-
│ ├── core/ # Core system components
|
|
142
|
-
│ │ ├── KILO_MASTER.md # Master skill file (entry point)
|
|
143
|
-
│ │ ├── predictive-engine/ # Predictive Context Engine
|
|
144
|
-
│ │ ├── routing-engine/ # Adaptive Routing Engine
|
|
145
|
-
│ │ ├── execution-engine/ # Execution & Quality Gates
|
|
146
|
-
│ │ └── knowledge-layer/ # Persistent Knowledge
|
|
147
|
-
│ │
|
|
148
|
-
│ ├── behaviors/ # Composable Behavior Units
|
|
149
|
-
│ │ ├── atomic/ # Smallest behavior units
|
|
150
|
-
│ │ ├── compound/ # Combined behaviors
|
|
151
|
-
│ │ └── meta/ # Meta-behaviors
|
|
152
|
-
│ │
|
|
153
|
-
│ └── tools/ # CLI and utility tools
|
|
154
|
-
│ ├── init-skill.py # Skill initializer
|
|
155
|
-
│ ├── validate-skill.py # Skill validator (Python)
|
|
156
|
-
│ └── validate-skill.js # Skill validator (Node.js)
|
|
157
|
-
│
|
|
158
|
-
├── docs/ # Documentation
|
|
159
|
-
│ ├── architecture/ # Architecture decisions
|
|
160
|
-
│ ├── COMPLETION_ASSESSMENT.md
|
|
161
|
-
│ ├── DEEP_ANALYSIS.md
|
|
162
|
-
│ └── PROJECT_STRUCTURE.md
|
|
163
|
-
│
|
|
164
|
-
└── examples/ # Real-world examples
|
|
165
|
-
├── basic/ # Basic usage patterns
|
|
166
|
-
├── intermediate/ # Intermediate patterns
|
|
167
|
-
└── advanced/ # Advanced patterns
|
|
65
|
+
For Codex CLI on Windows, use an npm prefix outside the source checkout so npm does not resolve a local checkout:
|
|
66
|
+
|
|
67
|
+
```toml
|
|
68
|
+
[mcp_servers.kilo-kit]
|
|
69
|
+
command = "npm"
|
|
70
|
+
args = ["exec", "--prefix", "C:\\Users\\Admin", "--yes", "--package=@vodailoc/kilo-kit-mcp", "--", "kilo-kit-mcp"]
|
|
71
|
+
startup_timeout_sec = 60
|
|
72
|
+
enabled = true
|
|
168
73
|
```
|
|
169
74
|
|
|
170
|
-
##
|
|
75
|
+
## Why Bootstrap Is Needed
|
|
171
76
|
|
|
172
|
-
|
|
77
|
+
MCP exposes tools, prompts, resources, and server instructions. It does not force every host agent to call those tools automatically.
|
|
173
78
|
|
|
174
|
-
|
|
175
|
-
# Clone the repository
|
|
176
|
-
git clone https://github.com/VoDaiLocz/KILO-KIT.git
|
|
177
|
-
cd kilo-kit
|
|
79
|
+
Kilo-Kit ships the C4 rule in four places:
|
|
178
80
|
|
|
179
|
-
|
|
180
|
-
|
|
81
|
+
- MCP server instructions.
|
|
82
|
+
- MCP resource `kilo://rules/c4`.
|
|
83
|
+
- MCP prompt `kilo-c4-workflow`.
|
|
84
|
+
- Host bootstrap files created by `kilo-kit-init`.
|
|
181
85
|
|
|
182
|
-
|
|
86
|
+
The bootstrap file is the reliable part. It tells the host agent to call C4 before implementation instead of waiting for the user to manually request MCP usage.
|
|
183
87
|
|
|
184
|
-
|
|
88
|
+
## C4 Workflow
|
|
185
89
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
90
|
+
`kilo_orchestrate_task` is the main C4 entry point. It does not execute code. It routes the request, records state, and releases the next workflow only when the gate conditions are satisfied.
|
|
91
|
+
|
|
92
|
+
The intended flow is:
|
|
189
93
|
|
|
190
|
-
|
|
94
|
+
```text
|
|
95
|
+
1. User sends a substantive task.
|
|
96
|
+
2. Agent calls kilo_orchestrate_task(message, context).
|
|
97
|
+
3. C4 routes the task and injects productivity/brainstorming first.
|
|
98
|
+
4. State becomes brainstorming_required.
|
|
99
|
+
5. Agent loads productivity/brainstorming with kilo_get_skill.
|
|
100
|
+
6. Agent follows that skill and gets user approval.
|
|
101
|
+
7. Agent calls kilo_orchestrate_task again with the same sessionId and brainstormingApproved=true.
|
|
102
|
+
8. C4 checks memory suggestions.
|
|
103
|
+
9. If suggestions exist, state becomes awaiting_memory_confirmation.
|
|
104
|
+
10. Agent accepts or rejects suggestions with memoryConfirmations.
|
|
105
|
+
11. State becomes ready.
|
|
106
|
+
12. C4 returns finalWorkflow without productivity/brainstorming.
|
|
107
|
+
13. Agent loads the first workflow skill with kilo_get_skill.
|
|
108
|
+
14. Agent also checks its internal skill list for other relevant skills before coding.
|
|
109
|
+
15. Agent executes the workflow and satisfies the returned verificationGate before completion.
|
|
191
110
|
```
|
|
192
111
|
|
|
193
|
-
|
|
112
|
+
Read-only requests such as status, show, read, or explain can skip the brainstorming gate.
|
|
194
113
|
|
|
195
|
-
|
|
114
|
+
### C4 States
|
|
196
115
|
|
|
197
|
-
|
|
116
|
+
| State | Meaning |
|
|
117
|
+
| --- | --- |
|
|
118
|
+
| `brainstorming_required` | Substantive work is blocked until `productivity/brainstorming` is loaded, followed, and approved by the user. |
|
|
119
|
+
| `awaiting_memory_confirmation` | C4 found remembered operating preferences. The agent must accept or reject them before execution. |
|
|
120
|
+
| `ready` | C4 has released the post-brainstorming workflow and verification gate. |
|
|
198
121
|
|
|
199
|
-
|
|
122
|
+
### Returned Workflow
|
|
200
123
|
|
|
201
|
-
|
|
202
|
-
|-------------|---------|
|
|
203
|
-
| `kilo_orchestrate_task` | C4 central gate: route internally, require brainstorming, ask questions, check memory, and release final workflow |
|
|
204
|
-
| `kilo_route_intent` | Route the current chat request to skills, workflow order, rule hierarchy, and decision trail |
|
|
205
|
-
| `kilo_search_skills` | Search the skill catalog by task or keyword |
|
|
206
|
-
| `kilo_get_skill` | Load one exact `SKILL.md` with context-safe truncation |
|
|
207
|
-
| `kilo_route_report` | Summarize route telemetry, top skills, workflows, and conflict penalties |
|
|
208
|
-
| `kilo_memory_report` | Inspect C4 global memory facts, decisions, and suggestions |
|
|
209
|
-
| `kilo_validate_skills` | Run the skill validation quality gate |
|
|
210
|
-
| `kilo://skills/index` | Resource view of the lightweight skill index |
|
|
211
|
-
| `kilo://skills/{category}/{skill}` | Resource view for one skill |
|
|
124
|
+
When C4 is ready, it returns:
|
|
212
125
|
|
|
213
|
-
|
|
126
|
+
- `finalWorkflow`: ordered Kilo-Kit skill steps for the task mode.
|
|
127
|
+
- `firstSkillToLoad`: first skill the agent should load with `kilo_get_skill`.
|
|
128
|
+
- `verificationGate`: commands and rationale that must pass before completion.
|
|
129
|
+
- `nextAction`: the immediate instruction for the agent.
|
|
130
|
+
- `auditRef`: present when orchestration audit JSONL is enabled.
|
|
214
131
|
|
|
215
|
-
|
|
216
|
-
{
|
|
217
|
-
"mcpServers": {
|
|
218
|
-
"kilo-kit": {
|
|
219
|
-
"command": "npx",
|
|
220
|
-
"args": ["-y", "@vodailoc/kilo-kit-mcp"]
|
|
221
|
-
}
|
|
222
|
-
}
|
|
223
|
-
}
|
|
224
|
-
```
|
|
132
|
+
The returned workflow is a primary route, not the only context source. Agents must also inspect their own available skill list and load any other relevant skills before implementation.
|
|
225
133
|
|
|
226
|
-
|
|
134
|
+
## MCP Tools
|
|
227
135
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
136
|
+
| Tool | Purpose |
|
|
137
|
+
| --- | --- |
|
|
138
|
+
| `kilo_orchestrate_task` | C4 gate for substantive work. Routes internally, enforces brainstorming first, checks memory, and releases the final workflow. |
|
|
139
|
+
| `kilo_route_intent` | Routes a request to recommended skills, task mode, workflow order, rule hierarchy, and decision trail. |
|
|
140
|
+
| `kilo_search_skills` | Searches the skill catalog by natural-language query. |
|
|
141
|
+
| `kilo_get_skill` | Loads one exact `SKILL.md` with context-safe truncation. |
|
|
142
|
+
| `kilo_route_report` | Reports route telemetry, top skills, workflows, score averages, and conflict penalties. |
|
|
143
|
+
| `kilo_memory_report` | Reports C4 memory facts, decisions, suggestions, sessions, and workflow outcomes. |
|
|
144
|
+
| `kilo_validate_skills` | Runs the skill validation gate. |
|
|
235
145
|
|
|
236
|
-
|
|
146
|
+
## MCP Resources
|
|
237
147
|
|
|
238
|
-
|
|
148
|
+
| Resource | Purpose |
|
|
149
|
+
| --- | --- |
|
|
150
|
+
| `kilo://skills/index` | Lightweight skill index for discovery. |
|
|
151
|
+
| `kilo://core/master` | Core Kilo-Kit master instructions. |
|
|
152
|
+
| `kilo://rules/c4` | Minimal host-agent operating rules for the C4 workflow. |
|
|
153
|
+
| `kilo://skills/{category}/{skill}` | Dynamic skill resource for one skill. |
|
|
239
154
|
|
|
240
|
-
|
|
155
|
+
## Persistence
|
|
241
156
|
|
|
242
|
-
|
|
157
|
+
Route telemetry is in memory by default. Enable JSONL decision persistence with:
|
|
243
158
|
|
|
244
159
|
```bash
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
npm run build
|
|
248
|
-
npm test
|
|
249
|
-
npm run smoke
|
|
160
|
+
KILO_KIT_WRITE_DECISIONS=true
|
|
161
|
+
KILO_KIT_DECISION_TRAIL_PATH=/absolute/path/decision-trail.jsonl
|
|
250
162
|
```
|
|
251
163
|
|
|
252
|
-
|
|
164
|
+
If `KILO_KIT_DECISION_TRAIL_PATH` is not set, route decisions are written to `.kilo/decision-trail.jsonl` under `KILO_KIT_REPO_ROOT`.
|
|
253
165
|
|
|
254
|
-
|
|
255
|
-
{
|
|
256
|
-
"mcpServers": {
|
|
257
|
-
"kilo-kit": {
|
|
258
|
-
"command": "node",
|
|
259
|
-
"args": ["<absolute-path-to-KILO-KIT>/mcp/dist/server.js"],
|
|
260
|
-
"env": {
|
|
261
|
-
"KILO_KIT_REPO_ROOT": "<absolute-path-to-KILO-KIT>"
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
```
|
|
166
|
+
C4 memory uses `node:sqlite` when available and defaults to:
|
|
267
167
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
168
|
+
```text
|
|
169
|
+
~/.kilo-kit/orchestrator.sqlite
|
|
170
|
+
```
|
|
271
171
|
|
|
272
|
-
|
|
172
|
+
Override C4 paths with:
|
|
273
173
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
| Workflow filename | `publish.yml` |
|
|
174
|
+
```bash
|
|
175
|
+
KILO_KIT_MEMORY_PATH=/absolute/path/orchestrator.sqlite
|
|
176
|
+
KILO_KIT_ORCHESTRATION_AUDIT_PATH=/absolute/path/orchestration-audit.jsonl
|
|
177
|
+
```
|
|
279
178
|
|
|
280
|
-
|
|
179
|
+
C4 memory stores structured facts, decisions, orchestration sessions, and workflow outcomes. The audit file stores append-only state transition events.
|
|
281
180
|
|
|
282
|
-
##
|
|
181
|
+
## Skill Library
|
|
283
182
|
|
|
284
|
-
|
|
285
|
-
|---------------|---------------|
|
|
286
|
-
| `bug, error, fix, debug` | `skills/kilo-kit/debugging/systematic/` |
|
|
287
|
-
| `validate, validation` | `skills/kilo-kit/debugging/systematic/` |
|
|
288
|
-
| `root cause, why` | `skills/kilo-kit/debugging/root-cause/` |
|
|
289
|
-
| `verify, confirm` | `skills/kilo-kit/debugging/verification/` |
|
|
290
|
-
| `review, PR, code review` | `skills/kilo-kit/quality/code-review/` |
|
|
291
|
-
| `test, TDD, testing` | `skills/kilo-kit/quality/testing/` |
|
|
292
|
-
| `security, auth, OWASP` | `skills/kilo-kit/development/security/` |
|
|
293
|
-
| `API, backend, server` | `skills/kilo-kit/development/backend/` |
|
|
183
|
+
`skills/` is the workflow surface shipped with the package.
|
|
294
184
|
|
|
295
|
-
|
|
185
|
+
| Path | Purpose |
|
|
186
|
+
| --- | --- |
|
|
187
|
+
| `skills/SKILLS_INDEX.md` | Lightweight index for routing and discovery. |
|
|
188
|
+
| `skills/kilo-kit/` | Core Kilo-Kit framework skills. |
|
|
189
|
+
| `skills/engineering/` | Engineering and framework workflows. |
|
|
190
|
+
| `skills/productivity/` | Agent workflow and planning skills. |
|
|
191
|
+
| `skills/problem-solving/` | Debugging and reasoning skills. |
|
|
192
|
+
| `skills/design/` | Frontend and product design skills. |
|
|
193
|
+
| `skills/operations/` | DevOps, MCP, shell, browser, and server skills. |
|
|
194
|
+
| `skills/writing-docs/` | Documents, slides, PDFs, spreadsheets, and diagrams. |
|
|
296
195
|
|
|
297
|
-
|
|
196
|
+
Install the full skill library:
|
|
298
197
|
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
Kilo-Kit: ┌─────────────────────────────┐
|
|
303
|
-
│ COGNITIVE FLOW │
|
|
304
|
-
│ │
|
|
305
|
-
Input ───►│ Predict → Execute → Learn │───► Output
|
|
306
|
-
│ ↑ │ │
|
|
307
|
-
Next ───►│ └──────────────┘ │───► Better
|
|
308
|
-
│ │
|
|
309
|
-
└─────────────────────────────┘
|
|
198
|
+
```bash
|
|
199
|
+
npx skills@latest add VoDaiLocz/KILO-KIT
|
|
310
200
|
```
|
|
311
201
|
|
|
312
|
-
|
|
202
|
+
Install one category:
|
|
313
203
|
|
|
314
204
|
```bash
|
|
315
|
-
|
|
316
|
-
typecheck → lint → test → build
|
|
317
|
-
|
|
318
|
-
# All must pass. No exceptions.
|
|
205
|
+
npx skills@latest add VoDaiLocz/KILO-KIT/skills/engineering
|
|
319
206
|
```
|
|
320
207
|
|
|
321
|
-
|
|
208
|
+
Install one skill:
|
|
322
209
|
|
|
323
|
-
```
|
|
324
|
-
|
|
325
|
-
↑ │
|
|
326
|
-
└────────────────────────────┘
|
|
210
|
+
```bash
|
|
211
|
+
npx skills@latest add VoDaiLocz/KILO-KIT/skills/engineering/tdd
|
|
327
212
|
```
|
|
328
213
|
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
214
|
+
## Repository Layout
|
|
215
|
+
|
|
216
|
+
```text
|
|
217
|
+
.
|
|
218
|
+
|-- .claude-plugin/ Claude Code entry instructions
|
|
219
|
+
|-- .codex/ Codex entry instructions
|
|
220
|
+
|-- .cursor-plugin/ Cursor entry instructions
|
|
221
|
+
|-- .mcp/ MCP config examples
|
|
222
|
+
|-- .opencode/ OpenCode entry instructions
|
|
223
|
+
|-- commands/ Reusable workflow commands
|
|
224
|
+
|-- docs/ Architecture and planning documents
|
|
225
|
+
|-- examples/ Example workflows
|
|
226
|
+
|-- mcp/ TypeScript MCP server
|
|
227
|
+
|-- skills/ Installable skill library
|
|
228
|
+
|-- src/core/ Core framework docs and validator entry files
|
|
229
|
+
`-- src/tools/ Skill initialization and validation tools
|
|
335
230
|
```
|
|
336
231
|
|
|
337
|
-
##
|
|
232
|
+
## Local Development
|
|
338
233
|
|
|
339
|
-
|
|
234
|
+
Install, build, test, and smoke-check the MCP server:
|
|
340
235
|
|
|
341
236
|
```bash
|
|
342
|
-
|
|
237
|
+
npm --prefix mcp install
|
|
238
|
+
npm --prefix mcp run build
|
|
239
|
+
npm --prefix mcp run typecheck
|
|
240
|
+
npm --prefix mcp test
|
|
241
|
+
npm --prefix mcp run smoke
|
|
242
|
+
node src/tools/validate-skill.js --all skills
|
|
343
243
|
```
|
|
344
244
|
|
|
345
|
-
|
|
245
|
+
Use a local MCP server during development:
|
|
346
246
|
|
|
247
|
+
```json
|
|
248
|
+
{
|
|
249
|
+
"mcpServers": {
|
|
250
|
+
"kilo-kit": {
|
|
251
|
+
"command": "node",
|
|
252
|
+
"args": ["/absolute/path/to/KILO-KIT/mcp/dist/server.js"],
|
|
253
|
+
"env": {
|
|
254
|
+
"KILO_KIT_REPO_ROOT": "/absolute/path/to/KILO-KIT"
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}
|
|
347
259
|
```
|
|
348
|
-
my-skill/
|
|
349
|
-
├── SKILL.md # Main instructions (required)
|
|
350
|
-
├── references/ # Documentation to load as needed
|
|
351
|
-
├── scripts/ # Executable utilities
|
|
352
|
-
└── assets/ # Templates, images, etc.
|
|
353
|
-
```
|
|
354
|
-
|
|
355
|
-
### SKILL.md Format
|
|
356
|
-
|
|
357
|
-
```yaml
|
|
358
|
-
---
|
|
359
|
-
name: my-skill
|
|
360
|
-
description: >-
|
|
361
|
-
Clear description of what this skill does and when to use it.
|
|
362
|
-
Include keywords that should trigger this skill.
|
|
363
|
-
version: 1.0.0
|
|
364
|
-
behaviors: [behavior1, behavior2]
|
|
365
|
-
token_estimate:
|
|
366
|
-
min: 500
|
|
367
|
-
typical: 1500
|
|
368
|
-
max: 5000
|
|
369
|
-
---
|
|
370
|
-
|
|
371
|
-
# My Skill
|
|
372
|
-
|
|
373
|
-
## When to Use
|
|
374
|
-
- Situation 1
|
|
375
|
-
- Situation 2
|
|
376
|
-
|
|
377
|
-
## Process
|
|
378
|
-
1. Step 1
|
|
379
|
-
2. Step 2
|
|
380
|
-
|
|
381
|
-
## Guidelines
|
|
382
|
-
- Guideline 1
|
|
383
|
-
- Guideline 2
|
|
384
|
-
|
|
385
|
-
## References
|
|
386
|
-
- `references/detailed-guide.md` - For detailed instructions
|
|
387
|
-
- `scripts/helper.py` - For automated tasks
|
|
388
|
-
```
|
|
389
|
-
|
|
390
|
-
## 📚 Documentation
|
|
391
|
-
|
|
392
|
-
- **[QUICKSTART.md](./QUICKSTART.md)** - Get started in 15 minutes
|
|
393
|
-
- **[docs/architecture/](./docs/architecture/)** - Architecture design documents
|
|
394
|
-
- **[docs/PROJECT_STRUCTURE.md](./docs/PROJECT_STRUCTURE.md)** - Project structure guide
|
|
395
|
-
- **[examples/](./examples/)** - Real-world usage examples
|
|
396
|
-
|
|
397
|
-
## 🤝 Contributing
|
|
398
|
-
|
|
399
|
-
We welcome contributions! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for:
|
|
400
|
-
|
|
401
|
-
- Code of conduct
|
|
402
|
-
- Development setup
|
|
403
|
-
- Pull request process
|
|
404
|
-
- Coding standards
|
|
405
260
|
|
|
406
|
-
##
|
|
261
|
+
## Release
|
|
407
262
|
|
|
408
|
-
|
|
409
|
-
| Category | Preferred | Avoid |
|
|
410
|
-
|----------|-----------|-------|
|
|
411
|
-
| Runtime | Bun, Node 20+ | Node <18 |
|
|
412
|
-
| Backend | Hono, Elysia | Express |
|
|
413
|
-
| ORM | Drizzle, Prisma 5+ | Sequelize |
|
|
414
|
-
| Testing | Vitest, Playwright | Jest |
|
|
415
|
-
| Package | pnpm, Bun | npm |
|
|
263
|
+
The root package publishes through npm Trusted Publishing from GitHub Actions.
|
|
416
264
|
|
|
417
|
-
|
|
418
|
-
| Category | Preferred | Avoid |
|
|
419
|
-
|----------|-----------|-------|
|
|
420
|
-
| Runtime | Python 3.11+ | <3.9 |
|
|
421
|
-
| Backend | FastAPI, Litestar | Flask |
|
|
422
|
-
| ORM | SQLAlchemy 2.0 | <2.0 |
|
|
423
|
-
| Validation | Pydantic v2 | v1 |
|
|
424
|
-
| Linting | Ruff, mypy | flake8 |
|
|
265
|
+
Configure npm once:
|
|
425
266
|
|
|
426
|
-
|
|
427
|
-
|
|
|
428
|
-
|
|
429
|
-
|
|
|
430
|
-
|
|
|
431
|
-
| ORM | EF Core |
|
|
432
|
-
| Testing | xUnit, NUnit |
|
|
267
|
+
| Field | Value |
|
|
268
|
+
| --- | --- |
|
|
269
|
+
| Provider | GitHub Actions |
|
|
270
|
+
| Repository | `VoDaiLocz/KILO-KIT` |
|
|
271
|
+
| Workflow filename | `publish.yml` |
|
|
433
272
|
|
|
434
|
-
|
|
273
|
+
Then run the `Publish npm package` workflow or push a version tag:
|
|
435
274
|
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
275
|
+
```bash
|
|
276
|
+
git tag v1.3.1
|
|
277
|
+
git push origin v1.3.1
|
|
278
|
+
```
|
|
440
279
|
|
|
441
|
-
|
|
280
|
+
The release workflow runs build, typecheck, tests, smoke, skill validation, package dry-run, and `npm publish --access public --ignore-scripts`.
|
|
442
281
|
|
|
443
|
-
|
|
282
|
+
## Roadmap
|
|
444
283
|
|
|
445
|
-
|
|
284
|
+
- v1.3.x: C4 gate hardening, memory/audit clarity, documentation cleanup.
|
|
285
|
+
- v2.0.0: Local Visual Workflow Builder for C4 sessions, memory, and audit review.
|
|
446
286
|
|
|
447
|
-
|
|
287
|
+
## License
|
|
448
288
|
|
|
449
|
-
|
|
289
|
+
Apache 2.0. See [LICENSE](./LICENSE).
|