workspace-maxxing 0.4.0 → 0.6.0

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.
Files changed (3) hide show
  1. package/README.md +166 -186
  2. package/package.json +1 -1
  3. package/templates/SKILL.md +56 -17
package/README.md CHANGED
@@ -1,186 +1,166 @@
1
- # workspace-maxxing
2
-
3
- An AI agent skill that builds ICM-compliant workspaces with invokable agents. The skill runs **inside your AI agent** and creates workspaces + agents on demand.
4
-
5
- ## The Flow
6
-
7
- ```
8
- 1. Install: npx workspace-maxxing install
9
- 2. Invoke in AI: @workspace-maxxing
10
- 3. Ask: "Create a daily digest workspace"
11
- 4. Skill builds: workspace + @daily-digest agent
12
- ```
13
-
14
- ## Quick Start
15
-
16
- ```bash
17
- # Step 1: Install the skill to your project
18
- npx workspace-maxxing install
19
-
20
- # Step 2: In your AI agent, invoke the skill
21
- @workspace-maxxing
22
-
23
- # Step 3: Ask it to create something
24
- "Create a workspace for my daily news aggregator"
25
- ```
26
-
27
- The skill will then:
28
- - Research your request
29
- - Design the workspace architecture
30
- - Build the ICM folder structure
31
- - Create an invokable agent inside
32
- - Run self-improvement on the agent
33
- - Deliver the complete workspace
34
-
35
- ## What Gets Created
36
-
37
- When you ask `@workspace-maxxing` to create a workspace for "Daily Digest":
38
-
39
- ```
40
- my-workspace/
41
- ├── .agents/skills/daily-digest/ ← Invokable with @daily-digest
42
- │ ├── SKILL.md
43
- │ └── prompts/
44
- ├── 01-input/
45
- ├── 02-process/
46
- ├── 03-output/
47
- ├── SYSTEM.md
48
- └── CONTEXT.md
49
- ```
50
-
51
- Now you can use `@daily-digest` to run that workflow!
52
-
53
- ## Commands
54
-
55
- | Command | What It Does |
56
- |---------|-------------|
57
- | `npx workspace-maxxing install` | Install skill to current project |
58
- | `@workspace-maxxing` | Invoke in your AI agent |
59
- | `npx workspace-maxxing --opencode` | Install for specific platform |
60
- | `--stages` | "01-input,02-process,03-output" | Comma-separated stage names |
61
- | `--output` | "./workspace" | Output directory |
62
- | `--agent-name` | auto-generated (@workspace-name) | Custom agent name |
63
- | `--no-agent` | false | Create workspace without agent |
64
- | `--threshold` | 85 | Robustness threshold for agent iteration |
65
- | `--max-iterations` | 3 | Max improvement cycles |
66
-
67
- ## What Gets Installed
68
-
69
- - `SKILL.md` (entry behavior and phase logic)
70
- - `.workspace-templates/` (SYSTEM/CONTEXT templates and scripts)
71
- - `scripts/` (scaffold, validate, dispatch, orchestrator, benchmark, etc.)
72
-
73
- ## Agent Creation Workflow
74
-
75
- When you invoke `workspace-maxxing` with a request to create an agent (e.g., "create a daily digest agent"):
76
-
77
- 1. **Parse the request** - Extract the agent purpose (e.g., "Daily Digest")
78
- 2. **Create ICM workspace** - SYSTEM.md, CONTEXT.md, stage folders
79
- 3. **Create invokable agent** - In `.agents/skills/@<purpose>/`
80
- 4. **Run self-improvement loop**:
81
- - Generate test cases (edge, empty, varied inputs)
82
- - Validate agent handling
83
- - Score robustness (0-100)
84
- - If score < 85: improve prompts, retry
85
- - Repeat until score >= 85 or max iterations (3)
86
- 5. **Install agent** for platform (OpenCode/Claude/Copilot/Gemini)
87
- 6. **Deliver** workspace with robust agent
88
-
89
- ### Invoking the Created Agent
90
-
91
- After workspace is created, use `@` followed by the agent name:
92
-
93
- - **OpenCode**: `@daily-digest`
94
- - **Claude Code**: Via `.claude/skills/` directory
95
- - **Copilot**: Via `.github/copilot-instructions/`
96
- - **Gemini**: Via `.gemini/skills/` directory
97
-
98
- ## Workflow Model
99
-
100
- The skill follows a phased flow:
101
-
102
- 1. Research
103
- 2. Architecture
104
- 3. Build (scaffold workspace)
105
- 4. Validate
106
- 5. Autonomous iteration (batched worker/fixer loops)
107
- 6. Deliver
108
-
109
- This is designed to keep prompt structure, execution order, and handoffs explicit.
110
-
111
- ## Sub-Agent Runner Contract
112
-
113
- Worker/fixer execution is external-runner-driven in strict mode. Configure orchestrator with `--subagent-runner` (or `WORKSPACE_MAXXING_SUBAGENT_RUNNER`) using placeholders:
114
-
115
- ```bash
116
- node scripts/orchestrator.ts --workspace ./workspace --subagent-runner "<runner-command> {skill} {workspace} {batchId} {testCaseId}"
117
- ```
118
-
119
- Contract details:
120
-
121
- - `worker/fixer` require an external runner command.
122
- - Runner output must be JSON containing: `skill`, `status`, `timestamp`, `findings`, `recommendations`, `metrics`, `nextSkill`.
123
- - Missing/invalid payloads are treated as failures (no simulated completion).
124
- - Telemetry is written under `.agents/iteration/runs/` for troubleshooting.
125
-
126
- ## Included Script Surface
127
-
128
- Run these from the installed skill directory (for example, `.agents/skills/workspace-maxxing/` in OpenCode).
129
-
130
- | Script | Purpose | Example |
131
- |---|---|---|
132
- | `scaffold.ts` | Create an ICM workspace from a stage plan | `node scripts/scaffold.ts --name "my-flow" --stages "01-input,02-process,03-output" --output ./workspace` |
133
- | `validate.ts` | Validate workspace structure and routing rules | `node scripts/validate.ts --workspace ./workspace` |
134
- | `generate-tests.ts` | Generate stage-based test cases | `node scripts/generate-tests.ts --workspace ./workspace --output ./tests.json` |
135
- | `dispatch.ts` | Dispatch sub-skills (single or parallel) | `node scripts/dispatch.ts --skill research --workspace ./workspace` |
136
- | `orchestrator.ts` | Run batched autonomous iteration | `node scripts/orchestrator.ts --workspace ./workspace --batch-size 3 --score-threshold 85 --subagent-runner "<runner>"` |
137
- | `benchmark.ts` | Compute weighted benchmark score | `node scripts/benchmark.ts --workspace ./workspace` |
138
- | `install-tool.ts` | Install a tool and update inventory | `node scripts/install-tool.ts --tool "pdf-lib" --manager npm --workspace ./workspace` |
139
- | `iterate.ts` | Legacy single-loop iteration path | `node scripts/iterate.ts --workspace ./workspace --max-retries 3` |
140
-
141
- ## ICM Layers
142
-
143
- Based on the Interpretable Context Methodology (ICM):
144
-
145
- - Layer 0: `SYSTEM.md` (global rules)
146
- - Layer 1: root `CONTEXT.md` (routing)
147
- - Layer 2: stage `CONTEXT.md` files (contracts)
148
- - Layer 3: selective task artifacts
149
-
150
- Reference: [Interpretable Context Methodology paper](https://arxiv.org/abs/2603.16021)
151
-
152
- ## Local Development
153
-
154
- ```bash
155
- npm install
156
- npm run build
157
- npm test
158
- ```
159
-
160
- ## Project Layout
161
-
162
- ```
163
- workspace-maxxing/
164
- ├── src/
165
- │ ├── index.ts # CLI entry point
166
- │ ├── install.ts # Skill installation
167
- │ ├── agent-creator.ts # Agent creation
168
- │ ├── agent-iterator.ts # Agent self-improvement
169
- │ ├── platforms/ # Platform installers
170
- │ └── scripts/ # Core scripts
171
- ├── templates/
172
- │ ├── SKILL.md # Main skill definition
173
- │ └── .workspace-templates/ # Workspace templates
174
- └── tests/
175
- ```
176
-
177
- ## Contributing
178
-
179
- 1. Fork and create a feature branch.
180
- 2. Add or update tests for behavior changes.
181
- 3. Run `npm run build` and `npm test`.
182
- 4. Open a PR with context on workflow impact.
183
-
184
- ## License
185
-
186
- MIT License - see [LICENSE](LICENSE) file for details.
1
+ # workspace-maxxing
2
+
3
+ <p align="center">
4
+ <a href="https://www.npmjs.com/package/workspace-maxxing">
5
+ <img src="https://img.shields.io/npm/v/workspace-maxxing?style=flat&color=blue" alt="npm version">
6
+ </a>
7
+ <a href="https://github.com/ericjdz/workflow-maxxing/blob/master/LICENSE">
8
+ <img src="https://img.shields.io/npm/l/workspace-maxxing?style=flat&color=green" alt="MIT License">
9
+ </a>
10
+ <a href="https://github.com/ericjdz/workflow-maxxing">
11
+ <img src="https://img.shields.io/github/stars/ericjdz/workflow-maxxing?style=flat" alt="GitHub stars">
12
+ </a>
13
+ </p>
14
+
15
+ > An AI agent skill that builds ICM-compliant workspaces with invokable sub-agents. One command, complete workflow automation.
16
+
17
+ ## Why workspace-maxxing?
18
+
19
+ Most AI agent workspaces are disorganized—context is scattered, prompts are vague, and workflows lack structure. **workspace-maxxing** solves this by:
20
+
21
+ - **Creating structured workspaces** with ICM methodology (SYSTEM.md, CONTEXT.md, stage folders)
22
+ - **Building autonomous agents** that you can invoke with `@agent-name`
23
+ - **Self-improving agents** that validate and iterate until robust
24
+ - **Automatic tool discovery** - checks available tools, installs missing ones
25
+
26
+ ## Quick Start
27
+
28
+ ```bash
29
+ # 1. Install the skill to your project
30
+ npx workspace-maxxing install
31
+
32
+ # 2. In your AI agent, invoke the skill
33
+ @workspace-maxxing
34
+
35
+ # 3. Ask it to create something
36
+ "Create a workspace for lead scraping"
37
+ ```
38
+
39
+ The skill does everything else—creates folder structure, builds the agent, verifies tools, runs self-improvement.
40
+
41
+ ## What You Get
42
+
43
+ When you ask for a "lead scraping" workspace:
44
+
45
+ ```
46
+ lead-scraper/
47
+ ├── .agents/skills/lead-scraper/ ← Invokable with @lead-scraper
48
+ │ ├── SKILL.md
49
+ │ ├── prompts/
50
+ │ └── config.json
51
+ ├── 01-input/ ← Stage 1: Input
52
+ ├── 02-process/ ← Stage 2: Processing
53
+ ├── 03-output/ ← Stage 3: Output
54
+ ├── 00-meta/ ← Metadata & tools
55
+ ├── SYSTEM.md ← Global rules
56
+ └── CONTEXT.md ← Routing
57
+ ```
58
+
59
+ Now use `@lead-scraper` to run that workflow anytime.
60
+
61
+ ## Features
62
+
63
+ ### 🎯 Agent Creation
64
+ - Create invokable agents for any workflow
65
+ - Agents self-improve until score 85
66
+ - Built-in test case generation & validation
67
+
68
+ ### 🔧 Automatic Tool Discovery
69
+ - Checks what native tools your AI agent has
70
+ - Verifies tool accessibility with test runs
71
+ - Installs missing MCPs or CLI tools automatically
72
+
73
+ ### 📁 ICM Workspace Structure
74
+ - SYSTEM.md (global rules)
75
+ - CONTEXT.md (routing)
76
+ - Numbered stage folders (01-input, 02-process, 03-output)
77
+ - 00-meta for tools & execution logs
78
+
79
+ ### 🔄 Multi-Platform Support
80
+
81
+ | Platform | Installation |
82
+ |----------|--------------|
83
+ | OpenCode | `npx workspace-maxxing install` |
84
+ | Claude Code | `npx workspace-maxxing --claude` |
85
+ | GitHub Copilot | `npx workspace-maxxing --copilot` |
86
+ | Gemini CLI | `npx workspace-maxxing --gemini` |
87
+
88
+ ## Commands
89
+
90
+ ### CLI Commands
91
+
92
+ ```bash
93
+ # Install the skill
94
+ npx workspace-maxxing install
95
+
96
+ # Install for specific platform
97
+ npx workspace-maxxing --opencode
98
+
99
+ # Legacy commands (still work)
100
+ npx workspace-maxxing init
101
+ npx workspace-maxxing --create-workspace --workspace-name "My Project"
102
+ ```
103
+
104
+ ### In Your AI Agent
105
+
106
+ When you invoke `@workspace-maxxing`, you can ask:
107
+
108
+ | Request | Action |
109
+ |---------|--------|
110
+ | `"Build a workspace for X"` | Creates ICM workspace |
111
+ | `"Create an agent for Y"` | Creates invokable @agent |
112
+ | `"Validate my workspace"` | Checks ICM compliance |
113
+ | `"Improve my workspace"` | Runs autonomous iteration |
114
+ | `"Add tools for Z"` | Installs required tools |
115
+
116
+ ## Architecture
117
+
118
+ ```
119
+ ┌─────────────────────────────────────────────────────┐
120
+ │ @workspace-maxxing (invoked by user) │
121
+ ├─────────────────────────────────────────────────────┤
122
+ 1. RESEARCH → Analyze the request │
123
+ 2. TOOLING → Discover & install tools │
124
+ 3. ARCHITECTURE Design workspace structure │
125
+ │ 4. BUILD → Create ICM folders & files │
126
+ 5. AGENT → Build invokable @agent │
127
+ │ 6. ITERATE → Self-improve until robust │
128
+ 7. DELIVER → Complete workspace + agent │
129
+ └─────────────────────────────────────────────────────┘
130
+ ```
131
+
132
+ ## What's Inside
133
+
134
+ | File/Folder | Purpose |
135
+ |-------------|---------|
136
+ | `SKILL.md` | Main skill definition |
137
+ | `skills/` | Sub-skills (research, architecture, tooling, etc.) |
138
+ | `scripts/` | Executable scripts (scaffold, validate, dispatch) |
139
+ | `.workspace-templates/` | ICM workspace templates |
140
+
141
+ ## The Iron Law
142
+
143
+ ```
144
+ NO BUILD WITHOUT PLAN
145
+ NO PLAN WITHOUT RESEARCH
146
+ NO TOOL DISCOVERY BEFORE AGENT DELIVERY
147
+ NO IMPROVEMENT WITHOUT VALIDATION
148
+ ```
149
+
150
+ ## Requirements
151
+
152
+ - Node.js 18+
153
+ - npm or yarn
154
+ - An AI agent (OpenCode, Claude, Copilot, or Gemini)
155
+
156
+ ## Contributing
157
+
158
+ Contributions welcome! Please read the [contributing guide](CONTRIBUTING.md) first.
159
+
160
+ ## License
161
+
162
+ MIT © [Eric Julian Deguzman](https://github.com/ericjdz)
163
+
164
+ ---
165
+
166
+ <p align="center">Made with 🚀 by the workspace-maxxing team</p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "workspace-maxxing",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "description": "npx-installable skill for AI agents to create structured workspaces using ICM methodology",
5
5
  "bin": {
6
6
  "workspace-maxxing": "dist/index.js"
@@ -36,6 +36,33 @@ When you invoke `@workspace-maxxing`, you can ask:
36
36
  | "Improve my workspace" | Runs autonomous iteration |
37
37
  | "Add tools for Z" | Uses tooling sub-skill to install tools |
38
38
 
39
+ **IMPORTANT - Tool Discovery Before Agent Delivery:**
40
+
41
+ When creating ANY agent, ALWAYS do this FIRST:
42
+
43
+ 1. **Check native tools** - What capabilities does the AI agent already have?
44
+ - Playwright, puppeteer for browser automation?
45
+ - Curl, wget for HTTP requests?
46
+ - File system access?
47
+ - Database connections?
48
+
49
+ 2. **Verify tool accessibility** - Run a simple test to confirm tools work:
50
+ ```
51
+ Test: Can you make a simple HTTP request?
52
+ Test: Can you list files in the current directory?
53
+ Test: Can you execute a simple script?
54
+ ```
55
+
56
+ 3. **Install missing tools** - If native tools are insufficient:
57
+ - Use `/skill tooling` to install MCP servers
58
+ - Use `npm install` for CLI tools
59
+ - Document installed tools in `00-meta/tools.md`
60
+
61
+ 4. **Include tool instructions in agent prompts** - The created agent must know:
62
+ - What tools are available
63
+ - How to use them
64
+ - Any rate limits or constraints
65
+
39
66
  The skill will then execute the appropriate phases internally.
40
67
 
41
68
  ## Tool Discovery & Agent Harness
@@ -106,40 +133,51 @@ This skill provides a complete agent development harness:
106
133
 
107
134
  ## Agent Creation Workflow
108
135
 
109
- When you invoke `workspace-maxxing` with a request to create an agent (e.g., "create a daily digest agent"), follow this flow:
136
+ When you invoke `workspace-maxxing` with a request to create an agent (e.g., "create a lead scraping agent"), follow this flow:
110
137
 
111
138
  ```
112
- 1. Parse the request to extract the agent purpose (e.g., "Daily Digest")
113
- 2. Create ICM workspace structure (SYSTEM.md, CONTEXT.md, stage folders)
114
- 3. Create invokable agent in .agents/skills/@<purpose>/
115
- 4. Run self-improvement loop on the agent
139
+ 1. Parse the request to extract the agent purpose (e.g., "Lead Scraper")
140
+ 2. DISCOVER TOOLS:
141
+ - Check what native tools are available in the AI agent (playwright, puppeteer, curl, etc.)
142
+ - Verify tool accessibility by running a simple test
143
+ - If native tools are insufficient, use tooling sub-skill to install MCPs or CLI tools
144
+ - Document tools in 00-meta/tools.md
145
+ 3. Create ICM workspace structure (SYSTEM.md, CONTEXT.md, stage folders)
146
+ 4. Create invokable agent in .agents/skills/@<purpose>/
147
+ - Include tool usage instructions in the agent prompts
148
+ 5. Run self-improvement loop on the agent
116
149
  - Generate test cases (edge, empty, varied inputs)
117
150
  - Validate agent handling
118
151
  - Score robustness (0-100)
119
152
  - If score < 85: improve prompts, retry
120
153
  - Repeat until score >= 85 or max iterations (3)
121
- 5. Install agent for platform (OpenCode/Claude/Copilot/Gemini)
122
- 6. Deliver workspace with robust agent
154
+ 6. Install agent for platform (OpenCode/Claude/Copilot/Gemini)
155
+ 7. Deliver workspace with robust agent
123
156
  ```
124
157
 
125
- ### Agent Creation Example
158
+ ### Agent Creation with Tool Discovery Example
126
159
 
127
- User: "Create a daily digest agent"
160
+ User: "Create an agent that scrapes internet data for leads"
128
161
 
129
162
  ```
130
- -> Extract purpose: "Daily Digest"
131
- -> DISCOVER TOOLS: Use /skill tooling to find relevant tools (e.g., RSS, web scraping, summarization)
163
+ -> Extract purpose: "Lead Scraper"
164
+ -> DISCOVER TOOLS:
165
+ - Check: Does agent have playwright? → Yes, test it works
166
+ - Check: Does agent have curl/wget? → Yes, verify accessible
167
+ - Check: Any MCP servers for scraping? → No, need to install
168
+ - Action: Run tooling sub-skill to install puppeteer or similar
169
+ - Verify: Test the tool with a simple request
132
170
  -> Create workspace with stages: 01-input, 02-process, 03-output
133
- -> Create agent: @daily-digest in .agents/skills/daily-digest/
171
+ -> Create agent: @lead-scraper with tool instructions in prompts
134
172
  -> Run iteration:
135
- - Test: empty input -> fix prompts
136
- - Test: special chars -> fix prompts
137
- - Test: normal input -> validate
173
+ - Test: scraping a page -> works
174
+ - Test: handling empty pages -> handles gracefully
175
+ - Test: rate limiting -> respects limits
138
176
  - Score >= 85? Yes -> deliver
139
- -> Agent is ready to invoke with @daily-digest
177
+ -> Agent is ready to invoke with @lead-scraper
140
178
  ```
141
179
 
142
- **Key**: Always look for and leverage tools when creating agents or workspaces.
180
+ **Tool Discovery is MANDATORY** - always check available tools, verify accessibility, and install missing tools before delivering the agent.
143
181
 
144
182
  ## When Not to Use
145
183
 
@@ -151,6 +189,7 @@ User: "Create a daily digest agent"
151
189
 
152
190
  NO BUILD WITHOUT PLAN
153
191
  NO PLAN WITHOUT RESEARCH
192
+ NO TOOL DISCOVERY BEFORE AGENT DELIVERY
154
193
  NO IMPROVEMENT WITHOUT VALIDATION
155
194
  NO COMPLETION CLAIM WITHOUT VERIFICATION
156
195
  NO PRODUCT IMPLEMENTATION INSIDE WORKSPACE BUILDING MODE