@shirbarzur/planform-mcp-server 1.0.1 → 1.0.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 +51 -4
- package/package.json +2 -1
- package/server.json +2 -2
package/README.md
CHANGED
|
@@ -65,13 +65,60 @@ npm run build
|
|
|
65
65
|
npm start
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
+
## Add to Cursor
|
|
69
|
+
|
|
70
|
+
After the server is [published](#publishing-to-the-mcp-registry), you can add it in Cursor in either of these ways.
|
|
71
|
+
|
|
72
|
+
### Option 1: Cursor Settings UI
|
|
73
|
+
|
|
74
|
+
1. Open **Cursor Settings** (Ctrl+, or Cmd+,).
|
|
75
|
+
2. Go to **Features → Tools & MCP** (or search for "MCP").
|
|
76
|
+
3. Click **Add new MCP server**.
|
|
77
|
+
4. Configure:
|
|
78
|
+
- **Name:** `planform` (or any label you like)
|
|
79
|
+
- **Type:** Command
|
|
80
|
+
- **Command:** `npx`
|
|
81
|
+
- **Arguments:** `-y`, `@shirbarzur/planform-mcp-server`
|
|
82
|
+
- **Env** (optional; defaults point to https://www.planform.io):
|
|
83
|
+
- `BACKEND_BASE_URL` = `https://www.planform.io/api`
|
|
84
|
+
- `FRONTEND_BASE_URL` = `https://www.planform.io`
|
|
85
|
+
5. Save and **restart Cursor** so the new server is picked up.
|
|
86
|
+
|
|
87
|
+
### Option 2: Edit `mcp.json` directly
|
|
88
|
+
|
|
89
|
+
Create or edit your MCP config:
|
|
90
|
+
|
|
91
|
+
- **Project:** `.cursor/mcp.json` in your project root (good for sharing with the team).
|
|
92
|
+
- **Global:** `~/.cursor/mcp.json` (Windows: `%USERPROFILE%\.cursor\mcp.json`).
|
|
93
|
+
|
|
94
|
+
Example **`.cursor/mcp.json`**:
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"mcpServers": {
|
|
99
|
+
"planform": {
|
|
100
|
+
"command": "npx",
|
|
101
|
+
"args": ["-y", "@shirbarzur/planform-mcp-server"],
|
|
102
|
+
"env": {
|
|
103
|
+
"BACKEND_BASE_URL": "https://www.planform.io/api",
|
|
104
|
+
"FRONTEND_BASE_URL": "https://www.planform.io"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
You can omit the `env` block to use the built-in defaults (production Planform API). Restart Cursor after changing the file.
|
|
112
|
+
|
|
113
|
+
**First use:** When you use the MCP, the `device_start` tool will give you a link and code to sign in at [planform.io](https://www.planform.io) and authorize the connection.
|
|
114
|
+
|
|
68
115
|
## VS Code Integration
|
|
69
116
|
|
|
70
|
-
To use this MCP server with VS Code
|
|
117
|
+
To use this MCP server with VS Code (with an MCP extension):
|
|
71
118
|
|
|
72
|
-
1. Add the server configuration to your MCP settings
|
|
73
|
-
2. The server
|
|
74
|
-
3. Use the device flow authentication to get access tokens
|
|
119
|
+
1. Add the server configuration to your MCP settings (same structure as above, under the key your extension expects, e.g. `mcp.servers`).
|
|
120
|
+
2. The server runs via stdio transport.
|
|
121
|
+
3. Use the device flow authentication to get access tokens.
|
|
75
122
|
|
|
76
123
|
## Available Tools
|
|
77
124
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shirbarzur/planform-mcp-server",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "MCP server for Planform diagram management",
|
|
5
5
|
"mcpName": "io.github.ShirBarZur/planform-mcp",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
|
+
"bin": "dist/index.js",
|
|
7
8
|
"type": "module",
|
|
8
9
|
"scripts": {
|
|
9
10
|
"build": "echo Building... && tsc && echo Build complete!",
|
package/server.json
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
"name": "io.github.ShirBarZur/planform-mcp",
|
|
4
4
|
"title": "Planform MCP Server",
|
|
5
5
|
"description": "Create and manage Planform UML diagrams, nodes, and links. For VS Code and Cursor.",
|
|
6
|
-
"version": "1.0.
|
|
6
|
+
"version": "1.0.2",
|
|
7
7
|
"packages": [
|
|
8
8
|
{
|
|
9
9
|
"registryType": "npm",
|
|
10
10
|
"identifier": "@shirbarzur/planform-mcp-server",
|
|
11
|
-
"version": "1.0.
|
|
11
|
+
"version": "1.0.2",
|
|
12
12
|
"transport": {
|
|
13
13
|
"type": "stdio"
|
|
14
14
|
}
|