localwp-mcp 0.1.6 → 0.1.8
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 +107 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,13 +45,109 @@ If you want the MCP to focus on one site by default, set:
|
|
|
45
45
|
|
|
46
46
|
## Client Setup
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
Use these settings across supported clients:
|
|
49
49
|
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
50
|
+
- transport: `STDIO`
|
|
51
|
+
- command: `npx`
|
|
52
|
+
- arguments: `-y`, `localwp-mcp`
|
|
53
|
+
- default environment variable: `LOCALWP_MCP_PROFILE=safe`
|
|
54
|
+
- optional environment variables:
|
|
55
|
+
- `LOCAL_SITE_NAME`
|
|
56
|
+
- `LOCAL_SITE_ID`
|
|
57
|
+
- `LOCALWP_MCP_BACKUPS_DIR`
|
|
58
|
+
|
|
59
|
+
Do not choose `Streamable HTTP`. `localwp-mcp` currently runs as a local stdio MCP server.
|
|
60
|
+
|
|
61
|
+
### Codex Desktop
|
|
62
|
+
|
|
63
|
+
In Codex Desktop:
|
|
64
|
+
|
|
65
|
+
1. Open `Settings`
|
|
66
|
+
2. Open `MCP servers`
|
|
67
|
+
3. Add a custom MCP
|
|
68
|
+
4. Choose `STDIO`
|
|
69
|
+
|
|
70
|
+
Then enter:
|
|
71
|
+
|
|
72
|
+
- Name: `localwp`
|
|
73
|
+
- Command to launch: `npx`
|
|
74
|
+
- Arguments:
|
|
75
|
+
- `-y`
|
|
76
|
+
- `localwp-mcp`
|
|
77
|
+
- Environment variables:
|
|
78
|
+
- `LOCALWP_MCP_PROFILE` = `safe`
|
|
79
|
+
- optional: `LOCAL_SITE_NAME` = `your-site-name`
|
|
80
|
+
|
|
81
|
+
### Cursor
|
|
82
|
+
|
|
83
|
+
Add this to your Cursor MCP config, for example `.cursor/mcp.json`:
|
|
84
|
+
|
|
85
|
+
```json
|
|
86
|
+
{
|
|
87
|
+
"mcpServers": {
|
|
88
|
+
"localwp": {
|
|
89
|
+
"command": "npx",
|
|
90
|
+
"args": ["-y", "localwp-mcp"],
|
|
91
|
+
"env": {
|
|
92
|
+
"LOCALWP_MCP_PROFILE": "safe"
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Claude Code
|
|
100
|
+
|
|
101
|
+
Add the MCP through the Claude Code CLI.
|
|
102
|
+
|
|
103
|
+
macOS and Linux:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
claude mcp add localwp -- npx -y localwp-mcp
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Windows:
|
|
110
|
+
|
|
111
|
+
```powershell
|
|
112
|
+
claude mcp add localwp -- cmd /c npx -y localwp-mcp
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The space before and after `--` is intentional. `--` is the separator between the Claude command and the command Claude should launch.
|
|
116
|
+
|
|
117
|
+
After adding the server, configure:
|
|
118
|
+
|
|
119
|
+
- `LOCALWP_MCP_PROFILE=safe`
|
|
120
|
+
- optional: `LOCAL_SITE_NAME=your-site-name`
|
|
121
|
+
|
|
122
|
+
### OpenCode
|
|
123
|
+
|
|
124
|
+
Use a local MCP server entry in your OpenCode config:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"$schema": "https://opencode.ai/config.json",
|
|
129
|
+
"mcp": {
|
|
130
|
+
"localwp": {
|
|
131
|
+
"type": "local",
|
|
132
|
+
"command": ["npx", "-y", "localwp-mcp"],
|
|
133
|
+
"enabled": true,
|
|
134
|
+
"environment": {
|
|
135
|
+
"LOCALWP_MCP_PROFILE": "safe"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Other STDIO MCP Clients
|
|
143
|
+
|
|
144
|
+
If your MCP client supports launching a local server over `STDIO`, use:
|
|
145
|
+
|
|
146
|
+
- command: `npx`
|
|
147
|
+
- arguments: `-y`, `localwp-mcp`
|
|
148
|
+
- environment: `LOCALWP_MCP_PROFILE=safe`
|
|
149
|
+
|
|
150
|
+
If a client only accepts an MCP URL and cannot launch a local command, it cannot use `localwp-mcp` yet.
|
|
55
151
|
|
|
56
152
|
## Access Modes
|
|
57
153
|
|
|
@@ -271,8 +367,8 @@ Those tools are the fastest way to see whether the problem is:
|
|
|
271
367
|
|
|
272
368
|
## For Contributors
|
|
273
369
|
|
|
274
|
-
Contributor and maintainer docs live outside the main user guide:
|
|
275
|
-
|
|
276
|
-
- [CONTRIBUTING.md](
|
|
277
|
-
- [SECURITY.md](
|
|
278
|
-
- [Maintainer Docs](
|
|
370
|
+
Contributor and maintainer docs live outside the main user guide:
|
|
371
|
+
|
|
372
|
+
- [CONTRIBUTING.md](https://github.com/kazimshah39/localwp-mcp/blob/main/CONTRIBUTING.md)
|
|
373
|
+
- [SECURITY.md](https://github.com/kazimshah39/localwp-mcp/blob/main/SECURITY.md)
|
|
374
|
+
- [Maintainer Docs](https://github.com/kazimshah39/localwp-mcp/blob/main/docs/maintainers/README.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "localwp-mcp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"description": "A LocalWP-aware MCP server for WordPress developers with simple safe and full-access profiles, logs, doctor diagnostics, SQL access, backups, restore flows, MCP resources/prompts, and site-aware WP-CLI.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"packageManager": "pnpm@10.32.1",
|