mcp-wordpress 1.1.7 → 1.2.2

package/docs/api/tools/wp_get_comment.md

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

@@ -0,0 +1,101 @@
+# wp_get_current_user
+
+![user](https://img.shields.io/badge/category-user-lightgrey)
+
+Retrieves the currently authenticated user.
+
+## Parameters
+
+*No parameters required.*
+
+## Examples
+
+### Basic user Usage
+
+Simple example of using wp_get_current_user
+
+**Command:**
+```bash
+wp_get_current_user 
+```
+
+**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_current_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_get_media.md

@@ -0,0 +1,103 @@
+# wp_get_media
+
+![media](https://img.shields.io/badge/category-media-purple)
+
+Retrieves a single media item by its ID.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The unique identifier for the media item. | - | `123`, `456` |
+
+## Examples
+
+### Basic media Usage
+
+Simple example of using wp_get_media
+
+**Command:**
+```bash
+wp_get_media --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Example media",
+    "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:** `media`
+
+```json
+{
+  "success": true,
+  "data": {
+    // media response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_get_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_get_page.md

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

@@ -0,0 +1,103 @@
+# wp_get_page_revisions
+
+![page](https://img.shields.io/badge/category-page-lightgrey)
+
+Retrieves revisions for a specific page.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The ID of the page to get revisions for. | - | `123`, `456` |
+
+## Examples
+
+### Basic page Usage
+
+Simple example of using wp_get_page_revisions
+
+**Command:**
+```bash
+wp_get_page_revisions --id="123"
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "data": {
+    "id": 123,
+    "title": "Example page",
+    "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:** `page`
+
+```json
+{
+  "success": true,
+  "data": {
+    // page response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_get_page_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_post.md

@@ -0,0 +1,112 @@
+# wp_get_post
+
+![post](https://img.shields.io/badge/category-post-lightgrey)
+
+Retrieves a single post by its ID.
+
+## Parameters
+
+| Parameter | Type | Required | Description | Default | Examples |
+|-----------|------|----------|-------------|---------|----------|
+| `id` | `number` | ✅ | The unique identifier for the post. | - | `123`, `456` |
+
+## Examples
+
+### Basic post Usage
+
+Simple example of using wp_get_post
+
+**Command:**
+```bash
+wp_get_post --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"
+}
+```
+
+
+## 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/)
+
+
+
+
+## Response Format
+
+**Return Type:** `post`
+
+```json
+{
+  "success": true,
+  "data": {
+    // post response data
+  },
+  "metadata": {
+    "timestamp": "2024-01-01T00:00:00.000Z",
+    "tool": "wp_get_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*