@planflow-tools/mcp 0.1.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.
- package/LICENSE +21 -0
- package/README.md +183 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +2261 -0
- package/package.json +81 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 PlanFlow
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# @planflow/mcp
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) server for PlanFlow - AI-native project management from your terminal.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This package provides a MCP server that integrates PlanFlow with Claude Code, allowing you to manage projects and tasks directly from your AI-powered development workflow.
|
|
8
|
+
|
|
9
|
+
## Quick Start
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# 1. Install globally
|
|
13
|
+
npm install -g @planflow/mcp
|
|
14
|
+
|
|
15
|
+
# 2. Add to Claude Desktop config (~/.config/claude/claude_desktop_config.json)
|
|
16
|
+
{
|
|
17
|
+
"mcpServers": {
|
|
18
|
+
"planflow": {
|
|
19
|
+
"command": "planflow-mcp"
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
# 3. Restart Claude Desktop
|
|
25
|
+
|
|
26
|
+
# 4. In Claude, login with your API token
|
|
27
|
+
"Login to PlanFlow with token pf_xxxxx"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Requires Node.js >= 20.0.0. See [INSTALLATION.md](./INSTALLATION.md) for detailed setup instructions.
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install -g @planflow/mcp
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Or with pnpm:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pnpm add -g @planflow/mcp
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
> **Need help?** See the [complete installation guide](./INSTALLATION.md) for detailed instructions, troubleshooting, and configuration options.
|
|
45
|
+
|
|
46
|
+
## Configuration
|
|
47
|
+
|
|
48
|
+
Add the MCP server to your Claude Code configuration file (`~/.config/claude/claude_desktop_config.json`):
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"mcpServers": {
|
|
53
|
+
"planflow": {
|
|
54
|
+
"command": "planflow-mcp"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Or if installed locally in a project:
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{
|
|
64
|
+
"mcpServers": {
|
|
65
|
+
"planflow": {
|
|
66
|
+
"command": "npx",
|
|
67
|
+
"args": ["@planflow/mcp"]
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Authentication
|
|
74
|
+
|
|
75
|
+
Before using PlanFlow tools, authenticate with your API token:
|
|
76
|
+
|
|
77
|
+
1. Get your API token from [planflow.tools/settings/api](https://planflow.tools/settings/api)
|
|
78
|
+
2. Use the `planflow_login` tool in Claude Code with your token
|
|
79
|
+
|
|
80
|
+
## Available Tools
|
|
81
|
+
|
|
82
|
+
| Tool | Description |
|
|
83
|
+
|------|-------------|
|
|
84
|
+
| `planflow_login` | Authenticate with your PlanFlow API token |
|
|
85
|
+
| `planflow_logout` | Clear stored credentials |
|
|
86
|
+
| `planflow_whoami` | Show current authenticated user |
|
|
87
|
+
| `planflow_projects` | List all your projects |
|
|
88
|
+
| `planflow_create` | Create a new project |
|
|
89
|
+
| `planflow_sync` | Sync local PROJECT_PLAN.md to cloud |
|
|
90
|
+
| `planflow_task_list` | List tasks for a project |
|
|
91
|
+
| `planflow_task_update` | Update task status |
|
|
92
|
+
| `planflow_task_next` | Get next recommended task |
|
|
93
|
+
| `planflow_notifications` | View your notifications |
|
|
94
|
+
|
|
95
|
+
## Usage Examples
|
|
96
|
+
|
|
97
|
+
### Login
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
Use planflow_login with my API token: pf_xxxxx
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### List Projects
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
Show me my PlanFlow projects
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Sync Project Plan
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
Sync my PROJECT_PLAN.md to PlanFlow
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Update Task Status
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
Mark task T1.5 as done in PlanFlow
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Get Next Task
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
What should I work on next?
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Environment Variables
|
|
128
|
+
|
|
129
|
+
| Variable | Description | Default |
|
|
130
|
+
|----------|-------------|---------|
|
|
131
|
+
| `PLANFLOW_API_URL` | API server URL | `https://api.planflow.tools` |
|
|
132
|
+
| `PLANFLOW_DEBUG` | Enable debug logging | `false` |
|
|
133
|
+
|
|
134
|
+
## Configuration Storage
|
|
135
|
+
|
|
136
|
+
Credentials are stored in `~/.config/planflow/config.json`:
|
|
137
|
+
|
|
138
|
+
```json
|
|
139
|
+
{
|
|
140
|
+
"apiUrl": "https://api.planflow.tools",
|
|
141
|
+
"token": "pf_...",
|
|
142
|
+
"userId": "...",
|
|
143
|
+
"email": "..."
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
## Requirements
|
|
148
|
+
|
|
149
|
+
- Node.js >= 20.0.0
|
|
150
|
+
- Claude Code with MCP support
|
|
151
|
+
|
|
152
|
+
## Development
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
# Install dependencies
|
|
156
|
+
pnpm install
|
|
157
|
+
|
|
158
|
+
# Run in development mode
|
|
159
|
+
pnpm dev
|
|
160
|
+
|
|
161
|
+
# Build for production
|
|
162
|
+
pnpm build
|
|
163
|
+
|
|
164
|
+
# Run tests
|
|
165
|
+
pnpm test
|
|
166
|
+
|
|
167
|
+
# Run tests with coverage
|
|
168
|
+
pnpm test:coverage
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## License
|
|
172
|
+
|
|
173
|
+
MIT - see [LICENSE](./LICENSE) for details.
|
|
174
|
+
|
|
175
|
+
## Links
|
|
176
|
+
|
|
177
|
+
- [Installation Guide](./INSTALLATION.md) - Detailed setup instructions
|
|
178
|
+
- [Full MCP Documentation](../../docs/MCP_INSTALLATION.md) - Comprehensive docs site guide
|
|
179
|
+
- [Getting Started](../../docs/GETTING_STARTED.md) - Complete onboarding guide
|
|
180
|
+
- [PlanFlow Website](https://planflow.tools)
|
|
181
|
+
- [Documentation](https://docs.planflow.tools)
|
|
182
|
+
- [GitHub Repository](https://github.com/planflow/planflow)
|
|
183
|
+
- [Report Issues](https://github.com/planflow/planflow/issues)
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|