mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_create_category.md

@@ -0,0 +1,102 @@
+# wp_create_category
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Creates a new category.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `name` | `string` | ✅ | The name of the category. | - | `example` |
+| `description` | `string` | ❌ | The description for the category. | - | `example` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_create_category
+
+**Command:**
+```bash
+wp_create_category --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:** `taxonomy`
+
+```json
+{
+  "success": true,
+  "data": {
+    // taxonomy response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_create_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_create_comment.md

@@ -0,0 +1,128 @@
+# wp_create_comment
+
+![comment](https://img.shields.io/badge/category-comment-lightgrey)
+
+Creates a new comment on a post.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `post` | `number` | ✅ | The ID of the post to comment on. | - | `example` |
+| `content` | `string` | ✅ | The content of the comment. | - | `<p>Post content here</p>`, `This is my post content` |
+| `author_name` | `string` | ❌ | The name of the comment author. | - | `example` |
+| `author_email` | `string` | ❌ | The email of the comment author. | - | `example` |
+
+## Examples
+
+### Basic comment Usage
+
+Simple example of using wp_create_comment
+
+**Command:**
+```bash
+wp_create_comment --post="example_value" --content="This is example content for the post."
+```
+
+**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_create_comment --post="example_value" --content="This is example content for the post." --author_name="example_value" --author_email="example_value"
+```
+
+**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_create_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_create_page.md

@@ -0,0 +1,135 @@
+# wp_create_page
+
+![page](https://img.shields.io/badge/category-page-lightgrey)
+
+Creates a new page.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `title` | `string` | ✅ | The title for the page. | - | `My Blog Post`, `Hello World` |
+| `content` | `string` | ❌ | The content for the page, in HTML format. | - | `<p>Post content here</p>`, `This is my post content` |
+| `status` | `string` | ❌ | The publishing status for the page. | `publish` | `example` |
+
+## Examples
+
+### Basic page Usage
+
+Simple example of using wp_create_page
+
+**Command:**
+```bash
+wp_create_page --title="Example Post Title"
+```
+
+**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_create_page --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:
+
+- `publish_pages`
+- `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_create_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*

package/docs/api/tools/wp_create_post.md

@@ -0,0 +1,147 @@
+# wp_create_post
+
+![post](https://img.shields.io/badge/category-post-lightgrey)
+
+Creates a new post.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `title` | `string` | ✅ | The title for the post. | - | `My Blog Post`, `Hello World` |
+| `content` | `string` | ❌ | The content for the post, in HTML format. | - | `<p>Post content here</p>`, `This is my post content` |
+| `status` | `string` | ❌ | The publishing status for the post. | `publish` | `example` |
+| `excerpt` | `string` | ❌ | The excerpt for the post. | - | `example` |
+| `categories` | `array` | ❌ | An array of category IDs to assign to the post. | - | `example` |
+| `tags` | `array` | ❌ | An array of tag IDs to assign to the post. | - | `example` |
+
+## Examples
+
+### Basic post Usage
+
+Simple example of using wp_create_post
+
+**Command:**
+```bash
+wp_create_post --title="Example Post Title"
+```
+
+**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 post Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_create_post --title="Example Post Title" --content="This is example content for the post." --status="publish" --excerpt="example_value" --categories="example_value" --tags="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+## 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/)
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `publish_posts`
+- `edit_posts`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `post`
+
+```json
+{
+  "success": true,
+  "data": {
+    // post response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_create_post",
+    "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_tag.md

@@ -0,0 +1,101 @@
+# wp_create_tag
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Creates a new tag.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `name` | `string` | ✅ | The name of the tag. | - | `example` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_create_tag
+
+**Command:**
+```bash
+wp_create_tag --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:** `taxonomy`
+
+```json
+{
+  "success": true,
+  "data": {
+    // taxonomy response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_create_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*