harmony-mcp 1.3.2 → 1.3.3

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 CHANGED
@@ -16,46 +16,37 @@ MCP (Model Context Protocol) server for Harmony Kanban board. Enables AI coding
16
16
 
17
17
  ## Quick Start
18
18
 
19
- ### 1. Install
20
-
21
- ```bash
22
- npm install -g harmony-mcp
23
- ```
24
-
25
- ### 2. Generate an API Key
19
+ ### 1. Generate an API Key
26
20
 
27
21
  1. Log into [Harmony](https://gethmy.com)
28
- 2. Go to **Settings → API Keys**
22
+ 2. Go to **Account → API Keys**
29
23
  3. Click **"Generate New Key"**
30
24
  4. Copy the key (it starts with `hmy_`)
31
25
 
32
- ### 3. Configure
26
+ ### 2. Run Setup (Recommended)
33
27
 
34
28
  ```bash
35
- harmony-mcp configure --api-key hmy_your_key_here
36
-
37
- # Optional: Set your email for auto-assignment
38
- harmony-mcp configure --api-key hmy_your_key_here --user-email you@example.com
29
+ npx harmony-mcp setup
39
30
  ```
40
31
 
41
- ### 4. Initialize for Your AI Agents
32
+ This interactive wizard will:
33
+ - Prompt for your API key
34
+ - Auto-detect your installed AI agents (Claude Code, Cursor, Windsurf, Codex)
35
+ - Configure all detected agents automatically
36
+ - Optionally install globally for faster startup
42
37
 
43
- ```bash
44
- # Auto-detect and configure all installed agents
45
- harmony-mcp init --detect
38
+ ### Alternative: Global Install
46
39
 
47
- # Or configure all supported agents
48
- harmony-mcp init --all
40
+ If you prefer a global installation:
49
41
 
50
- # Or configure specific agents
51
- harmony-mcp init --agent claude codex cursor windsurf
42
+ ```bash
43
+ npm install -g harmony-mcp
44
+ harmony-mcp setup
52
45
  ```
53
46
 
54
- This creates the necessary configuration files and workflow prompts for each agent.
55
-
56
- ### Manual Setup (Alternative)
47
+ ### Manual Setup
57
48
 
58
- If you prefer manual setup for Claude Code:
49
+ For manual configuration of Claude Code:
59
50
 
60
51
  ```bash
61
52
  claude mcp add harmony -- harmony-mcp serve
@@ -98,6 +89,10 @@ When you start working on a card (e.g., `/hmy #42`):
98
89
  ## CLI Commands
99
90
 
100
91
  ```bash
92
+ # Setup (recommended)
93
+ harmony-mcp setup # Interactive setup wizard (recommended)
94
+
95
+ # Legacy configuration commands
101
96
  harmony-mcp configure # Set up API key (interactive)
102
97
  harmony-mcp configure -k KEY -e EMAIL # Set up with API key and email
103
98
  harmony-mcp init # Initialize for AI agents (interactive)
@@ -105,6 +100,8 @@ harmony-mcp init --all # Configure all supported agents
105
100
  harmony-mcp init --detect # Auto-detect and configure installed agents
106
101
  harmony-mcp init --agent X Y # Configure specific agents
107
102
  harmony-mcp init -w WS -p PROJ # Initialize with local workspace/project context
103
+
104
+ # Status and management
108
105
  harmony-mcp status # Show current config (global and local)
109
106
  harmony-mcp reset # Clear configuration
110
107
  harmony-mcp set-workspace ID # Set active workspace (global)
@@ -113,6 +110,8 @@ harmony-mcp set-project ID # Set active project (global)
113
110
  harmony-mcp set-project ID -l # Set active project (local project)
114
111
  harmony-mcp set-user-email EMAIL # Set email for auto-assignment
115
112
  harmony-mcp clear-user-email # Disable auto-assignment
113
+
114
+ # Server
116
115
  harmony-mcp serve # Start MCP server
117
116
  ```
118
117