mcp-wordpress 2.10.0 → 2.10.2

package/docs/api/tools/wp_list_users.md

@@ -2,21 +2,19 @@
 
 ![user](https://img.shields.io/badge/category-user-lightgrey)
 
-Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.
+Lists users from a WordPress site with comprehensive filtering and detailed user information including roles,
+registration dates, and activity status.
 
-**Usage Examples:**
-• List all users: `wp_list_users`
-• Search users: `wp_list_users --search="john"`
-• Filter by role: `wp_list_users --roles=["editor","author"]`
-• Find admins: `wp_list_users --roles=["administrator"]`
-• Combined search: `wp_list_users --search="smith" --roles=["subscriber"]`
+**Usage Examples:** • List all users: `wp_list_users` • Search users: `wp_list_users --search="john"` • Filter by role:
+`wp_list_users --roles=["editor","author"]` • Find admins: `wp_list_users --roles=["administrator"]` • Combined search:
+`wp_list_users --search="smith" --roles=["subscriber"]`
 
 ## Parameters
 
-| Parameter | Type | Required | Description | Default | Examples |
-|-----------|------|----------|-------------|---------|----------|
-| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
-| `roles` | `array` | ❌ | Limit results to users with specific roles. | - | `example` |
+| Parameter | Type     | Required | Description                                    | Default | Examples                |
+| --------- | -------- | -------- | ---------------------------------------------- | ------- | ----------------------- |
+| `search`  | `string` | ❌       | Limit results to those matching a search term. | -       | `wordpress`, `tutorial` |
+| `roles`   | `array`  | ❌       | Limit results to users with specific roles.    | -       | `example`               |
 
 ## Examples
 
@@ -25,11 +23,13 @@ Lists users from a WordPress site with comprehensive filtering and detailed user
 Simple example of using wp_list_users
 
 **Command:**
+
 ```bash
-wp_list_users 
+wp_list_users
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -51,6 +51,7 @@ wp_list_users
 ```
 
 **Error Example (Authentication failure):**
+
 ```json
 {
   "error": "Authentication failed",
@@ -58,11 +59,6 @@ wp_list_users
 }
 ```
 
-
-
-
-
-
 ## Response Format
 
 **Return Type:** `user[]`
@@ -85,34 +81,24 @@ wp_list_users
 
 ### AUTHENTICATION_FAILED
 
-**Message:** Authentication failed  
-**Description:** Invalid credentials or insufficient permissions  
-**Resolution:** Check your authentication credentials and user permissions
-
+**Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
+Check your authentication credentials and user permissions
 
 ### VALIDATION_ERROR
 
-**Message:** Parameter validation failed  
-**Description:** One or more required parameters are missing or invalid  
+**Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
 **Resolution:** Review the required parameters and their formats
 
-
 ### NOT_FOUND
 
-**Message:** Resource not found  
-**Description:** The requested resource does not exist  
-**Resolution:** Verify the resource ID and ensure it exists
-
+**Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
+resource ID and ensure it exists
 
 ### PERMISSION_DENIED
 
-**Message:** Insufficient permissions  
-**Description:** The user does not have permission to perform this action  
+**Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
 **Resolution:** Contact an administrator to grant the necessary permissions
 
-
-
-
 ---
 
-*Generated automatically from tool definitions - Do not edit manually*
+_Generated automatically from tool definitions - Do not edit manually_

package/docs/api/tools/wp_performance_alerts.md

@@ -6,13 +6,13 @@ Get performance alerts and anomaly detection results
 
 ## Parameters
 
-| Parameter | Type | Required | Description | Default | Examples |
-|-----------|------|----------|-------------|---------|----------|
-| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
-| `severity` | `string` | ❌ | Filter alerts by severity level (info, warning, error, critical) | - | `example` |
-| `category` | `string` | ❌ | Filter alerts by category (performance, cache, system, wordpress) | `all` | `example` |
-| `limit` | `number` | ❌ | Maximum number of alerts to return (default: 20) | - | `10`, `20` |
-| `includeAnomalies` | `boolean` | ❌ | Include detected anomalies (default: true) | - | `example` |
+| Parameter          | Type      | Required | Description                                                       | Default | Examples              |
+| ------------------ | --------- | -------- | ----------------------------------------------------------------- | ------- | --------------------- |
+| `site`             | `string`  | ❌       | Specific site ID for multi-site setups (optional for single site) | -       | `site1`, `production` |
+| `severity`         | `string`  | ❌       | Filter alerts by severity level (info, warning, error, critical)  | -       | `example`             |
+| `category`         | `string`  | ❌       | Filter alerts by category (performance, cache, system, wordpress) | `all`   | `example`             |
+| `limit`            | `number`  | ❌       | Maximum number of alerts to return (default: 20)                  | -       | `10`, `20`            |
+| `includeAnomalies` | `boolean` | ❌       | Include detected anomalies (default: true)                        | -       | `example`             |
 
 ## Examples
 
@@ -21,11 +21,13 @@ Get performance alerts and anomaly detection results
 Simple example of using wp_performance_alerts
 
 **Command:**
+
 ```bash
-wp_performance_alerts 
+wp_performance_alerts
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -41,6 +43,7 @@ wp_performance_alerts
 ```
 
 **Error Example (Authentication failure):**
+
 ```json
 {
   "error": "Authentication failed",
@@ -48,17 +51,18 @@ wp_performance_alerts
 }
 ```
 
-
 ### Multi-Site performance Usage
 
 Using wp_performance_alerts with specific site targeting
 
 **Command:**
+
 ```bash
 wp_performance_alerts --site="site1"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -73,19 +77,18 @@ wp_performance_alerts --site="site1"
 }
 ```
 
-
-
-
 ### Advanced performance Configuration
 
 Comprehensive example using all available parameters
 
 **Command:**
+
 ```bash
 wp_performance_alerts --site="site1" --severity="example_value" --category="overview" --limit="20" --includeAnomalies="example_value"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -100,13 +103,6 @@ wp_performance_alerts --site="site1" --severity="example_value" --category="over
 }
 ```
 
-
-
-
-
-
-
-
 ## Response Format
 
 **Return Type:** `PerformanceMetrics`
@@ -129,34 +125,24 @@ wp_performance_alerts --site="site1" --severity="example_value" --category="over
 
 ### AUTHENTICATION_FAILED
 
-**Message:** Authentication failed  
-**Description:** Invalid credentials or insufficient permissions  
-**Resolution:** Check your authentication credentials and user permissions
-
+**Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
+Check your authentication credentials and user permissions
 
 ### VALIDATION_ERROR
 
-**Message:** Parameter validation failed  
-**Description:** One or more required parameters are missing or invalid  
+**Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
 **Resolution:** Review the required parameters and their formats
 
-
 ### NOT_FOUND
 
-**Message:** Resource not found  
-**Description:** The requested resource does not exist  
-**Resolution:** Verify the resource ID and ensure it exists
-
+**Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
+resource ID and ensure it exists
 
 ### PERMISSION_DENIED
 
-**Message:** Insufficient permissions  
-**Description:** The user does not have permission to perform this action  
+**Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
 **Resolution:** Contact an administrator to grant the necessary permissions
 
-
-
-
 ---
 
-*Generated automatically from tool definitions - Do not edit manually*
+_Generated automatically from tool definitions - Do not edit manually_

package/docs/api/tools/wp_performance_benchmark.md

@@ -6,11 +6,11 @@ Compare current performance against industry benchmarks
 
 ## Parameters
 
-| Parameter | Type | Required | Description | Default | Examples |
-|-----------|------|----------|-------------|---------|----------|
-| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
-| `category` | `string` | ❌ | Benchmark category (response_time, cache_performance, error_rate, system_resources, all) | `all` | `example` |
-| `includeRecommendations` | `boolean` | ❌ | Include improvement recommendations (default: true) | - | `example` |
+| Parameter                | Type      | Required | Description                                                                              | Default | Examples              |
+| ------------------------ | --------- | -------- | ---------------------------------------------------------------------------------------- | ------- | --------------------- |
+| `site`                   | `string`  | ❌       | Specific site ID for multi-site setups (optional for single site)                        | -       | `site1`, `production` |
+| `category`               | `string`  | ❌       | Benchmark category (response_time, cache_performance, error_rate, system_resources, all) | `all`   | `example`             |
+| `includeRecommendations` | `boolean` | ❌       | Include improvement recommendations (default: true)                                      | -       | `example`             |
 
 ## Examples
 
@@ -19,11 +19,13 @@ Compare current performance against industry benchmarks
 Simple example of using wp_performance_benchmark
 
 **Command:**
+
 ```bash
-wp_performance_benchmark 
+wp_performance_benchmark
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -39,6 +41,7 @@ wp_performance_benchmark
 ```
 
 **Error Example (Authentication failure):**
+
 ```json
 {
   "error": "Authentication failed",
@@ -46,17 +49,18 @@ wp_performance_benchmark
 }
 ```
 
-
 ### Multi-Site performance Usage
 
 Using wp_performance_benchmark with specific site targeting
 
 **Command:**
+
 ```bash
 wp_performance_benchmark --site="site1"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -71,19 +75,18 @@ wp_performance_benchmark --site="site1"
 }
 ```
 
-
-
-
 ### Advanced performance Configuration
 
 Comprehensive example using all available parameters
 
 **Command:**
+
 ```bash
 wp_performance_benchmark --site="site1" --category="overview" --includeRecommendations="example_value"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -98,13 +101,6 @@ wp_performance_benchmark --site="site1" --category="overview" --includeRecommend
 }
 ```
 
-
-
-
-
-
-
-
 ## Response Format
 
 **Return Type:** `PerformanceMetrics`
@@ -127,34 +123,24 @@ wp_performance_benchmark --site="site1" --category="overview" --includeRecommend
 
 ### AUTHENTICATION_FAILED
 
-**Message:** Authentication failed  
-**Description:** Invalid credentials or insufficient permissions  
-**Resolution:** Check your authentication credentials and user permissions
-
+**Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
+Check your authentication credentials and user permissions
 
 ### VALIDATION_ERROR
 
-**Message:** Parameter validation failed  
-**Description:** One or more required parameters are missing or invalid  
+**Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
 **Resolution:** Review the required parameters and their formats
 
-
 ### NOT_FOUND
 
-**Message:** Resource not found  
-**Description:** The requested resource does not exist  
-**Resolution:** Verify the resource ID and ensure it exists
-
+**Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
+resource ID and ensure it exists
 
 ### PERMISSION_DENIED
 
-**Message:** Insufficient permissions  
-**Description:** The user does not have permission to perform this action  
+**Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
 **Resolution:** Contact an administrator to grant the necessary permissions
 
-
-
-
 ---
 
-*Generated automatically from tool definitions - Do not edit manually*
+_Generated automatically from tool definitions - Do not edit manually_

package/docs/api/tools/wp_performance_export.md

@@ -6,13 +6,13 @@ Export comprehensive performance report
 
 ## Parameters
 
-| Parameter | Type | Required | Description | Default | Examples |
-|-----------|------|----------|-------------|---------|----------|
-| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
-| `format` | `string` | ❌ | Export format (json, csv, summary) | `summary` | `example` |
-| `includeHistorical` | `boolean` | ❌ | Include historical data (default: true) | - | `example` |
-| `includeAnalytics` | `boolean` | ❌ | Include analytics and insights (default: true) | - | `example` |
-| `timeRange` | `string` | ❌ | Time range for data export (1h, 6h, 24h, 7d, 30d) | - | `example` |
+| Parameter           | Type      | Required | Description                                                       | Default   | Examples              |
+| ------------------- | --------- | -------- | ----------------------------------------------------------------- | --------- | --------------------- |
+| `site`              | `string`  | ❌       | Specific site ID for multi-site setups (optional for single site) | -         | `site1`, `production` |
+| `format`            | `string`  | ❌       | Export format (json, csv, summary)                                | `summary` | `example`             |
+| `includeHistorical` | `boolean` | ❌       | Include historical data (default: true)                           | -         | `example`             |
+| `includeAnalytics`  | `boolean` | ❌       | Include analytics and insights (default: true)                    | -         | `example`             |
+| `timeRange`         | `string`  | ❌       | Time range for data export (1h, 6h, 24h, 7d, 30d)                 | -         | `example`             |
 
 ## Examples
 
@@ -21,11 +21,13 @@ Export comprehensive performance report
 Simple example of using wp_performance_export
 
 **Command:**
+
 ```bash
-wp_performance_export 
+wp_performance_export
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -41,6 +43,7 @@ wp_performance_export
 ```
 
 **Error Example (Authentication failure):**
+
 ```json
 {
   "error": "Authentication failed",
@@ -48,17 +51,18 @@ wp_performance_export
 }
 ```
 
-
 ### Multi-Site performance Usage
 
 Using wp_performance_export with specific site targeting
 
 **Command:**
+
 ```bash
 wp_performance_export --site="site1"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -73,19 +77,18 @@ wp_performance_export --site="site1"
 }
 ```
 
-
-
-
 ### Advanced performance Configuration
 
 Comprehensive example using all available parameters
 
 **Command:**
+
 ```bash
 wp_performance_export --site="site1" --format="summary" --includeHistorical="example_value" --includeAnalytics="example_value" --timeRange="example_value"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -100,13 +103,6 @@ wp_performance_export --site="site1" --format="summary" --includeHistorical="exa
 }
 ```
 
-
-
-
-
-
-
-
 ## Response Format
 
 **Return Type:** `PerformanceMetrics`
@@ -129,34 +125,24 @@ wp_performance_export --site="site1" --format="summary" --includeHistorical="exa
 
 ### AUTHENTICATION_FAILED
 
-**Message:** Authentication failed  
-**Description:** Invalid credentials or insufficient permissions  
-**Resolution:** Check your authentication credentials and user permissions
-
+**Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
+Check your authentication credentials and user permissions
 
 ### VALIDATION_ERROR
 
-**Message:** Parameter validation failed  
-**Description:** One or more required parameters are missing or invalid  
+**Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
 **Resolution:** Review the required parameters and their formats
 
-
 ### NOT_FOUND
 
-**Message:** Resource not found  
-**Description:** The requested resource does not exist  
-**Resolution:** Verify the resource ID and ensure it exists
-
+**Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
+resource ID and ensure it exists
 
 ### PERMISSION_DENIED
 
-**Message:** Insufficient permissions  
-**Description:** The user does not have permission to perform this action  
+**Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
 **Resolution:** Contact an administrator to grant the necessary permissions
 
-
-
-
 ---
 
-*Generated automatically from tool definitions - Do not edit manually*
+_Generated automatically from tool definitions - Do not edit manually_

package/docs/api/tools/wp_performance_history.md

@@ -6,12 +6,12 @@ Get historical performance data and trends
 
 ## Parameters
 
-| Parameter | Type | Required | Description | Default | Examples |
-|-----------|------|----------|-------------|---------|----------|
-| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
-| `timeframe` | `string` | ❌ | Time period for historical data (1h, 6h, 12h, 24h, 7d) | - | `24h`, `7d` |
-| `metrics` | `array` | ❌ | Specific metrics to include (responseTime, cacheHitRate, errorRate, memoryUsage, requestVolume) | - | `example` |
-| `includeTrends` | `boolean` | ❌ | Include trend analysis (default: true) | `true` | `example` |
+| Parameter       | Type      | Required | Description                                                                                     | Default | Examples              |
+| --------------- | --------- | -------- | ----------------------------------------------------------------------------------------------- | ------- | --------------------- |
+| `site`          | `string`  | ❌       | Specific site ID for multi-site setups (optional for single site)                               | -       | `site1`, `production` |
+| `timeframe`     | `string`  | ❌       | Time period for historical data (1h, 6h, 12h, 24h, 7d)                                          | -       | `24h`, `7d`           |
+| `metrics`       | `array`   | ❌       | Specific metrics to include (responseTime, cacheHitRate, errorRate, memoryUsage, requestVolume) | -       | `example`             |
+| `includeTrends` | `boolean` | ❌       | Include trend analysis (default: true)                                                          | `true`  | `example`             |
 
 ## Examples
 
@@ -20,11 +20,13 @@ Get historical performance data and trends
 Simple example of using wp_performance_history
 
 **Command:**
+
 ```bash
-wp_performance_history 
+wp_performance_history
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -40,6 +42,7 @@ wp_performance_history
 ```
 
 **Error Example (Authentication failure):**
+
 ```json
 {
   "error": "Authentication failed",
@@ -47,17 +50,18 @@ wp_performance_history
 }
 ```
 
-
 ### Multi-Site performance Usage
 
 Using wp_performance_history with specific site targeting
 
 **Command:**
+
 ```bash
 wp_performance_history --site="site1"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -72,19 +76,18 @@ wp_performance_history --site="site1"
 }
 ```
 
-
-
-
 ### Advanced performance Configuration
 
 Comprehensive example using all available parameters
 
 **Command:**
+
 ```bash
 wp_performance_history --site="site1" --timeframe="24h" --metrics="example_value" --includeTrends="example_value"
 ```
 
 **Response:**
+
 ```json
 {
   "success": true,
@@ -99,13 +102,6 @@ wp_performance_history --site="site1" --timeframe="24h" --metrics="example_value
 }
 ```
 
-
-
-
-
-
-
-
 ## Response Format
 
 **Return Type:** `PerformanceMetrics`
@@ -128,34 +124,24 @@ wp_performance_history --site="site1" --timeframe="24h" --metrics="example_value
 
 ### AUTHENTICATION_FAILED
 
-**Message:** Authentication failed  
-**Description:** Invalid credentials or insufficient permissions  
-**Resolution:** Check your authentication credentials and user permissions
-
+**Message:** Authentication failed **Description:** Invalid credentials or insufficient permissions **Resolution:**
+Check your authentication credentials and user permissions
 
 ### VALIDATION_ERROR
 
-**Message:** Parameter validation failed  
-**Description:** One or more required parameters are missing or invalid  
+**Message:** Parameter validation failed **Description:** One or more required parameters are missing or invalid
 **Resolution:** Review the required parameters and their formats
 
-
 ### NOT_FOUND
 
-**Message:** Resource not found  
-**Description:** The requested resource does not exist  
-**Resolution:** Verify the resource ID and ensure it exists
-
+**Message:** Resource not found **Description:** The requested resource does not exist **Resolution:** Verify the
+resource ID and ensure it exists
 
 ### PERMISSION_DENIED
 
-**Message:** Insufficient permissions  
-**Description:** The user does not have permission to perform this action  
+**Message:** Insufficient permissions **Description:** The user does not have permission to perform this action
 **Resolution:** Contact an administrator to grant the necessary permissions
 
-
-
-
 ---
 
-*Generated automatically from tool definitions - Do not edit manually*
+_Generated automatically from tool definitions - Do not edit manually_