bobs-workshop 0.2.2 → 0.2.5

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/Claude.md ADDED
@@ -0,0 +1,105 @@
1
+ # Bob's Workshop - Claude Code Integration Guide
2
+
3
+ ## Critical: How Bob's Workshop Works
4
+
5
+ **You (Claude Code) ARE the orchestrator** - there is NO separate orchestrator service. When you use Bob's tools, YOU execute the workflow steps directly.
6
+
7
+ ### Execution Model
8
+
9
+ 1. **Mode Switching**: When `bob.workshop` classifies a problem, YOU switch modes within the same conversation:
10
+ - orchestrator → architect → engineer → debugger → reviewer
11
+
12
+ 2. **Direct Execution**: When you "switch to architect mode", YOU read the ARCHITECT_PROMPT and execute those steps. There is NO delegation.
13
+
14
+ 3. **Tool Preference**: When working in Bob mode, **ALWAYS prefer Bob's MCP tools** over native Claude Code tools:
15
+ - Use `bob.code.search` instead of `Grep` or `Glob`
16
+ - Use `bob.workflow.start` instead of manual git operations
17
+ - Use `bob.manual.update` instead of creating separate markdown files
18
+
19
+ ### The MANUAL: Single Source of Truth
20
+
21
+ **CRITICAL RULE**: DO NOT create separate markdown files for documentation or progress tracking.
22
+
23
+ - All specifications, logs, and progress MUST be stored in `.bob/specs/SPEC-*.json` files
24
+ - Use `bob.manual.update` with `execution_log` or `debug_log` parameters
25
+ - The dashboard reads directly from SPEC files - no separate updates needed
26
+
27
+ ### Mode-Specific Tool Usage
28
+
29
+ **Architect Mode**:
30
+ - `bob.workflow.start` - Creates manual + worktree + launches dashboard
31
+ - `bob.manual.update` - Populates spec sections
32
+ - `bob.code.search` with `phase=architect` - Architecture analysis
33
+
34
+ **Engineer Mode**:
35
+ - `bob.manual.update` with `execution_log` - Log task completion
36
+ - `bob.code.search` with `phase=engineer` - Symbol lookups
37
+ - `bob.workflow.deploy` - Commit, merge, cleanup
38
+
39
+ **Debugger Mode**:
40
+ - `bob.manual.update` with `debug_log` - Log findings
41
+ - `bob.code.search` with `phase=debugger` - Security analysis
42
+ - `bob.worktree.debug` - Fix worktree issues
43
+
44
+ **Reviewer Mode**:
45
+ - `bob.validate_changes` - Check compliance
46
+ - `bob.summarize_implementation` - Generate summaries
47
+ - `bob.code.search` with `phase=reviewer` - Quality analysis
48
+
49
+ ### Code Search Best Practices
50
+
51
+ Always use `bob.code.search` with the `phase` parameter:
52
+
53
+ ```javascript
54
+ // ❌ WRONG - Using native Claude Code tools
55
+ Grep("pattern", { output_mode: "content" })
56
+
57
+ // ✅ CORRECT - Using Bob's tools
58
+ bob.code.search({
59
+ query: "pattern",
60
+ phase: "engineer", // architect | engineer | debugger | reviewer
61
+ mode: "auto" // auto | semantic | lexical
62
+ })
63
+ ```
64
+
65
+ ### Common Pitfalls to Avoid
66
+
67
+ 1. **Creating separate markdown files** - Everything goes in the MANUAL via `bob.manual.update`
68
+ 2. **Using native Grep/Glob** - Use `bob.code.search` instead for phase-aware analysis
69
+ 3. **Manual git operations** - Use `bob.workflow.start` and `bob.workflow.deploy`
70
+ 4. **Forgetting execution logs** - Always log progress with `bob.manual.update`
71
+ 5. **Not using phase parameter** - Always specify `phase` in `bob.code.search`
72
+
73
+ ### Workflow Pattern
74
+
75
+ When user says "hey bob" or starts a new feature:
76
+
77
+ 1. Call `bob.workshop` to classify the problem
78
+ 2. Switch to the returned mode (e.g., "architect")
79
+ 3. Execute the appropriate workflow:
80
+ - Architect: `bob.workflow.start` → plan → `bob.manual.update`
81
+ - Engineer: implement → `bob.manual.update` with `execution_log` → `bob.workflow.deploy`
82
+ - Debugger: analyze → `bob.manual.update` with `debug_log`
83
+ - Reviewer: validate → `bob.validate_changes` → `bob.summarize_implementation`
84
+
85
+ ### Manual Section Responsibilities
86
+
87
+ **Architect creates**:
88
+ - executive_summary
89
+ - product_specifications
90
+ - architecture_analysis
91
+ - implementation_plan
92
+ - testing
93
+
94
+ **Engineer updates**:
95
+ - execution_logs (via `bob.manual.update`)
96
+
97
+ **Debugger updates**:
98
+ - debug_logs (via `bob.manual.update`)
99
+
100
+ **Reviewer creates**:
101
+ - Own review manual with improvement recommendations
102
+
103
+ ---
104
+
105
+ **Remember**: The manifest is available at `mcp://bobs-workshop/manifest` but you must follow these patterns automatically - don't wait for the user to remind you.
package/README.md CHANGED
@@ -126,35 +126,57 @@ And watch the magic unfold:
126
126
  ### Manual installation
127
127
 
128
128
  ```bash
129
- # Install globally from npm
129
+ # 1. Install search tool dependencies (REQUIRED)
130
+ # macOS:
131
+ brew install semgrep ripgrep
132
+
133
+ # Linux:
134
+ pip3 install semgrep && apt install ripgrep # Debian/Ubuntu
135
+ pip3 install semgrep && yum install ripgrep # RHEL/CentOS
136
+
137
+ # 2. Install bobs-workshop globally
130
138
  npm install -g bobs-workshop
131
139
 
132
- # Register with Claude Code (project scope)
140
+ # 3. Register with Claude Code (project scope recommended)
133
141
  claude mcp add bobs-workshop bobs-mcp --scope project
134
142
 
135
143
  # Or register globally
136
144
  claude mcp add bobs-workshop bobs-mcp --scope global
137
145
 
138
- # Launch dashboard
146
+ # 4. Launch dashboard
139
147
  bobs workshop
140
148
  ```
141
149
 
150
+ **Important:** Search tools (semgrep & ripgrep) must be installed **before** using Bob's MCP. The package will attempt to auto-install semgrep during `npm install`, but manual installation is more reliable.
151
+
142
152
  After installation, the `bobs` command will be available globally. The package will automatically:
143
- - Build the TypeScript source
144
- - Install search tools (ripgrep)
145
153
  - Initialize the workspace structure
154
+ - Verify search tools are available
146
155
 
147
156
  ### Verify Installation
148
157
 
149
- Check that the MCP server is connected:
158
+ Check that everything is properly configured:
150
159
  ```bash
151
- # In Claude Code, run:
152
- /mcp
160
+ # 1. Verify search tools
161
+ semgrep --version # Should show semgrep version
162
+ rg --version # Should show ripgrep version
153
163
 
164
+ # 2. Check MCP server connection in Claude Code
165
+ /mcp
154
166
  # You should see "bobs-workshop" as ✔ connected
167
+
168
+ # 3. Verify manifest is loaded (in Claude Code)
169
+ # The manifest provides critical LLM guidance for tool usage
170
+ # Ask Claude: "Can you read the bobs-workshop manifest?"
155
171
  ```
156
172
 
157
- The manifest with LLM guidance is available at resource URI `mcp://bobs-workshop/manifest` and provides tool selection optimization.
173
+ **Troubleshooting:** If Claude Code doesn't follow Bob's workflow patterns religiously:
174
+ 1. Ensure search tools are installed: `semgrep --version && rg --version`
175
+ 2. Restart Claude Code to reload the MCP server
176
+ 3. Verify manifest resource is accessible: Ask Claude to read `mcp://bobs-workshop/manifest`
177
+ 4. Check `.mcp.json` uses `bobs-mcp` command (not local path)
178
+
179
+ The manifest with LLM guidance is available at resource URI `mcp://bobs-workshop/manifest` and provides tool selection optimization and workflow instructions.
158
180
 
159
181
  See the documentation for advanced setup and configuration options.
160
182
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bobs-workshop",
3
- "version": "0.2.2",
3
+ "version": "0.2.5",
4
4
  "description": "Bob's Workshop — agentic development helper with observability, guard rails, research, and review capabilities",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -78,6 +78,7 @@
78
78
  "scripts/**/*",
79
79
  "public/**/*",
80
80
  "README.md",
81
- "LICENSE"
81
+ "LICENSE",
82
+ "Claude.md"
82
83
  ]
83
84
  }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bobs-workshop",
3
- "version": "0.2.0",
3
+ "version": "0.2.3",
4
4
  "description": "Streamlined MCP orchestrator with workflow-driven API, consolidated git/worktree operations, and structured observability",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",