mcp-wordpress 2.3.0 → 2.4.0
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 +503 -0
- package/dist/client/api.d.ts +90 -0
- package/dist/client/api.d.ts.map +1 -1
- package/dist/client/api.js +90 -0
- package/dist/client/api.js.map +1 -1
- package/dist/tools/media.d.ts +43 -4
- package/dist/tools/media.d.ts.map +1 -1
- package/dist/tools/media.js +43 -4
- package/dist/tools/media.js.map +1 -1
- package/dist/tools/posts.d.ts +225 -4
- package/dist/tools/posts.d.ts.map +1 -1
- package/dist/tools/posts.js +225 -4
- package/dist/tools/posts.js.map +1 -1
- package/docs/DOCKER_PUBLISHING_TROUBLESHOOTING.md +233 -0
- package/docs/PUBLISHING-TROUBLESHOOTING.md +227 -0
- package/docs/api/README.md +53 -11
- package/docs/api/openapi.json +10 -10
- package/docs/api/summary.json +1 -1
- package/docs/api/tools/wp_create_post.md +9 -3
- package/docs/api/tools/wp_delete_post.md +2 -3
- package/docs/api/tools/wp_get_current_user.md +7 -1
- package/docs/api/tools/wp_get_post.md +2 -3
- package/docs/api/tools/wp_get_post_revisions.md +1 -1
- package/docs/api/tools/wp_list_posts.md +10 -3
- package/docs/api/tools/wp_list_users.md +8 -1
- package/docs/api/tools/wp_search_site.md +8 -1
- package/docs/api/tools/wp_test_auth.md +8 -1
- package/docs/api/tools/wp_update_post.md +2 -3
- package/docs/examples/docker-production.md +801 -0
- package/docs/examples/multi-site-setup.md +575 -0
- package/docs/examples/single-site-setup.md +390 -0
- package/docs/examples/use-case-workflows.md +469 -0
- package/package.json +4 -1
- package/src/client/api.ts +90 -0
- package/src/tools/media.ts +43 -4
- package/src/tools/posts.ts +225 -4
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Publishing Troubleshooting Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This guide helps troubleshoot and resolve publishing issues for the MCP WordPress project. The project publishes
|
|
6
|
+
to two main targets:
|
|
7
|
+
|
|
8
|
+
1. **NPM Registry** - Node.js package
|
|
9
|
+
2. **Docker Hub** - Container images
|
|
10
|
+
|
|
11
|
+
## Automated Publishing Process
|
|
12
|
+
|
|
13
|
+
### Normal Flow
|
|
14
|
+
|
|
15
|
+
1. **Push to main branch** → triggers semantic-release
|
|
16
|
+
2. **Semantic-release** → creates release, publishes to NPM, creates GitHub release
|
|
17
|
+
3. **GitHub release created** → triggers Docker publishing
|
|
18
|
+
4. **Verification workflow** → checks both NPM and Docker Hub
|
|
19
|
+
5. **Success** → all done, or **Failure** → creates issue and triggers retry
|
|
20
|
+
|
|
21
|
+
### Workflow Files
|
|
22
|
+
|
|
23
|
+
- `.github/workflows/release.yml` - Main release workflow
|
|
24
|
+
- `.github/workflows/docker-publish.yml` - Manual/fallback Docker publishing
|
|
25
|
+
- `.github/workflows/verify-release.yml` - Verification and retry logic
|
|
26
|
+
|
|
27
|
+
## Common Issues and Solutions
|
|
28
|
+
|
|
29
|
+
### 1. Docker Publishing Failed (NPM Succeeded)
|
|
30
|
+
|
|
31
|
+
**Symptoms:**
|
|
32
|
+
|
|
33
|
+
- NPM has the new version
|
|
34
|
+
- Docker Hub is missing the version
|
|
35
|
+
- Verification workflow creates an issue
|
|
36
|
+
|
|
37
|
+
**Causes:**
|
|
38
|
+
|
|
39
|
+
- Docker Hub credentials expired
|
|
40
|
+
- Docker build failure (platform issues, Dockerfile errors)
|
|
41
|
+
- Network timeouts
|
|
42
|
+
- Docker Hub rate limiting
|
|
43
|
+
|
|
44
|
+
**Solutions:**
|
|
45
|
+
|
|
46
|
+
#### Option A: Automatic Retry (Recommended)
|
|
47
|
+
|
|
48
|
+
The verification workflow should automatically trigger a retry. Check the workflow run logs.
|
|
49
|
+
|
|
50
|
+
#### Option B: Manual Workflow Trigger
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Replace v2.3.0 with your version
|
|
54
|
+
gh workflow run docker-publish.yml -f tag=v2.3.0 -f push=true
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Option C: Local Manual Build (Emergency)
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Use the provided script
|
|
61
|
+
./scripts/manual-docker-publish.sh 2.3.0
|
|
62
|
+
|
|
63
|
+
# Or manually:
|
|
64
|
+
docker build --platform linux/amd64,linux/arm64 \
|
|
65
|
+
--tag docdyhr/mcp-wordpress:2.3.0 \
|
|
66
|
+
--tag docdyhr/mcp-wordpress:latest \
|
|
67
|
+
--push .
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 2. NPM Publishing Failed
|
|
71
|
+
|
|
72
|
+
**Symptoms:**
|
|
73
|
+
|
|
74
|
+
- GitHub release created but NPM doesn't have the version
|
|
75
|
+
- Semantic-release logs show NPM errors
|
|
76
|
+
|
|
77
|
+
**Causes:**
|
|
78
|
+
|
|
79
|
+
- NPM_TOKEN expired or invalid
|
|
80
|
+
- Package.json issues
|
|
81
|
+
- NPM registry issues
|
|
82
|
+
|
|
83
|
+
**Solutions:**
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# Verify you're logged in
|
|
87
|
+
npm whoami
|
|
88
|
+
|
|
89
|
+
# Manual publish
|
|
90
|
+
npm publish
|
|
91
|
+
|
|
92
|
+
# Or with explicit registry
|
|
93
|
+
npm publish --registry https://registry.npmjs.org
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 3. Both NPM and Docker Failed
|
|
97
|
+
|
|
98
|
+
**Causes:**
|
|
99
|
+
|
|
100
|
+
- GitHub secrets issues (NPM_TOKEN, DOCKER_USERNAME, DOCKER_PASSWORD)
|
|
101
|
+
- Semantic-release configuration problems
|
|
102
|
+
- Build/test failures
|
|
103
|
+
|
|
104
|
+
**Solutions:**
|
|
105
|
+
|
|
106
|
+
1. **Check secrets in GitHub repository settings**
|
|
107
|
+
2. **Verify semantic-release configuration**
|
|
108
|
+
3. **Run release dry-run locally:**
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
npm run release:dry
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### 4. Version Already Exists
|
|
115
|
+
|
|
116
|
+
**Symptoms:**
|
|
117
|
+
|
|
118
|
+
- "Version 2.3.0 already exists" errors
|
|
119
|
+
|
|
120
|
+
**Solutions:**
|
|
121
|
+
|
|
122
|
+
For NPM:
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
# You cannot overwrite existing versions
|
|
126
|
+
# You need to bump the version and release again
|
|
127
|
+
npm version patch # or minor/major
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
For Docker:
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
# You can overwrite Docker tags
|
|
134
|
+
docker build --platform linux/amd64,linux/arm64 \
|
|
135
|
+
--tag docdyhr/mcp-wordpress:2.3.0 --push .
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Verification
|
|
139
|
+
|
|
140
|
+
### Check NPM Publication
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
# Check if version exists
|
|
144
|
+
npm view mcp-wordpress@2.3.0
|
|
145
|
+
|
|
146
|
+
# Check latest version
|
|
147
|
+
npm view mcp-wordpress version
|
|
148
|
+
|
|
149
|
+
# View all versions
|
|
150
|
+
npm view mcp-wordpress versions --json
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Check Docker Hub Publication
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
# Pull the image
|
|
157
|
+
docker pull docdyhr/mcp-wordpress:2.3.0
|
|
158
|
+
|
|
159
|
+
# Check manifest
|
|
160
|
+
docker manifest inspect docdyhr/mcp-wordpress:2.3.0
|
|
161
|
+
|
|
162
|
+
# API check
|
|
163
|
+
curl -s https://hub.docker.com/v2/repositories/docdyhr/mcp-wordpress/tags | jq '.results[] | select(.name == "2.3.0")'
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## Emergency Manual Release Process
|
|
167
|
+
|
|
168
|
+
If all automated processes fail:
|
|
169
|
+
|
|
170
|
+
1. **Prepare the release:**
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
git checkout main
|
|
174
|
+
git pull origin main
|
|
175
|
+
npm ci
|
|
176
|
+
npm run build
|
|
177
|
+
npm test
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
2. **Manual NPM publish:**
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
npm publish
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
3. **Manual Docker publish:**
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
./scripts/manual-docker-publish.sh
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
4. **Create GitHub release:**
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
gh release create v2.3.0 --title "v2.3.0" --notes "Manual release"
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Prevention
|
|
199
|
+
|
|
200
|
+
### Regular Maintenance
|
|
201
|
+
|
|
202
|
+
1. **Rotate secrets annually:**
|
|
203
|
+
- NPM_TOKEN
|
|
204
|
+
- DOCKER_USERNAME/DOCKER_PASSWORD
|
|
205
|
+
|
|
206
|
+
2. **Test publishing process:**
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
npm run release:dry
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
3. **Monitor workflow success rates**
|
|
213
|
+
|
|
214
|
+
### Monitoring
|
|
215
|
+
|
|
216
|
+
- **GitHub Actions** - Check workflow success rates
|
|
217
|
+
- **NPM** - Monitor download stats for version gaps
|
|
218
|
+
- **Docker Hub** - Check pull statistics
|
|
219
|
+
- **Verification workflow** - Reviews automated issue creation
|
|
220
|
+
|
|
221
|
+
## Contact
|
|
222
|
+
|
|
223
|
+
For persistent issues:
|
|
224
|
+
|
|
225
|
+
1. Check existing GitHub issues with label `publishing-failure`
|
|
226
|
+
2. Create new issue with publishing logs
|
|
227
|
+
3. Contact maintainers if critical
|
package/docs/api/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
The WordPress MCP Server provides **59 tools** across **10 categories** for comprehensive WordPress management through the Model Context Protocol.
|
|
13
13
|
|
|
14
|
-
**Last Updated:**
|
|
14
|
+
**Last Updated:** 19.7.2025
|
|
15
15
|
**Version:** 1.2.0
|
|
16
16
|
**Coverage:** 59/59 tools with examples
|
|
17
17
|
|
|
@@ -66,7 +66,14 @@ wp_get_site_settings --site=production
|
|
|
66
66
|
| [`wp_create_category`](./tools/wp_create_category.md) | taxonomy | Creates a new category. |
|
|
67
67
|
| [`wp_create_comment`](./tools/wp_create_comment.md) | comment | Creates a new comment on a post. |
|
|
68
68
|
| [`wp_create_page`](./tools/wp_create_page.md) | page | Creates a new page. |
|
|
69
|
-
| [`wp_create_post`](./tools/wp_create_post.md) | post | Creates a new post.
|
|
69
|
+
| [`wp_create_post`](./tools/wp_create_post.md) | post | Creates a new WordPress post with comprehensive validation and detailed success feedback including management links.
|
|
70
|
+
|
|
71
|
+
**Usage Examples:**
|
|
72
|
+
• Simple post: `wp_create_post --title="My New Post" --content="<p>Hello World!</p>"`
|
|
73
|
+
• Draft post: `wp_create_post --title="Draft Post" --status="draft"`
|
|
74
|
+
• Categorized post: `wp_create_post --title="Tech News" --categories=[1,5] --tags=[10,20]`
|
|
75
|
+
• Scheduled post: `wp_create_post --title="Future Post" --status="future" --date="2024-12-25T10:00:00"`
|
|
76
|
+
• Complete post: `wp_create_post --title="Complete Post" --content="<p>Content</p>" --excerpt="Summary" --status="publish"` |
|
|
70
77
|
| [`wp_create_tag`](./tools/wp_create_tag.md) | taxonomy | Creates a new tag. |
|
|
71
78
|
| [`wp_create_user`](./tools/wp_create_user.md) | user | Creates a new user. |
|
|
72
79
|
| [`wp_delete_application_password`](./tools/wp_delete_application_password.md) | site | Revokes an existing application password. |
|
|
@@ -74,19 +81,25 @@ wp_get_site_settings --site=production
|
|
|
74
81
|
| [`wp_delete_comment`](./tools/wp_delete_comment.md) | comment | Deletes a comment. |
|
|
75
82
|
| [`wp_delete_media`](./tools/wp_delete_media.md) | media | Deletes a media item. |
|
|
76
83
|
| [`wp_delete_page`](./tools/wp_delete_page.md) | page | Deletes a page. |
|
|
77
|
-
| [`wp_delete_post`](./tools/wp_delete_post.md) | post | Deletes a post. |
|
|
84
|
+
| [`wp_delete_post`](./tools/wp_delete_post.md) | post | Deletes a WordPress post with option for permanent deletion or moving to trash. |
|
|
78
85
|
| [`wp_delete_tag`](./tools/wp_delete_tag.md) | taxonomy | Deletes a tag. |
|
|
79
86
|
| [`wp_delete_user`](./tools/wp_delete_user.md) | user | Deletes a user. |
|
|
80
87
|
| [`wp_get_application_passwords`](./tools/wp_get_application_passwords.md) | site | Lists application passwords for a specific user. |
|
|
81
88
|
| [`wp_get_auth_status`](./tools/wp_get_auth_status.md) | auth | Gets the current authentication status for a configured WordPress site. |
|
|
82
89
|
| [`wp_get_category`](./tools/wp_get_category.md) | taxonomy | Retrieves a single category by its ID. |
|
|
83
90
|
| [`wp_get_comment`](./tools/wp_get_comment.md) | comment | Retrieves a single comment by its ID. |
|
|
84
|
-
| [`wp_get_current_user`](./tools/wp_get_current_user.md) | user | Retrieves the currently authenticated user.
|
|
91
|
+
| [`wp_get_current_user`](./tools/wp_get_current_user.md) | user | Retrieves the currently authenticated user with comprehensive profile information including roles, capabilities, and account details.
|
|
92
|
+
|
|
93
|
+
**Usage Examples:**
|
|
94
|
+
• Get current user: `wp_get_current_user`
|
|
95
|
+
• Check permissions: Use this to verify your current user's capabilities and roles
|
|
96
|
+
• Account verification: Confirm you're authenticated with the correct account
|
|
97
|
+
• Profile details: View registration date, email, and user metadata |
|
|
85
98
|
| [`wp_get_media`](./tools/wp_get_media.md) | media | Retrieves a single media item by its ID. |
|
|
86
99
|
| [`wp_get_page`](./tools/wp_get_page.md) | page | Retrieves a single page by its ID. |
|
|
87
100
|
| [`wp_get_page_revisions`](./tools/wp_get_page_revisions.md) | page | Retrieves revisions for a specific page. |
|
|
88
|
-
| [`wp_get_post`](./tools/wp_get_post.md) | post | Retrieves a single post
|
|
89
|
-
| [`wp_get_post_revisions`](./tools/wp_get_post_revisions.md) | post | Retrieves
|
|
101
|
+
| [`wp_get_post`](./tools/wp_get_post.md) | post | Retrieves detailed information about a single post including metadata, content statistics, and management links. |
|
|
102
|
+
| [`wp_get_post_revisions`](./tools/wp_get_post_revisions.md) | post | Retrieves the revision history for a specific post showing author and modification dates. |
|
|
90
103
|
| [`wp_get_site_settings`](./tools/wp_get_site_settings.md) | site | Retrieves the general settings for a WordPress site. |
|
|
91
104
|
| [`wp_get_tag`](./tools/wp_get_tag.md) | taxonomy | Retrieves a single tag by its ID. |
|
|
92
105
|
| [`wp_get_user`](./tools/wp_get_user.md) | user | Retrieves a single user by their ID. |
|
|
@@ -94,24 +107,53 @@ wp_get_site_settings --site=production
|
|
|
94
107
|
| [`wp_list_comments`](./tools/wp_list_comments.md) | comment | Lists comments from a WordPress site, with filters. |
|
|
95
108
|
| [`wp_list_media`](./tools/wp_list_media.md) | media | Lists media items from a WordPress site, with filters. |
|
|
96
109
|
| [`wp_list_pages`](./tools/wp_list_pages.md) | page | Lists pages from a WordPress site, with filters. |
|
|
97
|
-
| [`wp_list_posts`](./tools/wp_list_posts.md) | post | Lists posts from a WordPress site, with
|
|
110
|
+
| [`wp_list_posts`](./tools/wp_list_posts.md) | post | Lists posts from a WordPress site with comprehensive filtering options. Supports search, status filtering, and category/tag filtering with enhanced metadata display.
|
|
111
|
+
|
|
112
|
+
**Usage Examples:**
|
|
113
|
+
• Basic listing: `wp_list_posts`
|
|
114
|
+
• Search posts: `wp_list_posts --search="AI trends"`
|
|
115
|
+
• Filter by status: `wp_list_posts --status="draft"`
|
|
116
|
+
• Category filtering: `wp_list_posts --categories=[1,2,3]`
|
|
117
|
+
• Paginated results: `wp_list_posts --per_page=20 --page=2`
|
|
118
|
+
• Combined filters: `wp_list_posts --search="WordPress" --status="publish" --per_page=10` |
|
|
98
119
|
| [`wp_list_tags`](./tools/wp_list_tags.md) | taxonomy | Lists tags from a WordPress site. |
|
|
99
|
-
| [`wp_list_users`](./tools/wp_list_users.md) | user | Lists users from a WordPress site
|
|
120
|
+
| [`wp_list_users`](./tools/wp_list_users.md) | user | Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.
|
|
121
|
+
|
|
122
|
+
**Usage Examples:**
|
|
123
|
+
• List all users: `wp_list_users`
|
|
124
|
+
• Search users: `wp_list_users --search="john"`
|
|
125
|
+
• Filter by role: `wp_list_users --roles=["editor","author"]`
|
|
126
|
+
• Find admins: `wp_list_users --roles=["administrator"]`
|
|
127
|
+
• Combined search: `wp_list_users --search="smith" --roles=["subscriber"]` |
|
|
100
128
|
| [`wp_performance_alerts`](./tools/wp_performance_alerts.md) | performance | Get performance alerts and anomaly detection results |
|
|
101
129
|
| [`wp_performance_benchmark`](./tools/wp_performance_benchmark.md) | performance | Compare current performance against industry benchmarks |
|
|
102
130
|
| [`wp_performance_export`](./tools/wp_performance_export.md) | performance | Export comprehensive performance report |
|
|
103
131
|
| [`wp_performance_history`](./tools/wp_performance_history.md) | performance | Get historical performance data and trends |
|
|
104
132
|
| [`wp_performance_optimize`](./tools/wp_performance_optimize.md) | performance | Get optimization recommendations and insights |
|
|
105
133
|
| [`wp_performance_stats`](./tools/wp_performance_stats.md) | performance | Get real-time performance statistics and metrics |
|
|
106
|
-
| [`wp_search_site`](./tools/wp_search_site.md) | site | Performs a site-wide search for content.
|
|
134
|
+
| [`wp_search_site`](./tools/wp_search_site.md) | site | Performs a site-wide search for content across posts, pages, and media with comprehensive results and metadata.
|
|
135
|
+
|
|
136
|
+
**Usage Examples:**
|
|
137
|
+
• Search everything: `wp_search_site --term="WordPress"`
|
|
138
|
+
• Search posts only: `wp_search_site --term="tutorial" --type="posts"`
|
|
139
|
+
• Search pages: `wp_search_site --term="about" --type="pages"`
|
|
140
|
+
• Search media: `wp_search_site --term="logo" --type="media"`
|
|
141
|
+
• Find specific content: `wp_search_site --term="contact form"` |
|
|
107
142
|
| [`wp_spam_comment`](./tools/wp_spam_comment.md) | comment | Marks a comment as spam. |
|
|
108
143
|
| [`wp_switch_auth_method`](./tools/wp_switch_auth_method.md) | auth | Switches the authentication method for a site for the current session. |
|
|
109
|
-
| [`wp_test_auth`](./tools/wp_test_auth.md) | auth | Tests the authentication and connectivity for a configured WordPress site.
|
|
144
|
+
| [`wp_test_auth`](./tools/wp_test_auth.md) | auth | Tests the authentication and connectivity for a configured WordPress site with detailed connection diagnostics.
|
|
145
|
+
|
|
146
|
+
**Usage Examples:**
|
|
147
|
+
• Test connection: `wp_test_auth`
|
|
148
|
+
• Multi-site test: `wp_test_auth --site="my-site"`
|
|
149
|
+
• Verify setup: Use this after configuring new credentials
|
|
150
|
+
• Troubleshoot: Run when experiencing connection issues
|
|
151
|
+
• Health check: Regular verification of WordPress connectivity |
|
|
110
152
|
| [`wp_update_category`](./tools/wp_update_category.md) | taxonomy | Updates an existing category. |
|
|
111
153
|
| [`wp_update_comment`](./tools/wp_update_comment.md) | comment | Updates an existing comment. |
|
|
112
154
|
| [`wp_update_media`](./tools/wp_update_media.md) | media | Updates the metadata of an existing media item. |
|
|
113
155
|
| [`wp_update_page`](./tools/wp_update_page.md) | page | Updates an existing page. |
|
|
114
|
-
| [`wp_update_post`](./tools/wp_update_post.md) | post | Updates an existing post. |
|
|
156
|
+
| [`wp_update_post`](./tools/wp_update_post.md) | post | Updates an existing WordPress post with validation and detailed confirmation. |
|
|
115
157
|
| [`wp_update_site_settings`](./tools/wp_update_site_settings.md) | site | Updates one or more general settings for a WordPress site. |
|
|
116
158
|
| [`wp_update_tag`](./tools/wp_update_tag.md) | taxonomy | Updates an existing tag. |
|
|
117
159
|
| [`wp_update_user`](./tools/wp_update_user.md) | user | Updates an existing user. |
|
package/docs/api/openapi.json
CHANGED
|
@@ -487,7 +487,7 @@
|
|
|
487
487
|
},
|
|
488
488
|
"/tools/wp_create_post": {
|
|
489
489
|
"post": {
|
|
490
|
-
"summary": "Creates a new post
|
|
490
|
+
"summary": "Creates a new WordPress post with comprehensive validation and detailed success feedback including management links.\n\n**Usage Examples:**\n• Simple post: `wp_create_post --title=\"My New Post\" --content=\"<p>Hello World!</p>\"`\n• Draft post: `wp_create_post --title=\"Draft Post\" --status=\"draft\"`\n• Categorized post: `wp_create_post --title=\"Tech News\" --categories=[1,5] --tags=[10,20]`\n• Scheduled post: `wp_create_post --title=\"Future Post\" --status=\"future\" --date=\"2024-12-25T10:00:00\"`\n• Complete post: `wp_create_post --title=\"Complete Post\" --content=\"<p>Content</p>\" --excerpt=\"Summary\" --status=\"publish\"`",
|
|
491
491
|
"description": "Execute wp_create_post MCP tool",
|
|
492
492
|
"tags": [
|
|
493
493
|
"post"
|
|
@@ -938,7 +938,7 @@
|
|
|
938
938
|
},
|
|
939
939
|
"/tools/wp_delete_post": {
|
|
940
940
|
"post": {
|
|
941
|
-
"summary": "Deletes a post.",
|
|
941
|
+
"summary": "Deletes a WordPress post with option for permanent deletion or moving to trash.",
|
|
942
942
|
"description": "Execute wp_delete_post MCP tool",
|
|
943
943
|
"tags": [
|
|
944
944
|
"post"
|
|
@@ -1281,7 +1281,7 @@
|
|
|
1281
1281
|
},
|
|
1282
1282
|
"/tools/wp_get_current_user": {
|
|
1283
1283
|
"post": {
|
|
1284
|
-
"summary": "Retrieves the currently authenticated user
|
|
1284
|
+
"summary": "Retrieves the currently authenticated user with comprehensive profile information including roles, capabilities, and account details.\n\n**Usage Examples:**\n• Get current user: `wp_get_current_user`\n• Check permissions: Use this to verify your current user's capabilities and roles\n• Account verification: Confirm you're authenticated with the correct account\n• Profile details: View registration date, email, and user metadata",
|
|
1285
1285
|
"description": "Execute wp_get_current_user MCP tool",
|
|
1286
1286
|
"tags": [
|
|
1287
1287
|
"user"
|
|
@@ -1469,7 +1469,7 @@
|
|
|
1469
1469
|
},
|
|
1470
1470
|
"/tools/wp_get_post": {
|
|
1471
1471
|
"post": {
|
|
1472
|
-
"summary": "Retrieves a single post
|
|
1472
|
+
"summary": "Retrieves detailed information about a single post including metadata, content statistics, and management links.",
|
|
1473
1473
|
"description": "Execute wp_get_post MCP tool",
|
|
1474
1474
|
"tags": [
|
|
1475
1475
|
"post"
|
|
@@ -1518,7 +1518,7 @@
|
|
|
1518
1518
|
},
|
|
1519
1519
|
"/tools/wp_get_post_revisions": {
|
|
1520
1520
|
"post": {
|
|
1521
|
-
"summary": "Retrieves
|
|
1521
|
+
"summary": "Retrieves the revision history for a specific post showing author and modification dates.",
|
|
1522
1522
|
"description": "Execute wp_get_post_revisions MCP tool",
|
|
1523
1523
|
"tags": [
|
|
1524
1524
|
"post"
|
|
@@ -1932,7 +1932,7 @@
|
|
|
1932
1932
|
},
|
|
1933
1933
|
"/tools/wp_list_posts": {
|
|
1934
1934
|
"post": {
|
|
1935
|
-
"summary": "Lists posts from a WordPress site, with filters
|
|
1935
|
+
"summary": "Lists posts from a WordPress site with comprehensive filtering options. Supports search, status filtering, and category/tag filtering with enhanced metadata display.\n\n**Usage Examples:**\n• Basic listing: `wp_list_posts`\n• Search posts: `wp_list_posts --search=\"AI trends\"`\n• Filter by status: `wp_list_posts --status=\"draft\"`\n• Category filtering: `wp_list_posts --categories=[1,2,3]`\n• Paginated results: `wp_list_posts --per_page=20 --page=2`\n• Combined filters: `wp_list_posts --search=\"WordPress\" --status=\"publish\" --per_page=10`",
|
|
1936
1936
|
"description": "Execute wp_list_posts MCP tool",
|
|
1937
1937
|
"tags": [
|
|
1938
1938
|
"post"
|
|
@@ -2049,7 +2049,7 @@
|
|
|
2049
2049
|
},
|
|
2050
2050
|
"/tools/wp_list_users": {
|
|
2051
2051
|
"post": {
|
|
2052
|
-
"summary": "Lists users from a WordPress site
|
|
2052
|
+
"summary": "Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.\n\n**Usage Examples:**\n• List all users: `wp_list_users`\n• Search users: `wp_list_users --search=\"john\"`\n• Filter by role: `wp_list_users --roles=[\"editor\",\"author\"]`\n• Find admins: `wp_list_users --roles=[\"administrator\"]`\n• Combined search: `wp_list_users --search=\"smith\" --roles=[\"subscriber\"]`",
|
|
2053
2053
|
"description": "Execute wp_list_users MCP tool",
|
|
2054
2054
|
"tags": [
|
|
2055
2055
|
"user"
|
|
@@ -2511,7 +2511,7 @@
|
|
|
2511
2511
|
},
|
|
2512
2512
|
"/tools/wp_search_site": {
|
|
2513
2513
|
"post": {
|
|
2514
|
-
"summary": "Performs a site-wide search for content
|
|
2514
|
+
"summary": "Performs a site-wide search for content across posts, pages, and media with comprehensive results and metadata.\n\n**Usage Examples:**\n• Search everything: `wp_search_site --term=\"WordPress\"`\n• Search posts only: `wp_search_site --term=\"tutorial\" --type=\"posts\"`\n• Search pages: `wp_search_site --term=\"about\" --type=\"pages\"`\n• Search media: `wp_search_site --term=\"logo\" --type=\"media\"`\n• Find specific content: `wp_search_site --term=\"contact form\"`",
|
|
2515
2515
|
"description": "Execute wp_search_site MCP tool",
|
|
2516
2516
|
"tags": [
|
|
2517
2517
|
"site"
|
|
@@ -2674,7 +2674,7 @@
|
|
|
2674
2674
|
},
|
|
2675
2675
|
"/tools/wp_test_auth": {
|
|
2676
2676
|
"post": {
|
|
2677
|
-
"summary": "Tests the authentication and connectivity for a configured WordPress site
|
|
2677
|
+
"summary": "Tests the authentication and connectivity for a configured WordPress site with detailed connection diagnostics.\n\n**Usage Examples:**\n• Test connection: `wp_test_auth`\n• Multi-site test: `wp_test_auth --site=\"my-site\"`\n• Verify setup: Use this after configuring new credentials\n• Troubleshoot: Run when experiencing connection issues\n• Health check: Regular verification of WordPress connectivity",
|
|
2678
2678
|
"description": "Execute wp_test_auth MCP tool",
|
|
2679
2679
|
"tags": [
|
|
2680
2680
|
"auth"
|
|
@@ -2967,7 +2967,7 @@
|
|
|
2967
2967
|
},
|
|
2968
2968
|
"/tools/wp_update_post": {
|
|
2969
2969
|
"post": {
|
|
2970
|
-
"summary": "Updates an existing post.",
|
|
2970
|
+
"summary": "Updates an existing WordPress post with validation and detailed confirmation.",
|
|
2971
2971
|
"description": "Execute wp_update_post MCP tool",
|
|
2972
2972
|
"tags": [
|
|
2973
2973
|
"post"
|
package/docs/api/summary.json
CHANGED
|
@@ -2,7 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Creates a new post.
|
|
5
|
+
Creates a new WordPress post with comprehensive validation and detailed success feedback including management links.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• Simple post: `wp_create_post --title="My New Post" --content="<p>Hello World!</p>"`
|
|
9
|
+
• Draft post: `wp_create_post --title="Draft Post" --status="draft"`
|
|
10
|
+
• Categorized post: `wp_create_post --title="Tech News" --categories=[1,5] --tags=[10,20]`
|
|
11
|
+
• Scheduled post: `wp_create_post --title="Future Post" --status="future" --date="2024-12-25T10:00:00"`
|
|
12
|
+
• Complete post: `wp_create_post --title="Complete Post" --content="<p>Content</p>" --excerpt="Summary" --status="publish"`
|
|
6
13
|
|
|
7
14
|
## Parameters
|
|
8
15
|
|
|
@@ -75,8 +82,7 @@ wp_create_post --title="Example Post Title" --content="This is example content f
|
|
|
75
82
|
|
|
76
83
|
**Endpoint:** `/wp-json/wp/v2/posts`
|
|
77
84
|
|
|
78
|
-
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available
|
|
79
|
-
parameters are determined by WordPress core functionality.
|
|
85
|
+
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
|
|
80
86
|
|
|
81
87
|
### WordPress Documentation
|
|
82
88
|
- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Deletes a post.
|
|
5
|
+
Deletes a WordPress post with option for permanent deletion or moving to trash.
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -46,8 +46,7 @@ wp_delete_post --id="123"
|
|
|
46
46
|
|
|
47
47
|
**Endpoint:** `/wp-json/wp/v2/posts/{id}`
|
|
48
48
|
|
|
49
|
-
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available
|
|
50
|
-
parameters are determined by WordPress core functionality.
|
|
49
|
+
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
|
|
51
50
|
|
|
52
51
|
### WordPress Documentation
|
|
53
52
|
- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
|
|
@@ -2,7 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Retrieves the currently authenticated user.
|
|
5
|
+
Retrieves the currently authenticated user with comprehensive profile information including roles, capabilities, and account details.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• Get current user: `wp_get_current_user`
|
|
9
|
+
• Check permissions: Use this to verify your current user's capabilities and roles
|
|
10
|
+
• Account verification: Confirm you're authenticated with the correct account
|
|
11
|
+
• Profile details: View registration date, email, and user metadata
|
|
6
12
|
|
|
7
13
|
## Parameters
|
|
8
14
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Retrieves a single post
|
|
5
|
+
Retrieves detailed information about a single post including metadata, content statistics, and management links.
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -48,8 +48,7 @@ wp_get_post --id="123"
|
|
|
48
48
|
|
|
49
49
|
**Endpoint:** `/wp-json/wp/v2/posts/{id}`
|
|
50
50
|
|
|
51
|
-
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available
|
|
52
|
-
parameters are determined by WordPress core functionality.
|
|
51
|
+
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
|
|
53
52
|
|
|
54
53
|
### WordPress Documentation
|
|
55
54
|
- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
|
|
@@ -2,7 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Lists posts from a WordPress site, with
|
|
5
|
+
Lists posts from a WordPress site with comprehensive filtering options. Supports search, status filtering, and category/tag filtering with enhanced metadata display.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• Basic listing: `wp_list_posts`
|
|
9
|
+
• Search posts: `wp_list_posts --search="AI trends"`
|
|
10
|
+
• Filter by status: `wp_list_posts --status="draft"`
|
|
11
|
+
• Category filtering: `wp_list_posts --categories=[1,2,3]`
|
|
12
|
+
• Paginated results: `wp_list_posts --per_page=20 --page=2`
|
|
13
|
+
• Combined filters: `wp_list_posts --search="WordPress" --status="publish" --per_page=10`
|
|
6
14
|
|
|
7
15
|
## Parameters
|
|
8
16
|
|
|
@@ -92,8 +100,7 @@ wp_list_posts --per_page="10" --search="wordpress" --status="publish" --categori
|
|
|
92
100
|
|
|
93
101
|
**Endpoint:** `/wp-json/wp/v2/posts`
|
|
94
102
|
|
|
95
|
-
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available
|
|
96
|
-
parameters are determined by WordPress core functionality.
|
|
103
|
+
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
|
|
97
104
|
|
|
98
105
|
### WordPress Documentation
|
|
99
106
|
- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
|
|
@@ -2,7 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Lists users from a WordPress site
|
|
5
|
+
Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• List all users: `wp_list_users`
|
|
9
|
+
• Search users: `wp_list_users --search="john"`
|
|
10
|
+
• Filter by role: `wp_list_users --roles=["editor","author"]`
|
|
11
|
+
• Find admins: `wp_list_users --roles=["administrator"]`
|
|
12
|
+
• Combined search: `wp_list_users --search="smith" --roles=["subscriber"]`
|
|
6
13
|
|
|
7
14
|
## Parameters
|
|
8
15
|
|
|
@@ -2,7 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Performs a site-wide search for content.
|
|
5
|
+
Performs a site-wide search for content across posts, pages, and media with comprehensive results and metadata.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• Search everything: `wp_search_site --term="WordPress"`
|
|
9
|
+
• Search posts only: `wp_search_site --term="tutorial" --type="posts"`
|
|
10
|
+
• Search pages: `wp_search_site --term="about" --type="pages"`
|
|
11
|
+
• Search media: `wp_search_site --term="logo" --type="media"`
|
|
12
|
+
• Find specific content: `wp_search_site --term="contact form"`
|
|
6
13
|
|
|
7
14
|
## Parameters
|
|
8
15
|
|
|
@@ -2,7 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Tests the authentication and connectivity for a configured WordPress site.
|
|
5
|
+
Tests the authentication and connectivity for a configured WordPress site with detailed connection diagnostics.
|
|
6
|
+
|
|
7
|
+
**Usage Examples:**
|
|
8
|
+
• Test connection: `wp_test_auth`
|
|
9
|
+
• Multi-site test: `wp_test_auth --site="my-site"`
|
|
10
|
+
• Verify setup: Use this after configuring new credentials
|
|
11
|
+
• Troubleshoot: Run when experiencing connection issues
|
|
12
|
+
• Health check: Regular verification of WordPress connectivity
|
|
6
13
|
|
|
7
14
|
## Parameters
|
|
8
15
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|

|
|
4
4
|
|
|
5
|
-
Updates an existing post.
|
|
5
|
+
Updates an existing WordPress post with validation and detailed confirmation.
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -73,8 +73,7 @@ wp_update_post --id="123" --title="Example Post Title" --content="This is exampl
|
|
|
73
73
|
|
|
74
74
|
**Endpoint:** `/wp-json/wp/v2/posts/{id}`
|
|
75
75
|
|
|
76
|
-
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available
|
|
77
|
-
parameters are determined by WordPress core functionality.
|
|
76
|
+
This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
|
|
78
77
|
|
|
79
78
|
### WordPress Documentation
|
|
80
79
|
- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
|