mcp-wordpress 2.10.0 → 2.10.2

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.
Files changed (198) hide show
  1. package/README.md +17 -19
  2. package/bin/mcp-wordpress.js +3 -3
  3. package/bin/setup.js +140 -141
  4. package/bin/status.js +112 -114
  5. package/dist/client/MockWordPressClient.d.ts.map +1 -1
  6. package/dist/client/MockWordPressClient.js.map +1 -1
  7. package/dist/client/SEOWordPressClient.d.ts.map +1 -1
  8. package/dist/client/SEOWordPressClient.js +16 -14
  9. package/dist/client/SEOWordPressClient.js.map +1 -1
  10. package/dist/client/index.d.ts +6 -6
  11. package/dist/client/index.js +6 -6
  12. package/dist/client/managers/AuthManager.d.ts.map +1 -1
  13. package/dist/client/managers/AuthManager.js +2 -2
  14. package/dist/client/managers/AuthManager.js.map +1 -1
  15. package/dist/client/managers/AuthenticationManager.js +1 -1
  16. package/dist/client/managers/JWTAuthImplementation.d.ts.map +1 -1
  17. package/dist/client/managers/JWTAuthImplementation.js +7 -7
  18. package/dist/client/managers/JWTAuthImplementation.js.map +1 -1
  19. package/dist/client/managers/composed/MigrationAdapter.js +1 -1
  20. package/dist/client/managers/composed/index.d.ts +2 -2
  21. package/dist/client/managers/composed/index.d.ts.map +1 -1
  22. package/dist/client/managers/composed/index.js +1 -1
  23. package/dist/client/managers/composed/index.js.map +1 -1
  24. package/dist/client/managers/implementations/ErrorHandlerImpl.d.ts.map +1 -1
  25. package/dist/client/managers/implementations/ErrorHandlerImpl.js +2 -4
  26. package/dist/client/managers/implementations/ErrorHandlerImpl.js.map +1 -1
  27. package/dist/client/managers/implementations/ParameterValidatorImpl.d.ts.map +1 -1
  28. package/dist/client/managers/implementations/ParameterValidatorImpl.js +1 -1
  29. package/dist/client/managers/implementations/ParameterValidatorImpl.js.map +1 -1
  30. package/dist/client/managers/interfaces/ManagerInterfaces.d.ts.map +1 -1
  31. package/dist/config/index.d.ts +3 -3
  32. package/dist/config/index.js +3 -3
  33. package/dist/docs/MarkdownFormatter.d.ts.map +1 -1
  34. package/dist/docs/MarkdownFormatter.js +7 -7
  35. package/dist/docs/MarkdownFormatter.js.map +1 -1
  36. package/dist/performance/PerformanceAnalytics.d.ts.map +1 -1
  37. package/dist/performance/PerformanceAnalytics.js +3 -1
  38. package/dist/performance/PerformanceAnalytics.js.map +1 -1
  39. package/dist/security/InputValidator.js +1 -1
  40. package/dist/security/SecurityCIPipeline.js +1 -1
  41. package/dist/security/SecurityCIPipeline.js.map +1 -1
  42. package/dist/security/SecurityConfig.d.ts.map +1 -1
  43. package/dist/security/SecurityConfig.js +6 -2
  44. package/dist/security/SecurityConfig.js.map +1 -1
  45. package/dist/server/index.d.ts +2 -2
  46. package/dist/server/index.js +2 -2
  47. package/dist/tools/cache.d.ts.map +1 -1
  48. package/dist/tools/cache.js.map +1 -1
  49. package/dist/tools/comments.d.ts.map +1 -1
  50. package/dist/tools/comments.js.map +1 -1
  51. package/dist/tools/performance.d.ts.map +1 -1
  52. package/dist/tools/performance.js.map +1 -1
  53. package/dist/tools/posts/PostHandlers.d.ts.map +1 -1
  54. package/dist/tools/posts/PostHandlers.js.map +1 -1
  55. package/dist/tools/seo/SEOTools.d.ts.map +1 -1
  56. package/dist/tools/seo/SEOTools.js.map +1 -1
  57. package/dist/tools/seo/analyzers/ContentAnalyzer.d.ts.map +1 -1
  58. package/dist/tools/seo/analyzers/ContentAnalyzer.js.map +1 -1
  59. package/dist/types/enhanced.d.ts +17 -17
  60. package/dist/types/enhanced.d.ts.map +1 -1
  61. package/dist/types/enhanced.js +2 -2
  62. package/dist/types/index.d.ts +2 -2
  63. package/dist/types/index.d.ts.map +1 -1
  64. package/dist/types/requests.d.ts +16 -16
  65. package/dist/types/tools.d.ts +46 -46
  66. package/dist/types/tools.d.ts.map +1 -1
  67. package/dist/utils/index.d.ts +7 -7
  68. package/dist/utils/index.js +7 -7
  69. package/docs/ARCHITECTURE.md +17 -17
  70. package/docs/BADGE_UPDATES.md +11 -11
  71. package/docs/CACHING.md +2 -0
  72. package/docs/CI_CD_IMPROVEMENTS.md +8 -5
  73. package/docs/CONFIGURATION.md +76 -46
  74. package/docs/DOCKER_PUBLISHING_TROUBLESHOOTING.md +11 -2
  75. package/docs/EVALUATION.md +16 -21
  76. package/docs/INCREMENTAL_COVERAGE.md +7 -3
  77. package/docs/INSTALLATION.md +33 -19
  78. package/docs/PUBLISHING-TROUBLESHOOTING.md +3 -2
  79. package/docs/SECURITY.md +17 -15
  80. package/docs/SECURITY_TESTING.md +3 -0
  81. package/docs/TROUBLESHOOTING.md +85 -36
  82. package/docs/api/README.md +118 -125
  83. package/docs/api/categories/auth.md +3 -1
  84. package/docs/api/categories/cache.md +3 -1
  85. package/docs/api/categories/comment.md +3 -1
  86. package/docs/api/categories/media.md +3 -1
  87. package/docs/api/categories/page.md +3 -1
  88. package/docs/api/categories/performance.md +3 -1
  89. package/docs/api/categories/post.md +3 -1
  90. package/docs/api/categories/site.md +3 -1
  91. package/docs/api/categories/taxonomy.md +3 -1
  92. package/docs/api/categories/user.md +3 -1
  93. package/docs/api/openapi.json +114 -410
  94. package/docs/api/summary.json +1 -1
  95. package/docs/api/tools/wp_approve_comment.md +13 -25
  96. package/docs/api/tools/wp_cache_clear.md +17 -30
  97. package/docs/api/tools/wp_cache_info.md +16 -29
  98. package/docs/api/tools/wp_cache_stats.md +16 -29
  99. package/docs/api/tools/wp_cache_warm.md +16 -29
  100. package/docs/api/tools/wp_create_application_password.md +14 -26
  101. package/docs/api/tools/wp_create_category.md +14 -26
  102. package/docs/api/tools/wp_create_comment.md +18 -31
  103. package/docs/api/tools/wp_create_page.md +17 -29
  104. package/docs/api/tools/wp_create_post.md +25 -30
  105. package/docs/api/tools/wp_create_tag.md +13 -25
  106. package/docs/api/tools/wp_create_user.md +18 -30
  107. package/docs/api/tools/wp_delete_application_password.md +14 -26
  108. package/docs/api/tools/wp_delete_category.md +13 -25
  109. package/docs/api/tools/wp_delete_comment.md +14 -26
  110. package/docs/api/tools/wp_delete_media.md +14 -25
  111. package/docs/api/tools/wp_delete_page.md +14 -25
  112. package/docs/api/tools/wp_delete_post.md +17 -25
  113. package/docs/api/tools/wp_delete_tag.md +13 -25
  114. package/docs/api/tools/wp_delete_user.md +14 -25
  115. package/docs/api/tools/wp_get_application_passwords.md +13 -25
  116. package/docs/api/tools/wp_get_auth_status.md +12 -24
  117. package/docs/api/tools/wp_get_category.md +13 -25
  118. package/docs/api/tools/wp_get_comment.md +13 -25
  119. package/docs/api/tools/wp_get_current_user.md +17 -30
  120. package/docs/api/tools/wp_get_media.md +13 -25
  121. package/docs/api/tools/wp_get_page.md +13 -25
  122. package/docs/api/tools/wp_get_page_revisions.md +13 -25
  123. package/docs/api/tools/wp_get_post.md +16 -25
  124. package/docs/api/tools/wp_get_post_revisions.md +13 -25
  125. package/docs/api/tools/wp_get_site_settings.md +12 -23
  126. package/docs/api/tools/wp_get_tag.md +13 -25
  127. package/docs/api/tools/wp_get_user.md +13 -25
  128. package/docs/api/tools/wp_list_categories.md +15 -27
  129. package/docs/api/tools/wp_list_comments.md +15 -27
  130. package/docs/api/tools/wp_list_media.md +18 -31
  131. package/docs/api/tools/wp_list_pages.md +18 -31
  132. package/docs/api/tools/wp_list_posts.md +29 -41
  133. package/docs/api/tools/wp_list_tags.md +14 -26
  134. package/docs/api/tools/wp_list_users.md +20 -34
  135. package/docs/api/tools/wp_performance_alerts.md +22 -36
  136. package/docs/api/tools/wp_performance_benchmark.md +20 -34
  137. package/docs/api/tools/wp_performance_export.md +22 -36
  138. package/docs/api/tools/wp_performance_history.md +21 -35
  139. package/docs/api/tools/wp_performance_optimize.md +22 -36
  140. package/docs/api/tools/wp_performance_stats.md +20 -34
  141. package/docs/api/tools/wp_search_site.md +18 -32
  142. package/docs/api/tools/wp_spam_comment.md +13 -25
  143. package/docs/api/tools/wp_switch_auth_method.md +18 -31
  144. package/docs/api/tools/wp_test_auth.md +15 -30
  145. package/docs/api/tools/wp_update_category.md +14 -26
  146. package/docs/api/tools/wp_update_comment.md +17 -30
  147. package/docs/api/tools/wp_update_media.md +19 -32
  148. package/docs/api/tools/wp_update_page.md +18 -30
  149. package/docs/api/tools/wp_update_post.md +21 -30
  150. package/docs/api/tools/wp_update_site_settings.md +18 -31
  151. package/docs/api/tools/wp_update_tag.md +14 -26
  152. package/docs/api/tools/wp_update_user.md +17 -29
  153. package/docs/api/tools/wp_upload_media.md +20 -32
  154. package/docs/api/types/WordPressPost.md +8 -15
  155. package/docs/code-improvements.md +1 -0
  156. package/docs/developer/GITHUB_ACTIONS_SETUP.md +2 -2
  157. package/docs/developer/MAINTENANCE.md +4 -0
  158. package/docs/developer/NPM_AUTH_SETUP.md +3 -0
  159. package/docs/developer/RELEASE_PROCESS.md +1 -0
  160. package/docs/examples/multi-site-setup.md +2 -0
  161. package/docs/integrations/claude-desktop.md +14 -5
  162. package/docs/integrations/cline.md +1 -0
  163. package/docs/user-guides/DTX_SETUP.md +9 -8
  164. package/docs/user-guides/NPX_SETUP.md +5 -9
  165. package/docs/user-guides/SMITHERY_SETUP.md +5 -0
  166. package/docs/v2.2.0-resolution-demo.md +17 -2
  167. package/package.json +2 -1
  168. package/src/cache/__tests__/CacheManager.test.ts +4 -8
  169. package/src/client/MockWordPressClient.ts +5 -1
  170. package/src/client/SEOWordPressClient.ts +30 -26
  171. package/src/client/index.ts +6 -6
  172. package/src/client/managers/AuthManager.ts +16 -8
  173. package/src/client/managers/AuthenticationManager.ts +2 -2
  174. package/src/client/managers/JWTAuthImplementation.ts +24 -27
  175. package/src/client/managers/ManagersIndex.ts +1 -1
  176. package/src/client/managers/composed/MigrationAdapter.ts +1 -1
  177. package/src/client/managers/composed/index.ts +7 -7
  178. package/src/client/managers/implementations/ErrorHandlerImpl.ts +12 -26
  179. package/src/client/managers/implementations/ParameterValidatorImpl.ts +49 -49
  180. package/src/client/managers/interfaces/ManagerInterfaces.ts +13 -9
  181. package/src/config/index.ts +3 -3
  182. package/src/docs/MarkdownFormatter.ts +13 -9
  183. package/src/performance/PerformanceAnalytics.ts +9 -3
  184. package/src/security/InputValidator.ts +1 -1
  185. package/src/security/SecurityCIPipeline.ts +1 -1
  186. package/src/security/SecurityConfig.ts +9 -3
  187. package/src/server/index.ts +2 -2
  188. package/src/tools/cache.ts +3 -1
  189. package/src/tools/comments.ts +3 -1
  190. package/src/tools/performance.ts +7 -3
  191. package/src/tools/posts/PostHandlers.ts +3 -1
  192. package/src/tools/seo/SEOTools.ts +6 -2
  193. package/src/tools/seo/analyzers/ContentAnalyzer.ts +9 -3
  194. package/src/types/enhanced.ts +34 -34
  195. package/src/types/index.ts +13 -11
  196. package/src/types/requests.ts +19 -19
  197. package/src/types/tools.ts +137 -84
  198. package/src/utils/index.ts +7 -7
@@ -6,13 +6,13 @@ Get optimization recommendations and insights
6
6
 
7
7
  ## Parameters
8
8
 
9
- | Parameter | Type | Required | Description | Default | Examples |
10
- |-----------|------|----------|-------------|---------|----------|
11
- | `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
12
- | `focus` | `string` | ❌ | Optimization focus area (speed, reliability, efficiency, scaling) | - | `example` |
13
- | `priority` | `string` | ❌ | Implementation timeline (quick_wins, medium_term, long_term, all) | - | `example` |
14
- | `includeROI` | `boolean` | ❌ | Include ROI estimates (default: true) | - | `example` |
15
- | `includePredictions` | `boolean` | ❌ | Include performance predictions (default: true) | - | `example` |
9
+ | Parameter | Type | Required | Description | Default | Examples |
10
+ | -------------------- | --------- | -------- | ----------------------------------------------------------------- | ------- | --------------------- |
11
+ | `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
12
+ | `focus` | `string` | ❌ | Optimization focus area (speed, reliability, efficiency, scaling) | - | `example` |
13
+ | `priority` | `string` | ❌ | Implementation timeline (quick_wins, medium_term, long_term, all) | - | `example` |
14
+ | `includeROI` | `boolean` | ❌ | Include ROI estimates (default: true) | - | `example` |
15
+ | `includePredictions` | `boolean` | ❌ | Include performance predictions (default: true) | - | `example` |
16
16
 
17
17
  ## Examples
18
18
 
@@ -21,11 +21,13 @@ Get optimization recommendations and insights
21
21
  Simple example of using wp_performance_optimize
22
22
 
23
23
  **Command:**
24
+
24
25
  ```bash
25
- wp_performance_optimize
26
+ wp_performance_optimize
26
27
  ```
27
28
 
28
29
  **Response:**
30
+
29
31
  ```json
30
32
  {
31
33
  "success": true,
@@ -41,6 +43,7 @@ wp_performance_optimize
41
43
  ```
42
44
 
43
45
  **Error Example (Authentication failure):**
46
+
44
47
  ```json
45
48
  {
46
49
  "error": "Authentication failed",
@@ -48,17 +51,18 @@ wp_performance_optimize
48
51
  }
49
52
  ```
50
53
 
51
-
52
54
  ### Multi-Site performance Usage
53
55
 
54
56
  Using wp_performance_optimize with specific site targeting
55
57
 
56
58
  **Command:**
59
+
57
60
  ```bash
58
61
  wp_performance_optimize --site="site1"
59
62
  ```
60
63
 
61
64
  **Response:**
65
+
62
66
  ```json
63
67
  {
64
68
  "success": true,
@@ -73,19 +77,18 @@ wp_performance_optimize --site="site1"
73
77
  }
74
78
  ```
75
79
 
76
-
77
-
78
-
79
80
  ### Advanced performance Configuration
80
81
 
81
82
  Comprehensive example using all available parameters
82
83
 
83
84
  **Command:**
85
+
84
86
  ```bash
85
87
  wp_performance_optimize --site="site1" --focus="example_value" --priority="example_value" --includeROI="example_value" --includePredictions="example_value"
86
88
  ```
87
89
 
88
90
  **Response:**
91
+
89
92
  ```json
90
93
  {
91
94
  "success": true,
@@ -100,13 +103,6 @@ wp_performance_optimize --site="site1" --focus="example_value" --priority="examp
100
103
  }
101
104
  ```
102
105
 
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
106
  ## Response Format
111
107
 
112
108
  **Return Type:** `PerformanceMetrics`
@@ -129,34 +125,24 @@ wp_performance_optimize --site="site1" --focus="example_value" --priority="examp
129
125
 
130
126
  ### AUTHENTICATION_FAILED
131
127
 
132
- **Message:** Authentication failed
133
- **Description:** Invalid credentials or insufficient permissions
134
- **Resolution:** Check your authentication credentials and user permissions
135
-
128
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
129
+ Check your authentication credentials and user permissions
136
130
 
137
131
  ### VALIDATION_ERROR
138
132
 
139
- **Message:** Parameter validation failed
140
- **Description:** One or more required parameters are missing or invalid
133
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
141
134
  **Resolution:** Review the required parameters and their formats
142
135
 
143
-
144
136
  ### NOT_FOUND
145
137
 
146
- **Message:** Resource not found
147
- **Description:** The requested resource does not exist
148
- **Resolution:** Verify the resource ID and ensure it exists
149
-
138
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
139
+ resource ID and ensure it exists
150
140
 
151
141
  ### PERMISSION_DENIED
152
142
 
153
- **Message:** Insufficient permissions
154
- **Description:** The user does not have permission to perform this action
143
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
155
144
  **Resolution:** Contact an administrator to grant the necessary permissions
156
145
 
157
-
158
-
159
-
160
146
  ---
161
147
 
162
- *Generated automatically from tool definitions - Do not edit manually*
148
+ _Generated automatically from tool definitions - Do not edit manually_
@@ -6,11 +6,11 @@ Get real-time performance statistics and metrics
6
6
 
7
7
  ## Parameters
8
8
 
9
- | Parameter | Type | Required | Description | Default | Examples |
10
- |-----------|------|----------|-------------|---------|----------|
11
- | `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
12
- | `category` | `string` | ❌ | Category of metrics to return (overview, requests, cache, system, tools, all) | `all` | `example` |
13
- | `format` | `string` | ❌ | Detail level of the response (summary, detailed, raw) | `summary` | `example` |
9
+ | Parameter | Type | Required | Description | Default | Examples |
10
+ | ---------- | -------- | -------- | ----------------------------------------------------------------------------- | --------- | --------------------- |
11
+ | `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
12
+ | `category` | `string` | ❌ | Category of metrics to return (overview, requests, cache, system, tools, all) | `all` | `example` |
13
+ | `format` | `string` | ❌ | Detail level of the response (summary, detailed, raw) | `summary` | `example` |
14
14
 
15
15
  ## Examples
16
16
 
@@ -19,11 +19,13 @@ Get real-time performance statistics and metrics
19
19
  Simple example of using wp_performance_stats
20
20
 
21
21
  **Command:**
22
+
22
23
  ```bash
23
- wp_performance_stats
24
+ wp_performance_stats
24
25
  ```
25
26
 
26
27
  **Response:**
28
+
27
29
  ```json
28
30
  {
29
31
  "success": true,
@@ -39,6 +41,7 @@ wp_performance_stats
39
41
  ```
40
42
 
41
43
  **Error Example (Authentication failure):**
44
+
42
45
  ```json
43
46
  {
44
47
  "error": "Authentication failed",
@@ -46,17 +49,18 @@ wp_performance_stats
46
49
  }
47
50
  ```
48
51
 
49
-
50
52
  ### Multi-Site performance Usage
51
53
 
52
54
  Using wp_performance_stats with specific site targeting
53
55
 
54
56
  **Command:**
57
+
55
58
  ```bash
56
59
  wp_performance_stats --site="site1"
57
60
  ```
58
61
 
59
62
  **Response:**
63
+
60
64
  ```json
61
65
  {
62
66
  "success": true,
@@ -71,19 +75,18 @@ wp_performance_stats --site="site1"
71
75
  }
72
76
  ```
73
77
 
74
-
75
-
76
-
77
78
  ### Advanced performance Configuration
78
79
 
79
80
  Comprehensive example using all available parameters
80
81
 
81
82
  **Command:**
83
+
82
84
  ```bash
83
85
  wp_performance_stats --site="site1" --category="overview" --format="summary"
84
86
  ```
85
87
 
86
88
  **Response:**
89
+
87
90
  ```json
88
91
  {
89
92
  "success": true,
@@ -98,13 +101,6 @@ wp_performance_stats --site="site1" --category="overview" --format="summary"
98
101
  }
99
102
  ```
100
103
 
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
104
  ## Response Format
109
105
 
110
106
  **Return Type:** `PerformanceMetrics`
@@ -127,34 +123,24 @@ wp_performance_stats --site="site1" --category="overview" --format="summary"
127
123
 
128
124
  ### AUTHENTICATION_FAILED
129
125
 
130
- **Message:** Authentication failed
131
- **Description:** Invalid credentials or insufficient permissions
132
- **Resolution:** Check your authentication credentials and user permissions
133
-
126
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
127
+ Check your authentication credentials and user permissions
134
128
 
135
129
  ### VALIDATION_ERROR
136
130
 
137
- **Message:** Parameter validation failed
138
- **Description:** One or more required parameters are missing or invalid
131
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
139
132
  **Resolution:** Review the required parameters and their formats
140
133
 
141
-
142
134
  ### NOT_FOUND
143
135
 
144
- **Message:** Resource not found
145
- **Description:** The requested resource does not exist
146
- **Resolution:** Verify the resource ID and ensure it exists
147
-
136
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
137
+ resource ID and ensure it exists
148
138
 
149
139
  ### PERMISSION_DENIED
150
140
 
151
- **Message:** Insufficient permissions
152
- **Description:** The user does not have permission to perform this action
141
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
153
142
  **Resolution:** Contact an administrator to grant the necessary permissions
154
143
 
155
-
156
-
157
-
158
144
  ---
159
145
 
160
- *Generated automatically from tool definitions - Do not edit manually*
146
+ _Generated automatically from tool definitions - Do not edit manually_
@@ -4,19 +4,17 @@
4
4
 
5
5
  Performs a site-wide search for content across posts, pages, and media with comprehensive results and metadata.
6
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"`
7
+ **Usage Examples:** • Search everything: `wp_search_site --term="WordPress"` • Search posts only:
8
+ `wp_search_site --term="tutorial" --type="posts"` • Search pages: `wp_search_site --term="about" --type="pages"`
9
+ Search media: `wp_search_site --term="logo" --type="media"` • Find specific content:
10
+ `wp_search_site --term="contact form"`
13
11
 
14
12
  ## Parameters
15
13
 
16
- | Parameter | Type | Required | Description | Default | Examples |
17
- |-----------|------|----------|-------------|---------|----------|
18
- | `term` | `string` | ✅ | The search term to look for. | - | `example` |
19
- | `type` | `string` | ❌ | The type of content to search. | - | `example` |
14
+ | Parameter | Type | Required | Description | Default | Examples |
15
+ | --------- | -------- | -------- | ------------------------------ | ------- | --------- |
16
+ | `term` | `string` | ✅ | The search term to look for. | - | `example` |
17
+ | `type` | `string` | ❌ | The type of content to search. | - | `example` |
20
18
 
21
19
  ## Examples
22
20
 
@@ -25,11 +23,13 @@ Performs a site-wide search for content across posts, pages, and media with comp
25
23
  Simple example of using wp_search_site
26
24
 
27
25
  **Command:**
26
+
28
27
  ```bash
29
28
  wp_search_site --term="example_value"
30
29
  ```
31
30
 
32
31
  **Response:**
32
+
33
33
  ```json
34
34
  {
35
35
  "success": true,
@@ -39,6 +39,7 @@ wp_search_site --term="example_value"
39
39
  ```
40
40
 
41
41
  **Error Example (Authentication failure):**
42
+
42
43
  ```json
43
44
  {
44
45
  "error": "Authentication failed",
@@ -46,11 +47,6 @@ wp_search_site --term="example_value"
46
47
  }
47
48
  ```
48
49
 
49
-
50
-
51
-
52
-
53
-
54
50
  ## Response Format
55
51
 
56
52
  **Return Type:** `site[]`
@@ -73,34 +69,24 @@ wp_search_site --term="example_value"
73
69
 
74
70
  ### AUTHENTICATION_FAILED
75
71
 
76
- **Message:** Authentication failed
77
- **Description:** Invalid credentials or insufficient permissions
78
- **Resolution:** Check your authentication credentials and user permissions
79
-
72
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
73
+ Check your authentication credentials and user permissions
80
74
 
81
75
  ### VALIDATION_ERROR
82
76
 
83
- **Message:** Parameter validation failed
84
- **Description:** One or more required parameters are missing or invalid
77
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
85
78
  **Resolution:** Review the required parameters and their formats
86
79
 
87
-
88
80
  ### NOT_FOUND
89
81
 
90
- **Message:** Resource not found
91
- **Description:** The requested resource does not exist
92
- **Resolution:** Verify the resource ID and ensure it exists
93
-
82
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
83
+ resource ID and ensure it exists
94
84
 
95
85
  ### PERMISSION_DENIED
96
86
 
97
- **Message:** Insufficient permissions
98
- **Description:** The user does not have permission to perform this action
87
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
99
88
  **Resolution:** Contact an administrator to grant the necessary permissions
100
89
 
101
-
102
-
103
-
104
90
  ---
105
91
 
106
- *Generated automatically from tool definitions - Do not edit manually*
92
+ _Generated automatically from tool definitions - Do not edit manually_
@@ -6,9 +6,9 @@ Marks a comment as spam.
6
6
 
7
7
  ## Parameters
8
8
 
9
- | Parameter | Type | Required | Description | Default | Examples |
10
- |-----------|------|----------|-------------|---------|----------|
11
- | `id` | `number` | ✅ | The ID of the comment to mark as spam. | - | `123`, `456` |
9
+ | Parameter | Type | Required | Description | Default | Examples |
10
+ | --------- | -------- | -------- | -------------------------------------- | ------- | ------------ |
11
+ | `id` | `number` | ✅ | The ID of the comment to mark as spam. | - | `123`, `456` |
12
12
 
13
13
  ## Examples
14
14
 
@@ -17,11 +17,13 @@ Marks a comment as spam.
17
17
  Simple example of using wp_spam_comment
18
18
 
19
19
  **Command:**
20
+
20
21
  ```bash
21
22
  wp_spam_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_spam_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_spam_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`
@@ -65,34 +63,24 @@ wp_spam_comment --id="123"
65
63
 
66
64
  ### AUTHENTICATION_FAILED
67
65
 
68
- **Message:** Authentication failed
69
- **Description:** Invalid credentials or insufficient permissions
70
- **Resolution:** Check your authentication credentials and user permissions
71
-
66
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
67
+ Check your authentication credentials and user permissions
72
68
 
73
69
  ### VALIDATION_ERROR
74
70
 
75
- **Message:** Parameter validation failed
76
- **Description:** One or more required parameters are missing or invalid
71
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
77
72
  **Resolution:** Review the required parameters and their formats
78
73
 
79
-
80
74
  ### NOT_FOUND
81
75
 
82
- **Message:** Resource not found
83
- **Description:** The requested resource does not exist
84
- **Resolution:** Verify the resource ID and ensure it exists
85
-
76
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
77
+ resource ID and ensure it exists
86
78
 
87
79
  ### PERMISSION_DENIED
88
80
 
89
- **Message:** Insufficient permissions
90
- **Description:** The user does not have permission to perform this action
81
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
91
82
  **Resolution:** Contact an administrator to grant the necessary permissions
92
83
 
93
-
94
-
95
-
96
84
  ---
97
85
 
98
- *Generated automatically from tool definitions - Do not edit manually*
86
+ _Generated automatically from tool definitions - Do not edit manually_
@@ -6,12 +6,12 @@ Switches the authentication method for a site for the current session.
6
6
 
7
7
  ## Parameters
8
8
 
9
- | Parameter | Type | Required | Description | Default | Examples |
10
- |-----------|------|----------|-------------|---------|----------|
11
- | `method` | `string` | ✅ | The new authentication method to use. | - | `example` |
12
- | `username` | `string` | ❌ | The username for 'app-password' or 'basic' authentication. | - | `john_doe`, `admin` |
13
- | `password` | `string` | ❌ | The Application Password for 'app-password' or password for 'basic' auth. | - | `example` |
14
- | `jwt_token` | `string` | ❌ | The token for 'jwt' authentication. | - | `example` |
9
+ | Parameter | Type | Required | Description | Default | Examples |
10
+ | ----------- | -------- | -------- | ------------------------------------------------------------------------- | ------- | ------------------- |
11
+ | `method` | `string` | ✅ | The new authentication method to use. | - | `example` |
12
+ | `username` | `string` | ❌ | The username for 'app-password' or 'basic' authentication. | - | `john_doe`, `admin` |
13
+ | `password` | `string` | ❌ | The Application Password for 'app-password' or password for 'basic' auth. | - | `example` |
14
+ | `jwt_token` | `string` | ❌ | The token for 'jwt' authentication. | - | `example` |
15
15
 
16
16
  ## Examples
17
17
 
@@ -20,11 +20,13 @@ Switches the authentication method for a site for the current session.
20
20
  Simple example of using wp_switch_auth_method
21
21
 
22
22
  **Command:**
23
+
23
24
  ```bash
24
25
  wp_switch_auth_method --method="example_value"
25
26
  ```
26
27
 
27
28
  **Response:**
29
+
28
30
  ```json
29
31
  {
30
32
  "success": true,
@@ -34,6 +36,7 @@ wp_switch_auth_method --method="example_value"
34
36
  ```
35
37
 
36
38
  **Error Example (Authentication failure):**
39
+
37
40
  ```json
38
41
  {
39
42
  "error": "Authentication failed",
@@ -41,17 +44,18 @@ wp_switch_auth_method --method="example_value"
41
44
  }
42
45
  ```
43
46
 
44
-
45
47
  ### Advanced auth Configuration
46
48
 
47
49
  Comprehensive example using all available parameters
48
50
 
49
51
  **Command:**
52
+
50
53
  ```bash
51
54
  wp_switch_auth_method --method="example_value" --username="john_doe" --password="example_value" --jwt_token="example_value"
52
55
  ```
53
56
 
54
57
  **Response:**
58
+
55
59
  ```json
56
60
  {
57
61
  "success": true,
@@ -60,13 +64,6 @@ wp_switch_auth_method --method="example_value" --username="john_doe" --password=
60
64
  }
61
65
  ```
62
66
 
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
67
  ## Response Format
71
68
 
72
69
  **Return Type:** `object`
@@ -89,34 +86,24 @@ wp_switch_auth_method --method="example_value" --username="john_doe" --password=
89
86
 
90
87
  ### AUTHENTICATION_FAILED
91
88
 
92
- **Message:** Authentication failed
93
- **Description:** Invalid credentials or insufficient permissions
94
- **Resolution:** Check your authentication credentials and user permissions
95
-
89
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
90
+ Check your authentication credentials and user permissions
96
91
 
97
92
  ### VALIDATION_ERROR
98
93
 
99
- **Message:** Parameter validation failed
100
- **Description:** One or more required parameters are missing or invalid
94
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
101
95
  **Resolution:** Review the required parameters and their formats
102
96
 
103
-
104
97
  ### NOT_FOUND
105
98
 
106
- **Message:** Resource not found
107
- **Description:** The requested resource does not exist
108
- **Resolution:** Verify the resource ID and ensure it exists
109
-
99
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
100
+ resource ID and ensure it exists
110
101
 
111
102
  ### PERMISSION_DENIED
112
103
 
113
- **Message:** Insufficient permissions
114
- **Description:** The user does not have permission to perform this action
104
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
115
105
  **Resolution:** Contact an administrator to grant the necessary permissions
116
106
 
117
-
118
-
119
-
120
107
  ---
121
108
 
122
- *Generated automatically from tool definitions - Do not edit manually*
109
+ _Generated automatically from tool definitions - Do not edit manually_
@@ -4,16 +4,13 @@
4
4
 
5
5
  Tests the authentication and connectivity for a configured WordPress site with detailed connection diagnostics.
6
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
7
+ **Usage Examples:** • Test connection: `wp_test_auth` • Multi-site test: `wp_test_auth --site="my-site"` • Verify setup:
8
+ Use this after configuring new credentials Troubleshoot: Run when experiencing connection issues • Health check:
9
+ Regular verification of WordPress connectivity
13
10
 
14
11
  ## Parameters
15
12
 
16
- *No parameters required.*
13
+ _No parameters required._
17
14
 
18
15
  ## Examples
19
16
 
@@ -22,11 +19,13 @@ Tests the authentication and connectivity for a configured WordPress site with d
22
19
  Simple example of using wp_test_auth
23
20
 
24
21
  **Command:**
22
+
25
23
  ```bash
26
- wp_test_auth
24
+ wp_test_auth
27
25
  ```
28
26
 
29
27
  **Response:**
28
+
30
29
  ```json
31
30
  {
32
31
  "success": true,
@@ -36,6 +35,7 @@ wp_test_auth
36
35
  ```
37
36
 
38
37
  **Error Example (Authentication failure):**
38
+
39
39
  ```json
40
40
  {
41
41
  "error": "Authentication failed",
@@ -43,11 +43,6 @@ wp_test_auth
43
43
  }
44
44
  ```
45
45
 
46
-
47
-
48
-
49
-
50
-
51
46
  ## Response Format
52
47
 
53
48
  **Return Type:** `object`
@@ -70,34 +65,24 @@ wp_test_auth
70
65
 
71
66
  ### AUTHENTICATION_FAILED
72
67
 
73
- **Message:** Authentication failed
74
- **Description:** Invalid credentials or insufficient permissions
75
- **Resolution:** Check your authentication credentials and user permissions
76
-
68
+ **Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
69
+ Check your authentication credentials and user permissions
77
70
 
78
71
  ### VALIDATION_ERROR
79
72
 
80
- **Message:** Parameter validation failed
81
- **Description:** One or more required parameters are missing or invalid
73
+ **Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
82
74
  **Resolution:** Review the required parameters and their formats
83
75
 
84
-
85
76
  ### NOT_FOUND
86
77
 
87
- **Message:** Resource not found
88
- **Description:** The requested resource does not exist
89
- **Resolution:** Verify the resource ID and ensure it exists
90
-
78
+ **Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
79
+ resource ID and ensure it exists
91
80
 
92
81
  ### PERMISSION_DENIED
93
82
 
94
- **Message:** Insufficient permissions
95
- **Description:** The user does not have permission to perform this action
83
+ **Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
96
84
  **Resolution:** Contact an administrator to grant the necessary permissions
97
85
 
98
-
99
-
100
-
101
86
  ---
102
87
 
103
- *Generated automatically from tool definitions - Do not edit manually*
88
+ _Generated automatically from tool definitions - Do not edit manually_