mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_update_post.md

@@ -0,0 +1,144 @@
+# wp_update_post
+
+![post](https://img.shields.io/badge/category-post-lightgrey)
+
+Updates an existing post.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the post to update. | - | `123`, `456` |
+| `title` | `string` | ❌ | The new title for the post. | - | `My Blog Post`, `Hello World` |
+| `content` | `string` | ❌ | The new content for the post, in HTML format. | - | `<p>Post content here</p>`, `This is my post content` |
+| `status` | `string` | ❌ | The new status for the post. | `publish` | `example` |
+
+## Examples
+
+### Basic post Usage
+
+Simple example of using wp_update_post
+
+**Command:**
+```bash
+wp_update_post --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 post Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_post --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"
+  }
+}
+```
+
+
+
+
+## WordPress REST API Mapping
+
+**Endpoint:** `/wp-json/wp/v2/posts/{id}`
+
+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:
+
+- `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_update_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_update_site_settings.md

@@ -0,0 +1,127 @@
+# wp_update_site_settings
+
+![site](https://img.shields.io/badge/category-site-lightblue)
+
+Updates one or more general settings for a WordPress site.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `title` | `string` | ❌ | The title of the site. | - | `My Blog Post`, `Hello World` |
+| `description` | `string` | ❌ | The tagline or description of the site. | - | `example` |
+| `timezone` | `string` | ❌ | A city in the same timezone, e.g., 'America/New_York'. | - | `example` |
+
+## Examples
+
+### Basic site Usage
+
+Simple example of using wp_update_site_settings
+
+**Command:**
+```bash
+wp_update_site_settings 
+```
+
+**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 site Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_site_settings --title="Example Post Title" --description="example_value" --timezone="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Created/Updated successfully",
+    "status": "publish"
+  }
+}
+```
+
+
+
+
+
+
+
+
+## Response Format
+
+**Return Type:** `site`
+
+```json
+{
+  "success": true,
+  "data": {
+    // site response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_update_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_update_tag.md

@@ -0,0 +1,102 @@
+# wp_update_tag
+
+![taxonomy](https://img.shields.io/badge/category-taxonomy-lightgrey)
+
+Updates an existing tag.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the tag to update. | - | `123`, `456` |
+| `name` | `string` | ❌ | The new name for the tag. | - | `example` |
+
+## Examples
+
+### Basic taxonomy Usage
+
+Simple example of using wp_update_tag
+
+**Command:**
+```bash
+wp_update_tag --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_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_update_user.md

@@ -0,0 +1,134 @@
+# wp_update_user
+
+![user](https://img.shields.io/badge/category-user-lightgrey)
+
+Updates an existing user.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the user to update. | - | `123`, `456` |
+| `email` | `string` | ❌ | The new email address for the user. | - | `user@example.com`, `admin@site.com` |
+| `name` | `string` | ❌ | The new display name for the user. | - | `example` |
+
+## Examples
+
+### Basic user Usage
+
+Simple example of using wp_update_user
+
+**Command:**
+```bash
+wp_update_user --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 user Configuration
+
+Comprehensive example using all available parameters
+
+**Command:**
+```bash
+wp_update_user --id="123" --email="user@example.com" --name="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:
+
+- `edit_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_update_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_upload_media.md

@@ -0,0 +1,131 @@
+# wp_upload_media
+
+![media](https://img.shields.io/badge/category-media-purple)
+
+Uploads a file to the WordPress media library.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `file_path` | `string` | ✅ | The local, absolute path to the file to upload. | - | `example` |
+| `title` | `string` | ❌ | The title for the media item. | - | `My Blog Post`, `Hello World` |
+| `alt_text` | `string` | ❌ | Alternative text for the media item (for accessibility). | - | `example` |
+| `caption` | `string` | ❌ | The caption for the media item. | - | `example` |
+| `description` | `string` | ❌ | The description for the media item. | - | `example` |
+| `post` | `number` | ❌ | The ID of a post to attach this media to. | - | `example` |
+
+## Examples
+
+### Basic media Usage
+
+Simple example of using wp_upload_media
+
+**Command:**
+```bash
+wp_upload_media --file_path="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_upload_media executed successfully"
+}
+```
+
+**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_upload_media --file_path="example_value" --title="Example Post Title" --alt_text="example_value" --caption="example_value" --description="example_value" --post="example_value"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {},
+  "message": "wp_upload_media executed successfully"
+}
+```
+
+
+
+
+
+
+## Required Permissions
+
+This tool requires the following WordPress user capabilities:
+
+- `upload_files`
+
+**Note:** The authenticated user must have these capabilities to successfully execute this tool.
+
+
+## Response Format
+
+**Return Type:** `object`
+
+```json
+{
+  "success": true,
+  "data": {
+    // object response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_upload_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/types/WordPressPost.md

@@ -0,0 +1,39 @@
+# WordPressPost
+
+WordPress blog post object
+
+**WordPress Source:** `/wp-json/wp/v2/posts`
+
+## Properties
+
+| Property | Type | Required | Description |
+|----------|------|----------|-------------|
+| `id` | `number` | ✅ | Unique identifier |
+| `title` | `string` | ✅ | Post title |
+| `content` | `string` | ✅ | Post content |
+| `status` | `string` | ✅ | Publication status |
+
+## Example
+
+```json
+{
+  "id": 123,
+  "title": "Welcome to WordPress",
+  "content": "<p>This is your first post. Edit or delete it to get started!</p>",
+  "status": "publish",
+  "date": "2024-01-01T00:00:00Z",
+  "author": 1,
+  "categories": [
+    1
+  ],
+  "tags": [
+    1,
+    2
+  ],
+  "featured_media": 0,
+  "excerpt": "A sample WordPress post",
+  "slug": "welcome-to-wordpress"
+}
+```
+
+