@plumpslabs/kuma 2.4.2 β†’ 2.4.4

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.
@@ -0,0 +1,17 @@
1
+ {
2
+ "$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
3
+ "name": "plumpslabs-kuma",
4
+ "description": "Safety-first context & orchestration engine for AI coding agents.",
5
+ "owner": {
6
+ "name": "plumpslabs",
7
+ "url": "https://github.com/plumpslabs"
8
+ },
9
+ "plugins": [
10
+ {
11
+ "name": "kuma",
12
+ "description": "Safety-first context & orchestration engine for AI coding agents. Shadow memory, gotcha lifecycle, blast radius impact analysis, and test verification.",
13
+ "source": "./",
14
+ "category": "safety"
15
+ }
16
+ ]
17
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "name": "kuma",
3
+ "version": "2.4.4",
4
+ "description": "Safety-first context & orchestration engine for AI coding agents. Shadow memory, gotcha lifecycle, blast radius impact analysis, and test verification.",
5
+ "author": {
6
+ "name": "plumpslabs",
7
+ "url": "https://github.com/plumpslabs"
8
+ },
9
+ "license": "MIT"
10
+ }
package/INSTALL.md ADDED
@@ -0,0 +1,265 @@
1
+ # 🐻 Kuma β€” Complete Installation & Provider Setup Guide
2
+
3
+ > Universal guide to installing and configuring **Kuma MCP** for every major AI coding agent and IDE.
4
+
5
+ ---
6
+
7
+ ## ⚑ Quick Start (Universal)
8
+
9
+ The fastest way to install Kuma in any repository:
10
+
11
+ ```bash
12
+ # 1-Liner auto-detect installer (auto-configures rules, hooks, and MCP)
13
+ curl -fsSL https://raw.githubusercontent.com/plumpslabs/kuma/main/install.sh | bash
14
+ ```
15
+
16
+ Or via `npx` with zero installation:
17
+
18
+ ```bash
19
+ # Auto-detects your IDE/agent and creates tailored rules & hooks
20
+ npx @plumpslabs/kuma init
21
+
22
+ # Or initialize for ALL supported providers at once
23
+ npx @plumpslabs/kuma init --all
24
+ ```
25
+
26
+ ---
27
+
28
+ ## πŸ”Œ Provider Setup Matrix
29
+
30
+ | Provider / IDE | Install Method | Config Files Generated | MCP Integration |
31
+ |---|---|---|---|
32
+ | **Claude Code** | Marketplace / `kuma init` | `CLAUDE.md`, `.claude/settings.json` (hooks) | `.mcp.json` / `~/.claude.json` |
33
+ | **Google Antigravity** | Plugin / `kuma init` | `.agents/rules/kuma.md`, `.agents/skills/`, `GEMINI.md` | `.agents/mcp_config.json` |
34
+ | **Cursor** | `kuma init --cursor` | `.cursor/rules/kuma.mdc`, `.cursorrules` | `.cursor/mcp.json` |
35
+ | **Windsurf** | `kuma init --windsurf` | `.windsurfrules`, `.windsurf/rules/kuma.md` | `~/.codeium/windsurf/mcp_config.json` |
36
+ | **OpenCode** | `kuma init --opencode` | `AGENTS.md`, `.opencode/plugins/kuma.js` | `opencode.json` (array command) |
37
+ | **GitHub Copilot** | `kuma init --copilot` | `.github/copilot-instructions.md`, `.github/skills/` | Extension settings |
38
+ | **Zed** | `kuma init` | `AGENTS.md` | `settings.json` (`context_servers`) |
39
+ | **Cline / Roo / Trae** | `kuma init --cline` | `.clinerules/kuma.md`, `.roo/rules/`, `.trae/rules/` | Cline MCP UI |
40
+ | **Codex (OpenAI)** | `kuma init --codex` | `AGENTS.md`, `.codex/config.toml` | Codex MCP config |
41
+ | **Aider** | `kuma init --aider` | `CONVENTIONS.md`, `.aider.conf.yml` | Native config |
42
+ | **Qwen / Kiro** | `kuma init --qwen --kiro` | `AGENTS.md`, `.kiro/steering/kuma.md` | Local config |
43
+
44
+ ---
45
+
46
+ ## 🟠 1. Claude Code
47
+
48
+ ### Method A: Claude Code Marketplace (Recommended)
49
+ Add the Kuma marketplace and install the plugin directly:
50
+
51
+ ```bash
52
+ /plugin marketplace add plumpslabs/kuma
53
+ /plugin install kuma@plumpslabs-kuma
54
+ ```
55
+
56
+ ### Method B: Via `kuma init`
57
+ Run inside your project directory:
58
+ ```bash
59
+ npx @plumpslabs/kuma init --claude
60
+ ```
61
+
62
+ This creates:
63
+ - `CLAUDE.md` β€” Project context and safety obedience guidelines.
64
+ - `.claude/settings.json` β€” PreToolUse hooks (`kuma hook pre-edit` and `kuma hook pre-bash`) that auto-inject known gotchas before file modifications.
65
+
66
+ ### MCP Configuration
67
+ Add to `.mcp.json` in your project root or `~/.claude.json` globally:
68
+
69
+ ```json
70
+ {
71
+ "mcpServers": {
72
+ "kuma": {
73
+ "command": "npx",
74
+ "args": ["-y", "@plumpslabs/kuma"]
75
+ }
76
+ }
77
+ }
78
+ ```
79
+
80
+ ---
81
+
82
+ ## 🟣 2. Google Antigravity (AGY) / Gemini CLI
83
+
84
+ ### Method A: Plugin Installation (System-Wide)
85
+ Install Kuma directly into your Antigravity plugins directory:
86
+
87
+ ```bash
88
+ # Clone to Antigravity global plugins
89
+ git clone https://github.com/plumpslabs/kuma.git ~/.gemini/config/plugins/kuma
90
+ ```
91
+ Or via AGY plugin command:
92
+ ```bash
93
+ agy plugin add https://github.com/plumpslabs/kuma
94
+ ```
95
+
96
+ Antigravity will automatically read `plugin.json`, mount the `kuma-mcp` skill, and launch Kuma via `mcp_config.json`.
97
+
98
+ ### Method B: Per-Project via `kuma init`
99
+ ```bash
100
+ npx @plumpslabs/kuma init --antigravity
101
+ ```
102
+
103
+ This creates:
104
+ - `.agents/skills/kuma/SKILL.md` β€” Core workflow skill.
105
+ - `.agents/rules/kuma.md` β€” Antigravity behavioral safety rules.
106
+ - `GEMINI.md` β€” Root workspace instructions.
107
+ - `.agents/mcp_config.json` β€” Preconfigured MCP server configuration.
108
+
109
+ ---
110
+
111
+ ## ⚑ 3. Cursor
112
+
113
+ Run inside your project:
114
+ ```bash
115
+ npx @plumpslabs/kuma init --cursor
116
+ ```
117
+
118
+ ### Files Created:
119
+ - `.cursor/rules/kuma.mdc` β€” Modern Cursor rule with XML delimiters and gotcha query triggers.
120
+ - `.cursorrules` β€” Fallback universal rule for all Cursor versions.
121
+
122
+ ### MCP Configuration:
123
+ Create or edit `.cursor/mcp.json` in your workspace or global settings:
124
+ ```json
125
+ {
126
+ "mcpServers": {
127
+ "kuma": {
128
+ "command": "npx",
129
+ "args": ["-y", "@plumpslabs/kuma"]
130
+ }
131
+ }
132
+ }
133
+ ```
134
+
135
+ ---
136
+
137
+ ## 🌊 4. Windsurf
138
+
139
+ Run:
140
+ ```bash
141
+ npx @plumpslabs/kuma init --windsurf
142
+ ```
143
+
144
+ ### Files Created:
145
+ - `.windsurfrules` β€” Cascade behavioral guidelines.
146
+ - `.windsurf/rules/kuma.md` β€” Detailed safety and gotcha workflow instructions.
147
+
148
+ ### MCP Configuration:
149
+ Add to `~/.codeium/windsurf/mcp_config.json`:
150
+ ```json
151
+ {
152
+ "mcpServers": {
153
+ "kuma": {
154
+ "command": "npx",
155
+ "args": ["-y", "@plumpslabs/kuma"]
156
+ }
157
+ }
158
+ }
159
+ ```
160
+
161
+ ---
162
+
163
+ ## πŸ”΅ 5. OpenCode
164
+
165
+ Run:
166
+ ```bash
167
+ npx @plumpslabs/kuma init --opencode
168
+ ```
169
+
170
+ ### Files Created:
171
+ - `AGENTS.md` β€” Shared agent instructions.
172
+ - `.opencode/plugins/kuma.js` β€” Native OpenCode plugin for pre-edit gotcha interception.
173
+ - `.opencode/skills/kuma/SKILL.md` β€” OpenCode skill with `kuma_kuma_*` prefixed actions.
174
+
175
+ ### MCP Configuration:
176
+ Add to `opencode.json` in your project root:
177
+ ```json
178
+ {
179
+ "$schema": "https://opencode.ai/config.json",
180
+ "mcp": {
181
+ "kuma": {
182
+ "type": "local",
183
+ "command": ["npx", "-y", "@plumpslabs/kuma"],
184
+ "enabled": true
185
+ }
186
+ }
187
+ }
188
+ ```
189
+ *(Note: OpenCode requires `command` to be an array containing the binary and its arguments together).*
190
+
191
+ ---
192
+
193
+ ## πŸ™ 6. GitHub Copilot Editor
194
+
195
+ Run:
196
+ ```bash
197
+ npx @plumpslabs/kuma init --copilot
198
+ ```
199
+
200
+ ### Files Created:
201
+ - `.github/copilot-instructions.md` β€” Workspace instructions for Copilot Chat.
202
+ - `.github/skills/kuma/SKILL.md` β€” Copilot skills definition.
203
+
204
+ ---
205
+
206
+ ## ⚑ 7. Zed
207
+
208
+ Add to your Zed `settings.json`:
209
+ ```json
210
+ {
211
+ "context_servers": {
212
+ "kuma": {
213
+ "command": "npx",
214
+ "args": ["-y", "@plumpslabs/kuma"]
215
+ }
216
+ }
217
+ }
218
+ ```
219
+
220
+ ---
221
+
222
+ ## πŸ›‘οΈ 8. Cline / Roo-Code / Trae
223
+
224
+ Run:
225
+ ```bash
226
+ npx @plumpslabs/kuma init --cline
227
+ ```
228
+
229
+ ### Files Created:
230
+ - `.clinerules/kuma.md`
231
+ - `.roo/rules/kuma.md`
232
+ - `.trae/rules/kuma.md`
233
+
234
+ Configure the MCP server via Cline's MCP Settings UI:
235
+ - **Server Name:** `kuma`
236
+ - **Command:** `npx`
237
+ - **Args:** `["-y", "@plumpslabs/kuma"]`
238
+
239
+ ---
240
+
241
+ ## 🍡 Companion Mode: Kuma + Matcha
242
+
243
+ Kuma works standalone, but if you use [Matcha](https://github.com/plumpslabs/matcha):
244
+ - **Matcha** handles the cognitive planning gate, stack audits, and code review.
245
+ - **Kuma** handles runtime safety, blast radius impact analysis, gotchas memory, and post-edit verification.
246
+
247
+ Install both in 1 line:
248
+ ```bash
249
+ curl -fsSL https://raw.githubusercontent.com/plumpslabs/matcha/main/install.sh | bash
250
+ curl -fsSL https://raw.githubusercontent.com/plumpslabs/kuma/main/install.sh | bash
251
+ ```
252
+
253
+ ---
254
+
255
+ ## πŸ“Š Kuma Studio Dashboard
256
+
257
+ To launch the web dashboard:
258
+ ```bash
259
+ npx @plumpslabs/kuma studio
260
+ ```
261
+ Access at `http://localhost:3322` to view:
262
+ - **Gotcha Shield** (filters, 1-click workaround copy)
263
+ - **Domain Sequence Flows**
264
+ - **Workspace & Blast Radius Simulator**
265
+ - **Health & Efficiency Metrics**
package/README.md CHANGED
@@ -31,55 +31,56 @@ Kuma is an MCP (Model Context Protocol) server that acts as a **pre-modification
31
31
 
32
32
  ## Quick Start
33
33
 
34
- ```bash
35
- # Run with npx (zero setup)
36
- npx -y @plumpslabs/kuma
34
+ ### ⚑ Universal 1-Liner (Auto-detects your IDE/Agent)
37
35
 
38
- # Or install globally
39
- npm install -g @plumpslabs/kuma
40
- kuma
36
+ ```bash
37
+ curl -fsSL https://raw.githubusercontent.com/plumpslabs/kuma/main/install.sh | bash
41
38
  ```
42
39
 
43
- Kuma auto-generates:
44
- - `.kuma/init.md` β€” Project-specific behavioral rules
45
- - `.kuma/kuma.db` β€” SQLite knowledge graph (WASM, zero native build)
46
- - `.skills/` β€” Skill files for common patterns
40
+ ### 🧩 Or Install as a Native Plugin
41
+
42
+ * **Claude Code Marketplace:**
43
+ ```bash
44
+ /plugin marketplace add plumpslabs/kuma
45
+ /plugin install kuma@plumpslabs-kuma
46
+ ```
47
+ * **Antigravity CLI (AGY):**
48
+ ```bash
49
+ agy plugin add https://github.com/plumpslabs/kuma
50
+ ```
51
+ * **Via NPX (Zero Install):**
52
+ ```bash
53
+ npx @plumpslabs/kuma init --all
54
+ ```
55
+
56
+ πŸ“– See [INSTALL.md](INSTALL.md) for the complete provider matrix (Cursor, Windsurf, OpenCode, Copilot, Zed, Cline, Aider, etc.).
47
57
 
48
58
  ---
49
59
 
50
60
  ## Core Architecture: 3 Pipeline-Driven Tools
51
61
 
52
- Kuma provides **3 coarse-grained tools** with impactful actions. Removed gimmick actions (add_node, feature, heal, harvest, session_mine, todo, context, benchmark, domain_rules, layers, noise_policy, lock, override, policy, contract, portability, doctor, gitignore, clean, progressive, sync, visualize, researches) are no longer documented.
62
+ Kuma exposes **3 coarse-grained tools** with **15 core actions** β€” the full agent surface. Anything else (impact, navigate, changes, digest, drift, resume, mine, session, delete_node, clear, goal_progress, check, audit, security, gc, ast, validate, gotcha_staleness) was **removed** β€” not hidden, gone β€” so the agent never has to choose from 30+ options and there is no dead surface to maintain.
53
63
 
54
64
  ### 🧠 `kuma_context` β€” Context & Research
55
65
 
56
66
  | Action | Purpose | Impact |
57
67
  |--------|---------|--------|
58
- | `init` | Lean project brief + restore session | πŸ”΄ Required first |
68
+ | `init` | Lean project brief + restore session + branch tracking | πŸ”΄ Required first |
59
69
  | `research` | 5-step pipeline: cache β†’ graph β†’ scan β†’ impact β†’ decision | πŸ”΄ Required before edits |
70
+ | `map` | Monorepo package topology & workspace boundary mapping | πŸ”΄ High |
71
+ | `impact` | Blast radius analysis: affected consumers & risk scoring | πŸ”΄ High |
60
72
  | `history` | Why is this file written this way (cross-session trace) | πŸ”΄ High |
61
- | `flow` | Hash-verified derived flow cache (F13) | πŸ”΄ High |
62
- | `impact` | Analyze change effects on related code | 🟑 Linear |
63
- | `navigate` | Trace code flow across files | 🟑 Linear |
64
- | `changes` | View change log for current session | 🟑 Linear |
65
- | `rollback` | Undo a specific change by ID | 🟑 Linear |
66
- | `digest` | Ultra-compact <500 token project briefing | 🟑 Linear |
67
- | `drift` | Detect memory staleness & code drift | 🟑 Linear |
68
- | `resume` | Load previous session context | 🟑 Linear |
73
+ | `flow` | Read a recorded architecture flow | πŸ”΄ High |
69
74
 
70
75
  ### πŸ’Ύ `kuma_memory` β€” Decision & Knowledge
71
76
 
72
77
  | Action | Purpose | Impact |
73
78
  |--------|---------|--------|
74
- | `gotcha` | Record bugs/quirks IMMEDIATELY | πŸ”΄ Exponential |
79
+ | `gotcha` | Record bugs/quirks + lifecycle (`active` β†’ `resolved` β†’ `deprecated`) | πŸ”΄ Exponential |
75
80
  | `arch_flow` | Record architecture flow (max 5 core files) | πŸ”΄ Exponential |
76
81
  | `decision` | Record ADR-style decision with rationale | πŸ”΄ Exponential |
77
82
  | `research_save` | Save research findings to cache | 🟑 Linear |
78
- | `mine` | Mine git history for hidden decisions | 🟑 Linear |
79
- | `session` | View session summary | 🟒 Skip |
80
- | `search` | Search knowledge graph | 🟑 Linear |
81
- | `delete_node` | Remove node/gotcha from graph + table | 🟑 Linear |
82
- | `goal_progress` | Track goal completion | 🟒 Skip |
83
+ | `search` | Quick lookup of memory + knowledge graph | 🟑 Linear |
83
84
 
84
85
  ### πŸ›‘οΈ `kuma_safety` β€” Safety & Verification
85
86
 
@@ -87,13 +88,8 @@ Kuma provides **3 coarse-grained tools** with impactful actions. Removed gimmick
87
88
  |--------|---------|--------|
88
89
  | `guard` | Detect anti-patterns, drift, runaway loops | πŸ”΄ Required |
89
90
  | `verify` | Auto-run scoped tests after edits | πŸ”΄ High |
90
- | `check` | Pre-execution safety check | 🟑 Linear |
91
- | `audit` | Query safety audit trail | 🟑 Linear |
92
- | `security` | Scan for leaked secrets/tokens | 🟑 Linear |
93
- | `gc` | Garbage collect stale data | 🟒 Skip |
94
- | `ast` / `validate` | AST-based code validation | 🟑 Linear |
95
- | `checkpoint` | Atomic snapshot before refactors | 🟑 Linear |
96
- | `rollback_label` | Restore from checkpoint | 🟑 Linear |
91
+ | `checkpoint` | Labeled snapshot before risky work | 🟑 Linear |
92
+ | `rollback_label` | Restore a labeled snapshot | 🟑 Linear |
97
93
 
98
94
  ---
99
95
 
@@ -103,11 +99,11 @@ Kuma exposes exactly **3 coarse-grained tools** β€” the agent picks an *action*,
103
99
 
104
100
  | Tool | Core Actions | Purpose |
105
101
  |------|--------------|---------|
106
- | `kuma_context` | `init`, `research`, `history` | Load project context, understand unfamiliar code |
107
- | `kuma_memory` | `gotcha`, `decision`, `arch_flow`, `research_save` | Persistent knowledge that saves future sessions |
108
- | `kuma_safety` | `guard`, `verify` | Pre-risk check, post-edit verification |
102
+ | `kuma_context` | `init`, `research`, `history`, `flow`, `map`, `impact` | Load project context, understand unfamiliar code |
103
+ | `kuma_memory` | `gotcha`, `decision`, `arch_flow`, `research_save`, `search` | Persistent knowledge that saves future sessions |
104
+ | `kuma_safety` | `guard`, `verify`, `checkpoint`, `rollback_label` | Pre-risk check, post-edit verification, snapshot/restore |
109
105
 
110
- Everything else is an internal action for power users. The agent uses its **own native tools** for editing, searching, and execution β€” Kuma is memory & safety, not a code manager.
106
+ Everything else is an internal action β€” not exposed to the agent. The agent uses its **own native tools** for editing, searching, and execution β€” Kuma is memory & safety, not a code manager.
111
107
 
112
108
  ### What Kuma Provides
113
109
 
@@ -122,15 +118,15 @@ Everything else is an internal action for power users. The agent uses its **own
122
118
 
123
119
  ## Kuma Studio
124
120
 
125
- Kuma Studio is a **web-based dashboard** for visualizing and managing your knowledge graph.
121
+ Kuma Studio is a **streamlined, modular web dashboard** for visualizing your codebase intelligence, gotchas shield, and workspace topology without visual clutter.
126
122
 
127
123
  ### Features
128
124
 
129
- - **πŸ“Š Knowledge Graph** β€” Interactive node-edge visualization with physics simulation
130
- - **⚠️ Gotchas** β€” Known bugs and quirks with severity levels
131
- - **⚑ Efficiency** β€” Session metrics, time saved, verification pass rates
132
- - **πŸͺ„ Injections** β€” Shadow-memory metrics: injection count + time saved (24h)
133
- - **πŸ“ˆ Staleness** β€” Detection of stale nodes with missing file references
125
+ - **πŸ›‘οΈ Gotcha Shield** β€” Filter gotchas by status (`active`, `verified`, `resolved`), severity, and copy workarounds in 1 click
126
+ - **πŸ”€ Domain Sequence Flows** β€” Linear architecture hops and execution sequences
127
+ - **πŸ“¦ Workspace & Blast Radius** β€” Monorepo package dependency matrix and real-time blast radius impact simulator
128
+ - **⚑ Health & Efficiency** β€” Session metrics, estimated hours saved, verification pass rates, and injection statistics
129
+ - **πŸ•ΈοΈ Calm Knowledge Graph** β€” Clean node-link visualization with optional physics simulation and depth controls
134
130
 
135
131
  ### Usage
136
132
 
@@ -205,10 +201,10 @@ A typical Kuma-powered session follows this flow:
205
201
  Record what was learned for future sessions
206
202
 
207
203
  6. VERIFY β†’ kuma_safety({ action: 'verify' })
208
- Auto-run scoped tests + AST validation
204
+ Auto-run scoped tests + validation
209
205
 
210
- 7. REVIEW β†’ kuma_context({ action: 'changes' })
211
- Review what was modified this session
206
+ 7. CHECKPOINT β†’ kuma_safety({ action: 'checkpoint', label: 'post-<feature>' })
207
+ Snapshot once stable β€” restore with rollback_label if needed
212
208
  ```
213
209
 
214
210
  ---
@@ -224,9 +220,8 @@ Kuma stores all context locally in `.kuma/`:
224
220
  β”œβ”€β”€ memory.json # Session state + metrics (auto)
225
221
  β”œβ”€β”€ auto-gotcha.json # Self-learning loop state (auto)
226
222
  β”œβ”€β”€ policy.yml # OPTIONAL safety policy β€” only read if you create it
227
- β”œβ”€β”€ memories/ # Memory layer markdown (decisions.md, arch_flow.md, ...)
223
+ β”œβ”€β”€ memories/ # Decision log markdown (decisions.md)
228
224
  β”œβ”€β”€ checkpoints/ # Atomic snapshots (label/ with kuma.db + files/)
229
- └── scratch/ # Temp debug artifacts (auto, ephemeral)
230
225
  ```
231
226
 
232
227
  > Hooks are registered in `.claude/settings.json` (PreToolUse) β€” not stored under `.kuma/`.
@@ -246,7 +241,7 @@ Kuma stores all context locally in `.kuma/`:
246
241
  | **Impact** | Agent doesn't know what's affected | Impact analysis traces dependencies |
247
242
  | **Coordination** | Multiple agents conflict | Per-agent session state + audit trail avoid collisions |
248
243
  | **Memory** | Agent repeats past mistakes | Decision memory + gotchas prevent loops |
249
- | **Reversibility** | Hard to undo changes | Checkpoint snapshots + selective undo |
244
+ | **Reversibility** | Hard to undo changes | Checkpoint snapshots + rollback_label |
250
245
  | **Staleness** | Knowledge becomes outdated | Drift detection + gotcha staleness checks flag stale data |
251
246
 
252
247
  ---