planmode 0.2.1 → 0.2.2
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 +79 -4
- package/dist/index.js +1 -1
- package/dist/mcp.js +1 -1
- package/package.json +1 -1
- package/src/index.ts +1 -1
- package/src/mcp.ts +1 -1
package/README.md
CHANGED
|
@@ -32,19 +32,94 @@ planmode list
|
|
|
32
32
|
|
|
33
33
|
## Use with Claude Code (MCP)
|
|
34
34
|
|
|
35
|
-
Planmode includes an MCP server that lets Claude Code search, install, preview, and manage packages directly from your conversations.
|
|
35
|
+
Planmode includes an MCP server that lets Claude Code search, install, preview, and manage packages directly from your conversations — no need to leave the chat.
|
|
36
|
+
|
|
37
|
+
### Prerequisites
|
|
38
|
+
|
|
39
|
+
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) installed and working (`claude` command available)
|
|
40
|
+
- Planmode installed globally: `npm install -g planmode`
|
|
41
|
+
|
|
42
|
+
### Setup
|
|
36
43
|
|
|
37
44
|
```bash
|
|
38
|
-
#
|
|
45
|
+
# Automatic — registers the MCP server with Claude Code
|
|
39
46
|
planmode mcp setup
|
|
40
47
|
```
|
|
41
48
|
|
|
42
|
-
|
|
49
|
+
This runs `claude mcp add --transport stdio planmode -- planmode-mcp` under the hood. You only need to do this once.
|
|
50
|
+
|
|
51
|
+
### Manual setup
|
|
52
|
+
|
|
53
|
+
If you prefer to register manually, or if the automatic setup doesn't work:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
claude mcp add --transport stdio planmode -- planmode-mcp
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Or add it directly to your Claude Code MCP config (`~/.claude/settings.json`):
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"mcpServers": {
|
|
64
|
+
"planmode": {
|
|
65
|
+
"command": "planmode-mcp",
|
|
66
|
+
"transport": "stdio"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Verify it works
|
|
73
|
+
|
|
74
|
+
After setup, start a Claude Code session and ask:
|
|
75
|
+
|
|
76
|
+
> "Search planmode for a Next.js starter plan"
|
|
77
|
+
|
|
78
|
+
Claude should call the `planmode_search` tool and return results from the registry.
|
|
79
|
+
|
|
80
|
+
### Available MCP tools
|
|
81
|
+
|
|
82
|
+
Once connected, Claude has access to these tools:
|
|
83
|
+
|
|
84
|
+
| Tool | What it does |
|
|
85
|
+
|------|-------------|
|
|
86
|
+
| `planmode_search` | Search the registry for packages |
|
|
87
|
+
| `planmode_info` | Get detailed package metadata |
|
|
88
|
+
| `planmode_preview` | Read a package's content before installing |
|
|
89
|
+
| `planmode_install` | Install a package into the current project |
|
|
90
|
+
| `planmode_uninstall` | Remove an installed package |
|
|
91
|
+
| `planmode_list` | List all installed packages |
|
|
92
|
+
| `planmode_read` | Read the content of an installed package |
|
|
93
|
+
| `planmode_update` | Update installed packages |
|
|
94
|
+
| `planmode_init` | Scaffold a new package |
|
|
95
|
+
| `planmode_publish` | Publish a package to the registry |
|
|
96
|
+
| `planmode_validate` | Validate a planmode.yaml manifest |
|
|
97
|
+
| `planmode_run` | Render a templated prompt with variables |
|
|
98
|
+
| `planmode_doctor` | Run a health check on installed packages |
|
|
99
|
+
| `planmode_test` | Validate a package before publishing |
|
|
100
|
+
| `planmode_record_start` | Start recording git commits for plan generation |
|
|
101
|
+
| `planmode_record_stop` | Stop recording and generate a plan |
|
|
102
|
+
| `planmode_snapshot` | Generate a plan from existing project setup |
|
|
103
|
+
|
|
104
|
+
Installed packages are also exposed as MCP resources that Claude can browse automatically.
|
|
105
|
+
|
|
106
|
+
### Example prompts
|
|
43
107
|
|
|
44
108
|
Ask Claude things like:
|
|
109
|
+
|
|
45
110
|
- "Search planmode for a Next.js starter plan"
|
|
46
|
-
- "
|
|
111
|
+
- "Show me what the typescript-strict rule contains"
|
|
112
|
+
- "Install the docker-compose-stack plan"
|
|
113
|
+
- "Preview the rest-api-generator prompt before installing"
|
|
47
114
|
- "Run a health check on my planmode packages"
|
|
115
|
+
- "Create a new planmode rule called my-coding-standards"
|
|
116
|
+
- "Record my work and generate a plan from my commits"
|
|
117
|
+
|
|
118
|
+
### Remove
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
planmode mcp remove
|
|
122
|
+
```
|
|
48
123
|
|
|
49
124
|
## Package types
|
|
50
125
|
|
package/dist/index.js
CHANGED
|
@@ -2289,7 +2289,7 @@ var snapshotCommand = new Command15("snapshot").description("Analyze the current
|
|
|
2289
2289
|
|
|
2290
2290
|
// src/index.ts
|
|
2291
2291
|
var program = new Command16();
|
|
2292
|
-
program.name("planmode").description("The open source package manager for AI plans, rules, and prompts.").version("0.2.
|
|
2292
|
+
program.name("planmode").description("The open source package manager for AI plans, rules, and prompts.").version("0.2.2");
|
|
2293
2293
|
program.addCommand(installCommand);
|
|
2294
2294
|
program.addCommand(uninstallCommand);
|
|
2295
2295
|
program.addCommand(searchCommand);
|
package/dist/mcp.js
CHANGED
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -20,7 +20,7 @@ const program = new Command();
|
|
|
20
20
|
program
|
|
21
21
|
.name("planmode")
|
|
22
22
|
.description("The open source package manager for AI plans, rules, and prompts.")
|
|
23
|
-
.version("0.2.
|
|
23
|
+
.version("0.2.2");
|
|
24
24
|
|
|
25
25
|
program.addCommand(installCommand);
|
|
26
26
|
program.addCommand(uninstallCommand);
|