mcp-wordpress 1.3.0 → 1.3.1
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/dist/mcp-wordpress-1.3.1.tgz +0 -0
- package/docs/api/categories/auth.md +2 -0
- package/docs/api/categories/cache.md +2 -0
- package/docs/api/categories/comment.md +2 -0
- package/docs/api/categories/media.md +2 -0
- package/docs/api/categories/page.md +2 -0
- package/docs/api/categories/performance.md +2 -0
- package/docs/api/categories/post.md +2 -0
- package/docs/api/categories/taxonomy.md +2 -0
- package/docs/api/categories/user.md +2 -0
- package/docs/api/tools/wp_approve_comment.md +3 -5
- package/docs/user-guides/DOCKER_NPM_DTX_SETUP.md +217 -0
- package/docs/user-guides/DOCKER_SETUP.md +1 -1
- package/docs/user-guides/DTX_SETUP.md +2 -2
- package/package.json +1 -1
- package/dist/mcp-wordpress-1.3.0.tgz +0 -0
|
Binary file
|
|
@@ -19,6 +19,7 @@ Authentication testing and management tools
|
|
|
19
19
|
## Examples
|
|
20
20
|
|
|
21
21
|
### Basic auth Workflow
|
|
22
|
+
|
|
22
23
|
```bash
|
|
23
24
|
# List all auth
|
|
24
25
|
wp_list_auth
|
|
@@ -31,6 +32,7 @@ wp_create_aut --title="Example"
|
|
|
31
32
|
```
|
|
32
33
|
|
|
33
34
|
### Multi-Site auth Management
|
|
35
|
+
|
|
34
36
|
```bash
|
|
35
37
|
# Work with specific site
|
|
36
38
|
wp_list_auth --site=production
|
|
@@ -20,6 +20,7 @@ Performance caching and optimization tools
|
|
|
20
20
|
## Examples
|
|
21
21
|
|
|
22
22
|
### Basic cache Workflow
|
|
23
|
+
|
|
23
24
|
```bash
|
|
24
25
|
# List all cache
|
|
25
26
|
wp_list_cache
|
|
@@ -32,6 +33,7 @@ wp_create_cach --title="Example"
|
|
|
32
33
|
```
|
|
33
34
|
|
|
34
35
|
### Multi-Site cache Management
|
|
36
|
+
|
|
35
37
|
```bash
|
|
36
38
|
# Work with specific site
|
|
37
39
|
wp_list_cache --site=production
|
|
@@ -23,6 +23,7 @@ comment management tools
|
|
|
23
23
|
## Examples
|
|
24
24
|
|
|
25
25
|
### Basic comment Workflow
|
|
26
|
+
|
|
26
27
|
```bash
|
|
27
28
|
# List all comment
|
|
28
29
|
wp_list_comment
|
|
@@ -35,6 +36,7 @@ wp_create_commen --title="Example"
|
|
|
35
36
|
```
|
|
36
37
|
|
|
37
38
|
### Multi-Site comment Management
|
|
39
|
+
|
|
38
40
|
```bash
|
|
39
41
|
# Work with specific site
|
|
40
42
|
wp_list_comment --site=production
|
|
@@ -22,6 +22,7 @@ File upload, management, and media library tools
|
|
|
22
22
|
## Examples
|
|
23
23
|
|
|
24
24
|
### Basic media Workflow
|
|
25
|
+
|
|
25
26
|
```bash
|
|
26
27
|
# List all media
|
|
27
28
|
wp_list_media
|
|
@@ -34,6 +35,7 @@ wp_create_medi --title="Example"
|
|
|
34
35
|
```
|
|
35
36
|
|
|
36
37
|
### Multi-Site media Management
|
|
38
|
+
|
|
37
39
|
```bash
|
|
38
40
|
# Work with specific site
|
|
39
41
|
wp_list_media --site=production
|
|
@@ -22,6 +22,7 @@ page management tools
|
|
|
22
22
|
## Examples
|
|
23
23
|
|
|
24
24
|
### Basic page Workflow
|
|
25
|
+
|
|
25
26
|
```bash
|
|
26
27
|
# List all page
|
|
27
28
|
wp_list_page
|
|
@@ -34,6 +35,7 @@ wp_create_pag --title="Example"
|
|
|
34
35
|
```
|
|
35
36
|
|
|
36
37
|
### Multi-Site page Management
|
|
38
|
+
|
|
37
39
|
```bash
|
|
38
40
|
# Work with specific site
|
|
39
41
|
wp_list_page --site=production
|
|
@@ -23,6 +23,7 @@ Performance monitoring and analytics tools
|
|
|
23
23
|
## Examples
|
|
24
24
|
|
|
25
25
|
### Basic performance Workflow
|
|
26
|
+
|
|
26
27
|
```bash
|
|
27
28
|
# List all performance
|
|
28
29
|
wp_list_performance
|
|
@@ -35,6 +36,7 @@ wp_create_performanc --title="Example"
|
|
|
35
36
|
```
|
|
36
37
|
|
|
37
38
|
### Multi-Site performance Management
|
|
39
|
+
|
|
38
40
|
```bash
|
|
39
41
|
# Work with specific site
|
|
40
42
|
wp_list_performance --site=production
|
|
@@ -22,6 +22,7 @@ post management tools
|
|
|
22
22
|
## Examples
|
|
23
23
|
|
|
24
24
|
### Basic post Workflow
|
|
25
|
+
|
|
25
26
|
```bash
|
|
26
27
|
# List all post
|
|
27
28
|
wp_list_post
|
|
@@ -34,6 +35,7 @@ wp_create_pos --title="Example"
|
|
|
34
35
|
```
|
|
35
36
|
|
|
36
37
|
### Multi-Site post Management
|
|
38
|
+
|
|
37
39
|
```bash
|
|
38
40
|
# Work with specific site
|
|
39
41
|
wp_list_post --site=production
|
|
@@ -26,6 +26,7 @@ taxonomy management tools
|
|
|
26
26
|
## Examples
|
|
27
27
|
|
|
28
28
|
### Basic taxonomy Workflow
|
|
29
|
+
|
|
29
30
|
```bash
|
|
30
31
|
# List all taxonomy
|
|
31
32
|
wp_list_taxonomy
|
|
@@ -38,6 +39,7 @@ wp_create_taxonom --title="Example"
|
|
|
38
39
|
```
|
|
39
40
|
|
|
40
41
|
### Multi-Site taxonomy Management
|
|
42
|
+
|
|
41
43
|
```bash
|
|
42
44
|
# Work with specific site
|
|
43
45
|
wp_list_taxonomy --site=production
|
|
@@ -22,6 +22,7 @@ user management tools
|
|
|
22
22
|
## Examples
|
|
23
23
|
|
|
24
24
|
### Basic user Workflow
|
|
25
|
+
|
|
25
26
|
```bash
|
|
26
27
|
# List all user
|
|
27
28
|
wp_list_user
|
|
@@ -34,6 +35,7 @@ wp_create_use --title="Example"
|
|
|
34
35
|
```
|
|
35
36
|
|
|
36
37
|
### Multi-Site user Management
|
|
38
|
+
|
|
37
39
|
```bash
|
|
38
40
|
# Work with specific site
|
|
39
41
|
wp_list_user --site=production
|
|
@@ -17,11 +17,13 @@ Approves a pending comment.
|
|
|
17
17
|
Simple example of using wp_approve_comment
|
|
18
18
|
|
|
19
19
|
**Command:**
|
|
20
|
+
|
|
20
21
|
```bash
|
|
21
22
|
wp_approve_comment --id="123"
|
|
22
23
|
```
|
|
23
24
|
|
|
24
25
|
**Response:**
|
|
26
|
+
|
|
25
27
|
```json
|
|
26
28
|
{
|
|
27
29
|
"success": true,
|
|
@@ -31,6 +33,7 @@ wp_approve_comment --id="123"
|
|
|
31
33
|
```
|
|
32
34
|
|
|
33
35
|
**Error Example (Authentication failure):**
|
|
36
|
+
|
|
34
37
|
```json
|
|
35
38
|
{
|
|
36
39
|
"error": "Authentication failed",
|
|
@@ -38,11 +41,6 @@ wp_approve_comment --id="123"
|
|
|
38
41
|
}
|
|
39
42
|
```
|
|
40
43
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
44
|
## Response Format
|
|
47
45
|
|
|
48
46
|
**Return Type:** `object`
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
# Docker, NPM, and DTX Setup Guide
|
|
2
|
+
|
|
3
|
+
This guide provides step-by-step instructions for setting up the MCP WordPress server using Docker, NPM, and DTX, including Claude Desktop configuration.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🚀 Docker Setup
|
|
8
|
+
|
|
9
|
+
### 1. Build the Docker Image
|
|
10
|
+
|
|
11
|
+
Use the provided `Dockerfile` to build the MCP WordPress container:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
git clone https://github.com/docdyhr/mcp-wordpress.git
|
|
15
|
+
cd mcp-wordpress
|
|
16
|
+
docker build -t mcp-wordpress .
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### 2. Run the Docker Container
|
|
20
|
+
|
|
21
|
+
Start the container with the necessary environment variables:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# For Claude Desktop MCP integration (recommended)
|
|
25
|
+
docker run --rm -i \
|
|
26
|
+
-e WORDPRESS_SITE_URL=https://example.com \
|
|
27
|
+
-e WORDPRESS_USERNAME=your_username \
|
|
28
|
+
-e WORDPRESS_APP_PASSWORD="xxxx xxxx xxxx xxxx xxxx xxxx" \
|
|
29
|
+
mcp-wordpress
|
|
30
|
+
|
|
31
|
+
# For debugging/testing (background mode)
|
|
32
|
+
docker run -d --name mcp-wordpress-debug \
|
|
33
|
+
-e WORDPRESS_SITE_URL=https://example.com \
|
|
34
|
+
-e WORDPRESS_USERNAME=your_username \
|
|
35
|
+
-e WORDPRESS_APP_PASSWORD="xxxx xxxx xxxx xxxx xxxx xxxx" \
|
|
36
|
+
mcp-wordpress
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 3. Multi-Site Configuration
|
|
40
|
+
|
|
41
|
+
For multi-site setups, mount a configuration file:
|
|
42
|
+
|
|
43
|
+
1. Create `mcp-wordpress.config.json`:
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"sites": [
|
|
48
|
+
{
|
|
49
|
+
"id": "site1",
|
|
50
|
+
"name": "Main Site",
|
|
51
|
+
"config": {
|
|
52
|
+
"WORDPRESS_SITE_URL": "https://site1.com",
|
|
53
|
+
"WORDPRESS_USERNAME": "admin",
|
|
54
|
+
"WORDPRESS_APP_PASSWORD": "xxxx xxxx xxxx xxxx xxxx xxxx"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"id": "site2",
|
|
59
|
+
"name": "Blog Site",
|
|
60
|
+
"config": {
|
|
61
|
+
"WORDPRESS_SITE_URL": "https://blog.site2.com",
|
|
62
|
+
"WORDPRESS_USERNAME": "editor",
|
|
63
|
+
"WORDPRESS_APP_PASSWORD": "yyyy yyyy yyyy yyyy yyyy yyyy"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
2. Run the container with the configuration file:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
# For Claude Desktop MCP integration (recommended)
|
|
74
|
+
docker run --rm -i \
|
|
75
|
+
-v $(pwd)/mcp-wordpress.config.json:/app/mcp-wordpress.config.json:ro \
|
|
76
|
+
mcp-wordpress
|
|
77
|
+
|
|
78
|
+
# For debugging/testing (background mode)
|
|
79
|
+
docker run -d --name mcp-wordpress-multisite \
|
|
80
|
+
-v $(pwd)/mcp-wordpress.config.json:/app/mcp-wordpress.config.json:ro \
|
|
81
|
+
mcp-wordpress
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 📦 NPM Setup
|
|
87
|
+
|
|
88
|
+
### 1. Install Dependencies
|
|
89
|
+
|
|
90
|
+
Clone the repository and install dependencies:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
git clone https://github.com/docdyhr/mcp-wordpress.git
|
|
94
|
+
cd mcp-wordpress
|
|
95
|
+
npm install
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 2. Run the Setup Wizard
|
|
99
|
+
|
|
100
|
+
Run the interactive setup wizard:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
npm run setup
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 3. Start the Server
|
|
107
|
+
|
|
108
|
+
Start the MCP WordPress server:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
npm start
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### 4. Test the Tools
|
|
115
|
+
|
|
116
|
+
Run tests to verify functionality:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
npm run test:tools
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## 🖼️ DTX Setup
|
|
125
|
+
|
|
126
|
+
### 1. Build the DTX Package
|
|
127
|
+
|
|
128
|
+
Use the provided script to build the DTX package:
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
npm run build
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 2. Deploy the DTX Package
|
|
135
|
+
|
|
136
|
+
Deploy the DTX package to the appropriate directory:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
cp -r dxt/ /path/to/dtx/directory
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### 3. Verify DTX Integration
|
|
143
|
+
|
|
144
|
+
Ensure the DTX package is correctly integrated by checking the `manifest.json` file:
|
|
145
|
+
|
|
146
|
+
```json
|
|
147
|
+
{
|
|
148
|
+
"name": "MCP WordPress",
|
|
149
|
+
"version": "1.0.0",
|
|
150
|
+
"description": "DTX package for MCP WordPress",
|
|
151
|
+
"main": "index.js"
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## 🤖 Claude Desktop Configuration
|
|
158
|
+
|
|
159
|
+
### 1. Update Configuration File
|
|
160
|
+
|
|
161
|
+
Add the MCP WordPress server to your Claude Desktop configuration file:
|
|
162
|
+
|
|
163
|
+
```json
|
|
164
|
+
{
|
|
165
|
+
"mcpServers": {
|
|
166
|
+
"mcp-wordpress": {
|
|
167
|
+
"command": "node",
|
|
168
|
+
"args": ["/path/to/your/mcp-wordpress/dist/index.js"],
|
|
169
|
+
"env": {
|
|
170
|
+
"WORDPRESS_SITE_URL": "https://example.com",
|
|
171
|
+
"WORDPRESS_USERNAME": "your_username",
|
|
172
|
+
"WORDPRESS_APP_PASSWORD": "xxxx xxxx xxxx xxxx xxxx xxxx",
|
|
173
|
+
"WORDPRESS_AUTH_METHOD": "app-password"
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### 2. Restart Claude Desktop
|
|
181
|
+
|
|
182
|
+
Close and reopen Claude Desktop to load the new configuration.
|
|
183
|
+
|
|
184
|
+
### 3. Test Integration
|
|
185
|
+
|
|
186
|
+
Use natural language commands in Claude Desktop to interact with your WordPress site:
|
|
187
|
+
|
|
188
|
+
- "List my WordPress posts"
|
|
189
|
+
- "Show me my site statistics"
|
|
190
|
+
- "What categories do I have?"
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## 🛠️ Maintenance Commands
|
|
195
|
+
|
|
196
|
+
### Docker
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
docker ps # List running containers
|
|
200
|
+
docker logs mcp-wordpress # View container logs
|
|
201
|
+
docker stop mcp-wordpress # Stop the container
|
|
202
|
+
docker rm mcp-wordpress # Remove the container
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### NPM
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
npm run status # Check WordPress connection
|
|
209
|
+
npm run health # Full system health check
|
|
210
|
+
npm run verify-claude # Verify Claude Desktop integration
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### DTX
|
|
214
|
+
|
|
215
|
+
```bash
|
|
216
|
+
npm run build # Rebuild the DTX package
|
|
217
|
+
```
|
|
@@ -12,7 +12,7 @@ This guide provides step-by-step instructions for setting up the MCP WordPress s
|
|
|
12
12
|
docker pull docdyhr/mcp-wordpress:latest
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
### 2.
|
|
15
|
+
### 2. Add to Claude Desktop configuration
|
|
16
16
|
|
|
17
17
|
## 🎯 Claude Desktop Integration (Recommended)
|
|
18
18
|
|
|
@@ -111,12 +111,12 @@ The DTX package supports multi-site configuration, but requires manual setup:
|
|
|
111
111
|
}
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
2. **Place the file
|
|
114
|
+
2. **Place the file in one of these locations:**
|
|
115
115
|
- **macOS/Linux**: `~/mcp-wordpress.config.json`
|
|
116
116
|
- **Windows**: `%USERPROFILE%\mcp-wordpress.config.json`
|
|
117
117
|
- **DTX Install Directory**: Next to the DTX package files
|
|
118
118
|
|
|
119
|
-
3. **Skip the DTX configuration
|
|
119
|
+
3. **Skip the DTX configuration prompts (or enter dummy values)**
|
|
120
120
|
|
|
121
121
|
4. **Restart Claude Desktop** - the server will detect and use your config file
|
|
122
122
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mcp-wordpress",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.1",
|
|
4
4
|
"description": "Comprehensive Model Context Protocol server for WordPress management with 59 tools, performance monitoring, intelligent caching, auto-generated documentation, Docker support, TypeScript, and production-ready authentication",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"mcp",
|
|
Binary file
|