Skip to content

Commit e1e938d

Browse files
authored
Merge pull request #22 from webflow/chore/readme-troubleshooting
chore: Add troubleshooting section to README, bump to 0.3.1
2 parents f290ac9 + 128739e commit e1e938d

File tree

3 files changed

+39
-17
lines changed

3 files changed

+39
-17
lines changed

README.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,30 +41,52 @@ A Node.js server implementing Model Context Protocol (MCP) for Webflow using the
4141
1. Go to Settings → Cursor Settings → MCP
4242
2. Click `+ Add New Global MCP Server`
4343
3. Paste configuration
44-
4. Save and verify server status
44+
4. Replace `YOUR_API_TOKEN` with the token you copied earlier
45+
5. Save and **restart** Cursor
4546

4647
**For Claude Desktop:**
4748

4849
1. Open Settings → Developer
4950
2. Click `Edit Config`
50-
3. Paste configuration
51-
4. Save and **restart** Claude
51+
3. Open `claude_desktop_config.json` in a code editor and paste configuration
52+
4. Replace `YOUR_API_TOKEN` with the token you copied earlier
53+
5. Save and **restart** Claude
5254

53-
## 🛠️ Available tools
55+
## ❓ Troubleshooting
56+
57+
If you are having issues starting the server in your MCP client e.g. Cursor or Claude Desktop, please try the following.
58+
59+
### Ensure you have a valid Webflow API token
5460

55-
**For Cursor:**
61+
1. Go to [Webflow's API Playground](https://developers.webflow.com/data/reference/token/authorized-by), log in and generate a token, then copy the token from the Request Generator
62+
2. Replace `YOUR_API_TOKEN` in your MCP client configuration with the token you copied
63+
3. Save and **restart** your MCP client
64+
65+
### Ensure you have the Node and NPM installed
66+
67+
- [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
68+
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
69+
70+
Run the following commands to confirm you have Node and NPM installed:
71+
72+
```shell
73+
node -v
74+
npm -v
75+
```
76+
77+
### Clear your NPM cache
78+
79+
Sometimes clearing your [NPM cache](https://docs.npmjs.com/cli/v8/commands/npm-cache) can resolve issues with `npx`.
80+
81+
```shell
82+
npm cache clean --force
83+
```
5684

57-
1. Go to Settings → Cursor Settings → MCP
58-
2. Click `+ Add New Global MCP Server`
59-
3. Paste configuration
60-
4. Save and verify server status
85+
### Fix NPM global package permissions
6186

62-
**For Claude Desktop:**
87+
If `npm -v` doesn't work for you but `sudo npm -v` does, you may need to fix NPM global package permissions. See the official [NPM docs](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) for more information.
6388

64-
1. Open Settings → Developer
65-
2. Click `Edit Config`
66-
3. Paste configuration
67-
4. Save and **restart** Claude
89+
Note: if you are making changes to your shell configuration, you may need to restart your shell for changes to take effect.
6890

6991
## 🛠️ Available tools
7092

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "webflow-mcp-server",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"type": "module",
55
"main": "dist/index.js",
66
"bin": {

0 commit comments

Comments
 (0)