mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_performance_optimize.md

@@ -0,0 +1,162 @@
+# wp_performance_optimize
+
+![performance](https://img.shields.io/badge/category-performance-brightgreen)
+
+Get optimization recommendations and insights
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
+| `focus` | `string` | ❌ | Optimization focus area (speed, reliability, efficiency, scaling) | - | `example` |
+| `priority` | `string` | ❌ | Implementation timeline (quick_wins, medium_term, long_term, all) | - | `example` |
+| `includeROI` | `boolean` | ❌ | Include ROI estimates (default: true) | - | `example` |
+| `includePredictions` | `boolean` | ❌ | Include performance predictions (default: true) | - | `example` |
+
+## Examples
+
+### Basic performance Usage
+
+Simple example of using wp_performance_optimize
+
+**Command:**
+```bash
+wp_performance_optimize 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site performance Usage
+
+Using wp_performance_optimize with specific site targeting
+
+**Command:**
+```bash
+wp_performance_optimize --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+
+
+
+### Advanced performance Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_performance_optimize --site="site1" --focus="example_value" --priority="example_value" --includeROI="example_value" --includePredictions="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `PerformanceMetrics`
+
+```json
+{
+  "success": true,
+  "data": {
+    // PerformanceMetrics response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_performance_optimize",
+    "site": "site1"
+  }
+}
+```
+
+## Error Handling
+
+### AUTHENTICATION_FAILED
+
+**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  
+**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
+
+
+### PERMISSION_DENIED
+
+**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*

package/docs/api/tools/wp_performance_stats.md

@@ -0,0 +1,160 @@
+# wp_performance_stats
+
+![performance](https://img.shields.io/badge/category-performance-brightgreen)
+
+Get real-time performance statistics and metrics
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Specific site ID for multi-site setups (optional for single site) | - | `site1`, `production` |
+| `category` | `string` | ❌ | Category of metrics to return (overview, requests, cache, system, tools, all) | `all` | `example` |
+| `format` | `string` | ❌ | Detail level of the response (summary, detailed, raw) | `summary` | `example` |
+
+## Examples
+
+### Basic performance Usage
+
+Simple example of using wp_performance_stats
+
+**Command:**
+```bash
+wp_performance_stats 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site performance Usage
+
+Using wp_performance_stats with specific site targeting
+
+**Command:**
+```bash
+wp_performance_stats --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+
+
+
+### Advanced performance Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_performance_stats --site="site1" --category="overview" --format="summary"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "overview": {
+      "overallHealth": "Good",
+      "performanceScore": 85,
+      "averageResponseTime": "245ms",
+      "cacheHitRate": "87.5%"
+    }
+  }
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `PerformanceMetrics`
+
+```json
+{
+  "success": true,
+  "data": {
+    // PerformanceMetrics response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_performance_stats",
+    "site": "site1"
+  }
+}
+```
+
+## Error Handling
+
+### AUTHENTICATION_FAILED
+
+**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  
+**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
+
+
+### PERMISSION_DENIED
+
+**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*

package/docs/api/tools/wp_search_site.md

@@ -0,0 +1,99 @@
+# wp_search_site
+
+![site](https://img.shields.io/badge/category-site-lightblue)
+
+Performs a site-wide search for content.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `term` | `string` | ✅ | The search term to look for. | - | `example` |
+| `type` | `string` | ❌ | The type of content to search. | - | `example` |
+
+## Examples
+
+### Basic site Usage
+
+Simple example of using wp_search_site
+
+**Command:**
+```bash
+wp_search_site --term="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_search_site executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `site[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // site[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_search_site",
+    "site": "site1"
+  }
+}
+```
+
+## Error Handling
+
+### AUTHENTICATION_FAILED
+
+**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  
+**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
+
+
+### PERMISSION_DENIED
+
+**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*

package/docs/api/tools/wp_spam_comment.md

@@ -0,0 +1,98 @@
+# wp_spam_comment
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Marks a comment as spam.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the comment to mark as spam. | - | `123`, `456` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_spam_comment
+
+**Command:**
+```bash
+wp_spam_comment --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_spam_comment executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `object`
+
+```json
+{
+  "success": true,
+  "data": {
+    // object response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_spam_comment",
+    "site": "site1"
+  }
+}
+```
+
+## Error Handling
+
+### AUTHENTICATION_FAILED
+
+**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  
+**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
+
+
+### PERMISSION_DENIED
+
+**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*

package/docs/api/tools/wp_switch_auth_method.md

@@ -0,0 +1,122 @@
+# wp_switch_auth_method
+
+![auth](https://img.shields.io/badge/category-auth-darkblue)
+
+Switches the authentication method for a site for the current session.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `method` | `string` | ✅ | The new authentication method to use. | - | `example` |
+| `username` | `string` | ❌ | The username for 'app-password' or 'basic' authentication. | - | `john_doe`, `admin` |
+| `password` | `string` | ❌ | The Application Password for 'app-password' or password for 'basic' auth. | - | `example` |
+| `jwt_token` | `string` | ❌ | The token for 'jwt' authentication. | - | `example` |
+
+## Examples
+
+### Basic auth Usage
+
+Simple example of using wp_switch_auth_method
+
+**Command:**
+```bash
+wp_switch_auth_method --method="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_switch_auth_method executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Advanced auth Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_switch_auth_method --method="example_value" --username="john_doe" --password="example_value" --jwt_token="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_switch_auth_method executed successfully"
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `object`
+
+```json
+{
+  "success": true,
+  "data": {
+    // object response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_switch_auth_method",
+    "site": "site1"
+  }
+}
+```
+
+## Error Handling
+
+### AUTHENTICATION_FAILED
+
+**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  
+**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
+
+
+### PERMISSION_DENIED
+
+**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*