mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_create_user.md

@@ -0,0 +1,135 @@
+# wp_create_user
+
+![user](https://img.shields.io/badge/category-user-lightgrey)
+
+Creates a new user.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `username` | `string` | ✅ | The username for the new user. | - | `john_doe`, `admin` |
+| `email` | `string` | ✅ | The email address for the new user. | - | `user@example.com`, `admin@site.com` |
+| `password` | `string` | ✅ | The password for the new user. | - | `example` |
+| `roles` | `array` | ❌ | An array of roles to assign to the user. | - | `example` |
+
+## Examples
+
+### Basic user Usage
+
+Simple example of using wp_create_user
+
+**Command:**
+```bash
+wp_create_user --username="john_doe" --email="user@example.com"
+```
+
+**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"
+}
+```
+
+
+### Advanced user Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_create_user --username="john_doe" --email="user@example.com" --password="example_value" --roles="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `create_users`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `user`
+
+```json
+{
+  "success": true,
+  "data": {
+    // user response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_create_user",
+    "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_delete_application_password.md

@@ -0,0 +1,101 @@
+# wp_delete_application_password
+
+![site](https://img.shields.io/badge/category-site-lightblue)
+
+Revokes an existing application password.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `user_id` | `number` | ✅ | The ID of the user who owns the password. | - | `example` |
+| `uuid` | `string` | ✅ | The UUID of the application password to revoke. | - | `example` |
+
+## Examples
+
+### Basic site Usage
+
+Simple example of using wp_delete_application_password
+
+**Command:**
+```bash
+wp_delete_application_password --user_id="example_value" --uuid="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "deleted": true,
+    "id": 123
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `DeleteResult`
+
+```json
+{
+  "success": true,
+  "data": {
+    // DeleteResult response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_delete_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*

package/docs/api/tools/wp_delete_category.md

@@ -0,0 +1,100 @@
+# wp_delete_category
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Deletes a category.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the category to delete. | - | `123`, `456` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_delete_category
+
+**Command:**
+```bash
+wp_delete_category --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "deleted": true,
+    "id": 123
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `DeleteResult`
+
+```json
+{
+  "success": true,
+  "data": {
+    // DeleteResult response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_delete_category",
+    "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_delete_comment.md

@@ -0,0 +1,101 @@
+# wp_delete_comment
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Deletes a comment.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the comment to delete. | - | `123`, `456` |
+| `force` | `boolean` | ❌ | If true, the comment will be permanently deleted. Defaults to false (moved to trash). | - | `example` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_delete_comment
+
+**Command:**
+```bash
+wp_delete_comment --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "deleted": true,
+    "id": 123
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `DeleteResult`
+
+```json
+{
+  "success": true,
+  "data": {
+    // DeleteResult response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_delete_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_delete_media.md

@@ -0,0 +1,108 @@
+# wp_delete_media
+
+![media](https://img.shields.io/badge/category-media-purple)
+
+Deletes a media item.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the media item to delete. | - | `123`, `456` |
+| `force` | `boolean` | ❌ | If true, permanently delete. If false, move to trash. Defaults to false. | - | `example` |
+
+## Examples
+
+### Basic media Usage
+
+Simple example of using wp_delete_media
+
+**Command:**
+```bash
+wp_delete_media --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "deleted": true,
+    "id": 123
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `delete_files`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `DeleteResult`
+
+```json
+{
+  "success": true,
+  "data": {
+    // DeleteResult response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_delete_media",
+    "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_delete_page.md

@@ -0,0 +1,108 @@
+# wp_delete_page
+
+![page](https://img.shields.io/badge/category-page-lightgrey)
+
+Deletes a page.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the page to delete. | - | `123`, `456` |
+| `force` | `boolean` | ❌ | If true, permanently delete. If false, move to trash. Defaults to false. | - | `example` |
+
+## Examples
+
+### Basic page Usage
+
+Simple example of using wp_delete_page
+
+**Command:**
+```bash
+wp_delete_page --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "deleted": true,
+    "id": 123
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `delete_pages`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `DeleteResult`
+
+```json
+{
+  "success": true,
+  "data": {
+    // DeleteResult response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_delete_page",
+    "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*