Skip to content

Commit b734951

Browse files
docs: updated developer mode docs.
1 parent 8529d5e commit b734951

File tree

1 file changed

+183
-5
lines changed

1 file changed

+183
-5
lines changed

README.md

Lines changed: 183 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,184 @@ A Node.js server implementing Model Context Protocol (MCP) for Webflow using the
1111
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
1212
- [A Webflow Account](https://webflow.com/signup)
1313

14+
## 🚀 Getting started (OAuth remote MCP server)
15+
16+
Get started by installing Webflow's remote MCP server, which uses OAuth to authenticate with your Webflow sites, and a companion app that syncs your live canvas with your AI agent.
17+
18+
For local installation, see the [NPM package documentation](https://www.npmjs.com/package/webflow-mcp-server).
19+
20+
### Requirements
21+
22+
- Node.js 22.3.0 or higher
23+
24+
> Note: The MCP server currently supports Node.js 22.3.0 or higher. If you run into version issues, see Node.js compatibility below.
25+
26+
### Cursor
27+
28+
1. Go to `Settings → Cursor Settings → MCP & Integrations`.
29+
2. Under MCP Tools, click `+ New MCP Server`.
30+
3. Paste the following configuration into `.cursor/mcp.json` (or add the `webflow` part to your existing configuration):
31+
32+
```json
33+
{
34+
"mcpServers": {
35+
"webflow": {
36+
"command": "npx mcp-remote https://mcp.webflow.com/sse"
37+
}
38+
}
39+
}
40+
```
41+
42+
> Tip: Prefer a project-level `mcp.json` to avoid repeated auth prompts across multiple Cursor windows. See Cursor’s docs on configuration locations.
43+
44+
4. Save and close the file. Cursor will automatically open an OAuth login page where you can authorize the Webflow sites and install the companion app.
45+
46+
#### Open the Webflow Designer
47+
48+
- Open your site in the Webflow Designer.
49+
- Or ask your AI agent:
50+
51+
```text
52+
Give me a link to open <MY_SITE_NAME> in the Webflow Designer
53+
```
54+
55+
#### Open the MCP Webflow App
56+
57+
1. In the Designer, open the Apps panel (press `E`).
58+
2. Launch "Webflow MCP Bridge App" (installed during OAuth).
59+
3. Wait for the app to connect to the MCP server.
60+
61+
#### Write your first prompt
62+
63+
Try these in your AI chat:
64+
65+
```text
66+
Analyze my last 5 blog posts and suggest 3 new topic ideas with SEO keywords
67+
```
68+
69+
```text
70+
Find older blog posts that mention similar topics and add internal links to my latest post
71+
```
72+
73+
```text
74+
Create a hero section card on my home page with a CTA button and responsive design
75+
```
76+
77+
### Claude Desktop
78+
79+
1. Enable developer mode: `Help → Troubleshooting → Enable Developer Mode`.
80+
2. Open developer settings: `File → Settings → Developer`.
81+
3. Click `Get Started` or edit the configuration to open `claude_desktop_config.json` and add:
82+
83+
```json
84+
{
85+
"mcpServers": {
86+
"webflow": {
87+
"command": "npx",
88+
"args": ["mcp-remote", "https://mcp.webflow.com/sse"]
89+
}
90+
}
91+
}
92+
```
93+
94+
4. Save and restart Claude Desktop (`Cmd/Ctrl + R`). An OAuth login page will open to authorize sites and install the companion app.
95+
96+
Then follow the same steps as Cursor to open the Webflow Designer, open the MCP Bridge App, and try your first prompts.
97+
98+
### Windsurf
99+
100+
1. Navigate to `Windsurf → Settings → Windsurf Settings`.
101+
2. Go to `Cascade → MCP Servers → Manage MCPs`.
102+
3. Click "View raw configuration" and add:
103+
104+
```json
105+
{
106+
"mcpServers": {
107+
"webflow": {
108+
"command": "npx",
109+
"args": ["mcp-remote", "https://mcp.webflow.com/sse"]
110+
}
111+
}
112+
}
113+
```
114+
115+
4. Save. Use the settings page "Refresh" button. A browser will open the OAuth flow to authorize sites (this also installs the companion app). Then open the Webflow Designer, open the MCP Bridge App, and try prompts as above.
116+
117+
### Reset your OAuth token
118+
119+
If you need to reset your OAuth token, run:
120+
121+
```bash
122+
rm -rf ~/.mcp-auth
123+
```
124+
125+
### Node.js compatibility
126+
127+
If you encounter issues with Node.js, try one of the following:
128+
129+
#### Use Node.js 22.3.0 with nvm
130+
131+
1. Install nvm:
132+
133+
```bash
134+
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
135+
```
136+
137+
2. Restart your terminal or source your shell configuration file, e.g.:
138+
139+
```bash
140+
source ~/.bashrc
141+
```
142+
143+
3. Install and set default:
144+
145+
```bash
146+
nvm install 22.3.0
147+
nvm use 22.3.0
148+
nvm alias default 22.3.0
149+
```
150+
151+
4. Clear `npx` cache (optional):
152+
153+
```bash
154+
rm -rf ~/.npm/_npx
155+
```
156+
157+
5. Verify installation:
158+
159+
```bash
160+
node --version
161+
npm --version
162+
```
163+
164+
#### Use Node Version Switcher (NVS)
165+
166+
1. Install Node Version Switcher (NVS) (see the official repository for OS-specific steps):
167+
168+
```bash
169+
git clone https://github.com/jasongin/nvs ~/.nvs && ~/.nvs/nvs.sh install
170+
```
171+
172+
2. Add Node.js 22.3.0 and use it:
173+
174+
```bash
175+
nvs add 22.3.0
176+
nvs use 22.3.0
177+
```
178+
179+
3. (Optional) Install `mcp-remote` globally when on 22.3.0:
180+
181+
```bash
182+
npm install -g mcp-remote
183+
```
184+
185+
4. If your AI client needs explicit paths, determine them:
186+
187+
```bash
188+
nvs which 22.3.0
189+
which mcp-remote
190+
```
191+
14192
## ▶️ Quick start (hosted on Cloudflare workers)
15193

16194
**For Cursor:**
@@ -91,7 +269,7 @@ A Node.js server implementing Model Context Protocol (MCP) for Webflow using the
91269

92270
**Important note**
93271

94-
All these methods rely on the `mcp-remote` [npm package](https://www.npmjs.com/package/mcp-remote) which is still considered experimental as of 04/30/2025.
272+
All these methods rely on the `mcp-remote` [npm package](https://www.npmjs.com/package/mcp-remote) which is still considered experimental as of April 30, 2025.
95273
If at any point you have issues, and want to reset your OAuth tokens, you can run the following command before restarting your MCP client:
96274

97275
```shell
@@ -231,7 +409,7 @@ custom code - get - applied - site - script - list //Get all scripts applied to
231409
custom code - delete site custom code // Remove scripts from a site
232410
```
233411

234-
### Components
412+
### Components
235413

236414
```
237415
components - list; // List all components for a site
@@ -241,15 +419,15 @@ components - properties - get; // Get the default property values of a component
241419
components - properties - update; // Update the default property values of a component definition for secondary locales
242420
```
243421

244-
### Ask Webflow AI
422+
### Ask Webflow AI
245423

246424
```
247425
ask - webflow - ai; // Search Webflow Docs using AI search
248426
```
249427

250428
# 🗣️ Prompts & Resources
251429

252-
This implementation **does not** include `prompts` or `resources` from the MCP specification. However, this may change in the future when there is broader support across popular MCP clients.
430+
This implementation **doesn't** include `prompts` or `resources` from the MCP specification. However, this may change in the future when there is broader support across popular MCP clients.
253431

254432
# 🚧 Development mode
255433

@@ -285,4 +463,4 @@ npm start
285463

286464
### Static Page Content Updates
287465

288-
The pages_update_static_content endpoint currently only supports updates to localized static pages in secondary locales. Updates to static content in the default locale are not supported and will result in errors.
466+
The `pages_update_static_content` endpoint currently only supports updates to localized static pages in secondary locales. Updates to static content in the default locale aren't supported and will result in errors.

0 commit comments

Comments
 (0)