@crewpilot/agent 1.0.0 → 2.0.0

package/README.md

@@ -1,107 +1,131 @@
-# @crewpilot/agent
-
-Your AI dev crew — plans, architects, builds, tests, and ships software autonomously. **55+ MCP tools** and **16 domain skills** for every phase of software development.
-
-## Install
-
-```bash
-npm install @crewpilot/agent
-```
-
-On install, Catalyst automatically creates `.github/` files in your project so the **@Catalyst agent** appears in Copilot Chat's agent dropdown.
-
-## Usage
-
-### As an MCP Server (VS Code, Cursor, Claude Desktop)
-
-Add to `.vscode/mcp.json`:
-
-```json
-{
-  "servers": {
-    "crewpilot": {
-      "command": "npx",
-      "args": ["@crewpilot/agent"]
-    }
-  }
-}
-```
-
-For Claude Desktop (`claude_desktop_config.json`):
-
-```json
-{
-  "mcpServers": {
-    "crewpilot": {
-      "command": "npx",
-      "args": ["@crewpilot/agent"]
-    }
-  }
-}
-```
-
-### CLI Commands
-
-```bash
-npx @crewpilot/agent          # Start MCP server (stdio)
-npx @crewpilot/agent init     # Create .github/ files in current directory
-npx @crewpilot/agent --help   # Show usage
-```
-
-### Global Install
-
-```bash
-npm install -g @crewpilot/agent
-crewpilot          # Start MCP server
-crewpilot init     # Setup .github/ files
-```
-
-## What Gets Created
-
-On `npm install` (or `crewpilot init`), these files are created in your project:
-
-| File | Purpose |
-|---|---|
-| `.github/agents/catalyst.md` | Agent definition — enables @Catalyst in Copilot Chat |
-| `.github/copilot-instructions.md` | Project-level Copilot instructions |
-| `.github/catalyst.config.json` | Platform configuration (thresholds, board settings) |
-| `.github/skills/*/SKILL.md` | 16 domain skill files for on-demand skill loading |
-
-Existing files are never overwritten.
-
-## MCP Tools (55)
-
-| Module | Tools | Purpose |
-|---|---|---|
-| Terminal | 3 | Command execution and environment management |
-| Git | 6 | Branch, commit, diff, log, stage, status |
-| Knowledge | 9 | Persistent memory, search, semantic search, patterns |
-| Metrics | 3 | Code complexity, bundle size, coverage analysis |
-| Dispatch | 3 | Parallel execution, consensus, review workflows |
-| Board | 13 | Task management, sprint tracking, PR integration |
-| Orchestrator | 14 | Worker lifecycle, planning, branching, PR creation |
-| Notification | 3 | Email and messaging notifications |
-| Config | 1 | Runtime configuration management |
-
-## Skills (16)
-
-Organized across five engineering pillars:
-
-**Strategize** — Solution Design, Architecture Planner
-**Assure** — Code Quality, Vulnerability Scan, PR Intelligence
-**Engineer** — Feature Builder, Test-First, Root Cause Analysis
-**Deliver** — Change Management, Deploy Guard, Doc Governance
-**Insights** — Pattern Detection, Knowledge Base
-**Automation** — Autopilot Worker, Autopilot Meeting, Daily Digest
-
-## VS Code Extension
-
-For a richer experience with auto-start, agent switching, and automatic `.github/` syncing, install the [Catalyst VS Code Extension](https://marketplace.visualstudio.com/items?itemName=CrewPilot.crewpilot).
-
-## Requirements
-
-- Node.js 20+
-
-## License
-
-Proprietary — All rights reserved.
+# @crewpilot/agent
+
+Your AI dev crew — plans, architects, builds, tests, and ships software autonomously. **66+ MCP tools** and **19 domain skills** for every phase of software development.
+
+## Install
+
+```bash
+npm install @crewpilot/agent
+```
+
+On install, Catalyst automatically creates `.github/` files in your project so the **@Catalyst agent** appears in Copilot Chat's agent dropdown.
+
+## Usage
+
+### As an MCP Server (VS Code, Cursor, Claude Desktop)
+
+Add to `.vscode/mcp.json`:
+
+```json
+{
+  "servers": {
+    "crewpilot": {
+      "command": "npx",
+      "args": ["@crewpilot/agent"]
+    }
+  }
+}
+```
+
+For Claude Desktop (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "crewpilot": {
+      "command": "npx",
+      "args": ["@crewpilot/agent"]
+    }
+  }
+}
+```
+
+### CLI Commands
+
+```bash
+npx @crewpilot/agent          # Start MCP server (stdio)
+npx @crewpilot/agent init     # Create .github/ files in current directory
+npx @crewpilot/agent --help   # Show usage
+```
+
+### Global Install
+
+```bash
+npm install -g @crewpilot/agent
+crewpilot          # Start MCP server
+crewpilot init     # Setup .github/ files
+```
+
+## What Gets Created
+
+On `npm install` (or `crewpilot init`), these files are created in your project:
+
+| File | Purpose |
+|---|---|
+| `.github/agents/catalyst.md` | Agent definition — enables @Catalyst in Copilot Chat |
+| `.github/copilot-instructions.md` | Project-level Copilot instructions |
+| `.github/catalyst.config.json` | Platform configuration (thresholds, board settings) |
+| `.github/skills/*/SKILL.md` | 19 domain skill files for on-demand skill loading |
+
+Existing files are never overwritten.
+
+## MCP Tools (66)
+
+| Module | Tools | Purpose |
+|---|---|---|
+| Terminal | 3 | Command execution and environment management |
+| Git | 6 | Branch, commit, diff, log, stage, status |
+| Knowledge | 9 | Persistent memory, search, semantic search, patterns |
+| Metrics | 3 | Code complexity, bundle size, coverage analysis |
+| Dispatch | 4 | Parallel execution, consensus, review workflows, subagent delegation |
+| Board | 14 | Task management, sprint tracking, PR integration |
+| Orchestrator | 14 | Worker lifecycle, planning, branching, PR creation |
+| Notification | 3 | Email and messaging notifications |
+| Artifacts | 3 | Phase-based artifact persistence for workflow communication |
+| Sessions | 3 | Session save/restore for resuming long-running workflows |
+| Work IQ | 3 | M365 integration — emails, meetings, docs, Teams (optional) |
+| Config | 1 | Runtime configuration management |
+
+## Skills (19)
+
+Organized across five engineering pillars:
+
+**Strategize** — Solution Design, Architecture Planner
+**Assure** — Code Quality, Review Functional, Review Standards, Threat Model, Vulnerability Scan, PR Intelligence
+**Engineer** — Feature Builder, Test-First, Root Cause Analysis
+**Deliver** — Change Management, Deploy Guard, Doc Governance
+**Insights** — Pattern Detection, Knowledge Base
+**Automation** — Autopilot Worker, Autopilot Meeting, Daily Digest
+
+## VS Code Extension
+
+For a richer experience with auto-start, agent switching, and automatic `.github/` syncing, install the [Catalyst VS Code Extension](https://marketplace.visualstudio.com/items?itemName=CrewPilot.crewpilot).
+
+## Work IQ — M365 Integration (Optional)
+
+To enable M365 integration (emails, meetings, documents, Teams), add the Work IQ MCP server alongside CrewPilot in your `.vscode/mcp.json`:
+
+```json
+{
+  "servers": {
+    "crewpilot": {
+      "command": "npx",
+      "args": ["@crewpilot/agent"]
+    },
+    "workiq": {
+      "command": "npx",
+      "args": ["-y", "@microsoft/workiq@latest", "mcp"]
+    }
+  }
+}
+```
+
+Requires a Microsoft 365 Copilot license. Work IQ is entirely optional — all workflows gracefully degrade without it. See the [full setup guide](https://github.com/amanraj-ms/catalyst#work-iq-setup-m365-integration).
+
+## Requirements
+
+- Node.js 20+
+
+## License
+
+Proprietary — All rights reserved.