mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_list_media.md

@@ -0,0 +1,145 @@
+# wp_list_media
+
+![media](https://img.shields.io/badge/category-media-purple)
+
+Lists media items from a WordPress site, with filters.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `per_page` | `number` | ❌ | Number of items to return per page (max 100). | `10` | `10`, `20` |
+| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
+| `media_type` | `string` | ❌ | Limit results to a specific media type. | - | `example` |
+
+## Examples
+
+### Basic media Usage
+
+Simple example of using wp_list_media
+
+**Command:**
+```bash
+wp_list_media 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example media 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example media 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+**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_list_media --per_page="10" --search="wordpress" --media_type="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example media 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example media 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `media[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // media[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_list_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_list_pages.md

@@ -0,0 +1,145 @@
+# wp_list_pages
+
+![page](https://img.shields.io/badge/category-page-lightgrey)
+
+Lists pages from a WordPress site, with filters.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `per_page` | `number` | ❌ | Number of items to return per page (max 100). | `10` | `10`, `20` |
+| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
+| `status` | `string` | ❌ | Filter by page status. | `publish` | `example` |
+
+## Examples
+
+### Basic page Usage
+
+Simple example of using wp_list_pages
+
+**Command:**
+```bash
+wp_list_pages 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example page 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example page 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+**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_list_pages --per_page="10" --search="wordpress" --status="publish"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example page 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example page 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `page[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // page[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_list_pages",
+    "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_list_posts.md

@@ -0,0 +1,156 @@
+# wp_list_posts
+
+![post](https://img.shields.io/badge/category-post-lightgrey)
+
+Lists posts from a WordPress site, with filters.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `per_page` | `number` | ❌ | Number of items to return per page (max 100). | `10` | `10`, `20` |
+| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
+| `status` | `string` | ❌ | Filter by post status. | `publish` | `example` |
+| `categories` | `array` | ❌ | Limit results to posts in specific category IDs. | - | `example` |
+| `tags` | `array` | ❌ | Limit results to posts with specific tag IDs. | - | `example` |
+
+## Examples
+
+### Basic post Usage
+
+Simple example of using wp_list_posts
+
+**Command:**
+```bash
+wp_list_posts 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example post 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example post 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+### Advanced post Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_list_posts --per_page="10" --search="wordpress" --status="publish" --categories="example_value" --tags="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example post 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example post 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+
+
+
+## WordPress REST API Mapping
+
+**Endpoint:** `/wp-json/wp/v2/posts`
+
+This tool directly interfaces with the WordPress REST API endpoint above. The response format and available parameters are determined by WordPress core functionality.
+
+### WordPress Documentation
+- [WordPress REST API Handbook](https://developer.wordpress.org/rest-api/)
+- [Endpoint Reference](https://developer.wordpress.org/rest-api/reference/)
+
+
+
+
+## Response Format
+
+**Return Type:** `post[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // post[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_list_posts",
+    "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_list_tags.md

@@ -0,0 +1,110 @@
+# wp_list_tags
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Lists tags from a WordPress site.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_list_tags
+
+**Command:**
+```bash
+wp_list_tags 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example taxonomy 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example taxonomy 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+**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_list_tags",
+    "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_list_users.md

@@ -0,0 +1,111 @@
+# wp_list_users
+
+![user](https://img.shields.io/badge/category-user-lightgrey)
+
+Lists users from a WordPress site, with filters.
+
+## 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` |
+
+## Examples
+
+### Basic user Usage
+
+Simple example of using wp_list_users
+
+**Command:**
+```bash
+wp_list_users 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example user 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example user 2",
+      "status": "draft"
+    }
+  ],
+  "total": 2,
+  "pages": 1
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `user[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // user[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_list_users",
+    "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*