mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/summary.json

@@ -0,0 +1,12 @@
+{
+  "totalTools": 59,
+  "totalCategories": 10,
+  "totalTypes": 1,
+  "lastUpdated": "2025-06-29T22:22:37.534Z",
+  "version": "1.2.0",
+  "coverage": {
+    "toolsWithExamples": 59,
+    "toolsWithWordPressMapping": 5,
+    "typesDocumented": 1
+  }
+}

package/docs/api/tools/wp_approve_comment.md

@@ -0,0 +1,98 @@
+# wp_approve_comment
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Approves a pending comment.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the comment to approve. | - | `123`, `456` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_approve_comment
+
+**Command:**
+```bash
+wp_approve_comment --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_approve_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_approve_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_cache_clear.md

@@ -0,0 +1,120 @@
+# wp_cache_clear
+
+![cache](https://img.shields.io/badge/category-cache-grey)
+
+Clear cache for a WordPress site.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Site ID to clear cache for. | - | `site1`, `production` |
+| `pattern` | `string` | ❌ | Optional pattern to clear specific cache entries (e.g., "posts", "categories"). | - | `example` |
+
+## Examples
+
+### Basic cache Usage
+
+Simple example of using wp_cache_clear
+
+**Command:**
+```bash
+wp_cache_clear 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_clear executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site cache Usage
+
+Using wp_cache_clear with specific site targeting
+
+**Command:**
+```bash
+wp_cache_clear --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_clear executed successfully"
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `CacheStats`
+
+```json
+{
+  "success": true,
+  "data": {
+    // CacheStats response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_cache_clear",
+    "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_cache_info.md

@@ -0,0 +1,119 @@
+# wp_cache_info
+
+![cache](https://img.shields.io/badge/category-cache-grey)
+
+Get detailed cache configuration and status information.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Site ID to get cache info for. | - | `site1`, `production` |
+
+## Examples
+
+### Basic cache Usage
+
+Simple example of using wp_cache_info
+
+**Command:**
+```bash
+wp_cache_info 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_info executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site cache Usage
+
+Using wp_cache_info with specific site targeting
+
+**Command:**
+```bash
+wp_cache_info --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_info executed successfully"
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `CacheStats`
+
+```json
+{
+  "success": true,
+  "data": {
+    // CacheStats response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_cache_info",
+    "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_cache_stats.md

@@ -0,0 +1,119 @@
+# wp_cache_stats
+
+![cache](https://img.shields.io/badge/category-cache-grey)
+
+Get cache statistics for a WordPress site.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Site ID to get cache stats for. If not provided, uses default site or fails if multiple sites configured. | - | `site1`, `production` |
+
+## Examples
+
+### Basic cache Usage
+
+Simple example of using wp_cache_stats
+
+**Command:**
+```bash
+wp_cache_stats 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_stats executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site cache Usage
+
+Using wp_cache_stats with specific site targeting
+
+**Command:**
+```bash
+wp_cache_stats --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_stats executed successfully"
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `CacheStats`
+
+```json
+{
+  "success": true,
+  "data": {
+    // CacheStats response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_cache_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_cache_warm.md

@@ -0,0 +1,119 @@
+# wp_cache_warm
+
+![cache](https://img.shields.io/badge/category-cache-grey)
+
+Pre-warm cache with essential WordPress data.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `site` | `string` | ❌ | Site ID to warm cache for. | - | `site1`, `production` |
+
+## Examples
+
+### Basic cache Usage
+
+Simple example of using wp_cache_warm
+
+**Command:**
+```bash
+wp_cache_warm 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_warm executed successfully"
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Multi-Site cache Usage
+
+Using wp_cache_warm with specific site targeting
+
+**Command:**
+```bash
+wp_cache_warm --site="site1"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_cache_warm executed successfully"
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `CacheStats`
+
+```json
+{
+  "success": true,
+  "data": {
+    // CacheStats response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_cache_warm",
+    "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_create_application_password.md

@@ -0,0 +1,102 @@
+# wp_create_application_password
+
+![site](https://img.shields.io/badge/category-site-lightblue)
+
+Creates a new application password for a user.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `user_id` | `number` | ✅ | The ID of the user to create the password for. | - | `example` |
+| `app_name` | `string` | ✅ | The name of the application this password is for. | - | `example` |
+
+## Examples
+
+### Basic site Usage
+
+Simple example of using wp_create_application_password
+
+**Command:**
+```bash
+wp_create_application_password --user_id="example_value" --app_name="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+**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_create_application_password",
+    "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*