mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_get_post_revisions.md

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

@@ -0,0 +1,108 @@
+# wp_get_site_settings
+
+![site](https://img.shields.io/badge/category-site-lightblue)
+
+Retrieves the general settings for a WordPress site.
+
+## Parameters
+
+*No parameters required.*
+
+## Examples
+
+### Basic site Usage
+
+Simple example of using wp_get_site_settings
+
+**Command:**
+```bash
+wp_get_site_settings 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Example site",
+    "content": "Example content",
+    "status": "publish",
+    "date": "2024-01-01T00:00:00Z"
+  }
+}
+```
+
+**Error Example (Authentication failure):**
+```json
+{
+  "error": "Authentication failed",
+  "message": "Invalid credentials or insufficient permissions"
+}
+```
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `manage_options`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `site`
+
+```json
+{
+  "success": true,
+  "data": {
+    // site response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_get_site_settings",
+    "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_get_tag.md

@@ -0,0 +1,103 @@
+# wp_get_tag
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Retrieves a single tag by its ID.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The unique identifier for the tag. | - | `123`, `456` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_get_tag
+
+**Command:**
+```bash
+wp_get_tag --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Example taxonomy",
+    "content": "Example content",
+    "status": "publish",
+    "date": "2024-01-01T00:00:00Z"
+  }
+}
+```
+
+**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_get_tag",
+    "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_get_user.md

@@ -0,0 +1,103 @@
+# wp_get_user
+
+![user](https://img.shields.io/badge/category-user-lightgrey)
+
+Retrieves a single user by their ID.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The unique identifier for the user. | - | `123`, `456` |
+
+## Examples
+
+### Basic user Usage
+
+Simple example of using wp_get_user
+
+**Command:**
+```bash
+wp_get_user --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Example user",
+    "content": "Example content",
+    "status": "publish",
+    "date": "2024-01-01T00:00:00Z"
+  }
+}
+```
+
+**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_get_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_list_categories.md

@@ -0,0 +1,111 @@
+# wp_list_categories
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Lists categories from a WordPress site.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `search` | `string` | ❌ | Limit results to those matching a search term. | - | `wordpress`, `tutorial` |
+| `hide_empty` | `boolean` | ❌ | Whether to hide categories with no posts. | - | `example` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_list_categories
+
+**Command:**
+```bash
+wp_list_categories 
+```
+
+**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_categories",
+    "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_comments.md

@@ -0,0 +1,111 @@
+# wp_list_comments
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Lists comments from a WordPress site, with filters.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `post` | `number` | ❌ | Limit results to comments assigned to a specific post ID. | - | `example` |
+| `status` | `string` | ❌ | Filter by comment status. | `publish` | `example` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_list_comments
+
+**Command:**
+```bash
+wp_list_comments 
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1,
+      "title": "Example comment 1",
+      "status": "publish"
+    },
+    {
+      "id": 2,
+      "title": "Example comment 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:** `comment[]`
+
+```json
+{
+  "success": true,
+  "data": {
+    // comment[] response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_list_comments",
+    "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*