planflow-mcp 0.1.2 → 0.1.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 +18 -6
- package/dist/index.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# planflow-mcp
|
|
2
2
|
|
|
3
3
|
MCP (Model Context Protocol) server for PlanFlow - AI-native project management from your terminal.
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@ This package provides a MCP server that integrates PlanFlow with Claude Code, al
|
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
# 1. Install globally
|
|
13
|
-
npm install -g
|
|
13
|
+
npm install -g planflow-mcp
|
|
14
14
|
|
|
15
15
|
# 2. Add to Claude Desktop config (~/.config/claude/claude_desktop_config.json)
|
|
16
16
|
{
|
|
@@ -32,20 +32,30 @@ Requires Node.js >= 20.0.0. See [INSTALLATION.md](./INSTALLATION.md) for detaile
|
|
|
32
32
|
## Installation
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
|
-
npm install -g
|
|
35
|
+
npm install -g planflow-mcp
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
Or with pnpm:
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
-
pnpm add -g
|
|
41
|
+
pnpm add -g planflow-mcp
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
> **Need help?** See the [complete installation guide](./INSTALLATION.md) for detailed instructions, troubleshooting, and configuration options.
|
|
45
45
|
|
|
46
46
|
## Configuration
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
### Option 1: CLI Command (Recommended)
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
claude mcp add --transport stdio --scope user planflow-mcp -- planflow-mcp
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
This automatically adds PlanFlow to your Claude Code configuration.
|
|
55
|
+
|
|
56
|
+
### Option 2: Manual Configuration
|
|
57
|
+
|
|
58
|
+
Add the MCP server to your Claude Code configuration file (`~/.claude.json` or `~/.config/claude/settings.json`):
|
|
49
59
|
|
|
50
60
|
```json
|
|
51
61
|
{
|
|
@@ -64,12 +74,14 @@ Or if installed locally in a project:
|
|
|
64
74
|
"mcpServers": {
|
|
65
75
|
"planflow": {
|
|
66
76
|
"command": "npx",
|
|
67
|
-
"args": ["
|
|
77
|
+
"args": ["planflow-mcp"]
|
|
68
78
|
}
|
|
69
79
|
}
|
|
70
80
|
}
|
|
71
81
|
```
|
|
72
82
|
|
|
83
|
+
After configuration, restart Claude Code to load the MCP server.
|
|
84
|
+
|
|
73
85
|
## Authentication
|
|
74
86
|
|
|
75
87
|
Before using PlanFlow tools, authenticate with your API token:
|
package/dist/index.js
CHANGED
package/package.json
CHANGED