mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_test_auth.md

@@ -0,0 +1,96 @@
+# wp_test_auth
+
+![auth](https://img.shields.io/badge/category-auth-darkblue)
+
+Tests the authentication and connectivity for a configured WordPress site.
+
+## Parameters
+
+*No parameters required.*
+
+## Examples
+
+### Basic auth Usage
+
+Simple example of using wp_test_auth
+
+**Command:**
+```bash
+wp_test_auth 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_test_auth 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_test_auth",
+    "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_update_category.md

@@ -0,0 +1,102 @@
+# wp_update_category
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Updates an existing category.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the category to update. | - | `123`, `456` |
+| `name` | `string` | ❌ | The new name for the category. | - | `example` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_update_category
+
+**Command:**
+```bash
+wp_update_category --id="123"
+```
+
+**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:** `taxonomy`
+
+```json
+{
+  "success": true,
+  "data": {
+    // taxonomy response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_update_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_update_comment.md

@@ -0,0 +1,127 @@
+# wp_update_comment
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Updates an existing comment.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the comment to update. | - | `123`, `456` |
+| `content` | `string` | ❌ | The updated content for the comment. | - | `<p>Post content here</p>`, `This is my post content` |
+| `status` | `string` | ❌ | The new status for the comment. | `publish` | `example` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_update_comment
+
+**Command:**
+```bash
+wp_update_comment --id="123"
+```
+
+**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 comment Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_comment --id="123" --content="This is example content for the post." --status="publish"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `comment`
+
+```json
+{
+  "success": true,
+  "data": {
+    // comment response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_update_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_update_media.md

@@ -0,0 +1,129 @@
+# wp_update_media
+
+![media](https://img.shields.io/badge/category-media-purple)
+
+Updates the metadata of an existing media item.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the media item to update. | - | `123`, `456` |
+| `title` | `string` | ❌ | The new title for the media item. | - | `My Blog Post`, `Hello World` |
+| `alt_text` | `string` | ❌ | The new alternative text. | - | `example` |
+| `caption` | `string` | ❌ | The new caption. | - | `example` |
+| `description` | `string` | ❌ | The new description. | - | `example` |
+
+## Examples
+
+### Basic media Usage
+
+Simple example of using wp_update_media
+
+**Command:**
+```bash
+wp_update_media --id="123"
+```
+
+**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 media Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_media --id="123" --title="Example Post Title" --alt_text="example_value" --caption="example_value" --description="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `media`
+
+```json
+{
+  "success": true,
+  "data": {
+    // media response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_update_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_update_page.md

@@ -0,0 +1,135 @@
+# wp_update_page
+
+![page](https://img.shields.io/badge/category-page-lightgrey)
+
+Updates an existing page.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the page to update. | - | `123`, `456` |
+| `title` | `string` | ❌ | The new title for the page. | - | `My Blog Post`, `Hello World` |
+| `content` | `string` | ❌ | The new content for the page, in HTML format. | - | `<p>Post content here</p>`, `This is my post content` |
+| `status` | `string` | ❌ | The new status for the page. | `publish` | `example` |
+
+## Examples
+
+### Basic page Usage
+
+Simple example of using wp_update_page
+
+**Command:**
+```bash
+wp_update_page --id="123"
+```
+
+**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 page Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_page --id="123" --title="Example Post Title" --content="This is example content for the post." --status="publish"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `edit_pages`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `page`
+
+```json
+{
+  "success": true,
+  "data": {
+    // page response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_update_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*