### Configure wp-sites.json for Local Development

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Copy the example wp-sites.json file and edit it with your WordPress credentials for local development setup. Secure the file after editing.

```bash
# Copy example
cp wp-sites.json.example wp-sites.json

# Edit with your credentials
nano wp-sites.json

# Secure the file
chmod 600 wp-sites.json
```

--------------------------------

### Verification Script Example

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

A basic bash script to initiate testing for Claudeus WordPress MCP. This script serves as a starting point for automated verification processes.

```bash
#!/bin/bash

echo "🧪 Testing Claudeus WordPress MCP..."


```

--------------------------------

### Install Claudeus WP MCP Globally

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Install the tool globally using npm for command-line access. Ensure Node.js and npm are installed.

```bash
npm install -g claudeus-wp-mcp
```

--------------------------------

### Test Inspector Launch

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Starts the inspector in the background and checks if it's running by sending a curl request to its local address. Waits for 5 seconds for the inspector to start.

```bash
echo "2️⃣ Testing Inspector..."
pnpm inspector &
sleep 5
curl -s http://localhost:5173 > /dev/null && echo "✅ Inspector running" || echo "❌ Inspector failed"
```

--------------------------------

### Install Claudeus WordPress MCP Globally

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Install the package globally using npm for command-line access. Alternatively, use npx for immediate execution without global installation.

```bash
npm install -g claudeus-wp-mcp
```

```bash
npx claudeus-wp-mcp
```

--------------------------------

### List Plugins

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Lists all installed WordPress plugins with their status and version information.

```APIDOC
## GET /api/claudeus/wp/plugins/list

### Description
Lists all installed WordPress plugins with status and version information.

### Method
GET

### Endpoint
/api/claudeus/wp/plugins/list

### Parameters
#### Query Parameters
- **site** (string) - Required - The target WordPress site (e.g., "production", "staging").
- **filters** (object) - Optional - Filters to apply to the plugin list.
  - **status** (string) - Optional - Filter by plugin status (e.g., "active", "inactive", "all").

### Request Example
```json
{
  "tool": "claudeus_wp_plugins__list",
  "arguments": {
    "site": "production",
    "filters": {
      "status": "active"
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of installed plugins.
  - **plugin** (string) - The plugin path (e.g., "akismet/akismet").
  - **status** (string) - The current status of the plugin (e.g., "active", "inactive").
  - **name** (string) - The display name of the plugin.
  - **version** (string) - The installed version of the plugin.
  - **author** (string) - The author of the plugin.
  - **description** (string) - A brief description of the plugin.

#### Response Example
```json
{
  "data": [
    {
      "plugin": "akismet/akismet",
      "status": "active",
      "name": "Akismet Anti-Spam",
      "version": "5.3",
      "author": "Automattic",
      "description": "Used by millions to protect sites from spam"
    },
    {
      "plugin": "woocommerce/woocommerce",
      "status": "active",
      "name": "WooCommerce",
      "version": "8.5.1",
      "author": "Automattic"
    }
  ]
}
```
```

--------------------------------

### Clone and Set Up Repository

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/CONTRIBUTING.md

Follow these steps to fork, clone the repository, install dependencies, and create a new feature branch for development.

```bash
# Fork and clone the repository
git clone https://github.com/YOUR-USERNAME/claudeus-wp-mcp.git
cd claudeus-wp-mcp

# Install dependencies
pnpm install

# Create a feature branch
git checkout -b feature/your-feature-name
```

--------------------------------

### Install Claudeus WordPress MCP Server

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Install the MCP server globally using npm or use npx for on-demand execution. This makes the server available for Claude Desktop integration.

```bash
# Install globally
npm install -g claudeus-wp-mcp

# Or use npx (no installation needed)
# Configure in claude_desktop_config.json with npx command
```

--------------------------------

### Absolute Path Example

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Illustrates the correct format for specifying absolute paths in the configuration. Relative paths like '~/' are not supported.

```json
// ❌ Wrong
"WP_SITES_PATH": "~/wp-sites.json"

// ✅ Correct
"WP_SITES_PATH": "/Users/yourname/wp-sites.json"
```

--------------------------------

### Clone and Build Claudeus WP MCP for Development

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Set up the project for development by cloning the repository, installing dependencies with pnpm, and building the project.

```bash
git clone https://github.com/deus-h/claudeus-wp-mcp
cd claudeus-wp-mcp
pnpm install
pnpm build
```

--------------------------------

### Activate Plugin

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Activates an installed but inactive plugin.

```APIDOC
## POST /api/claudeus/wp/plugins/activate

### Description
Activates an installed but inactive plugin.

### Method
POST

### Endpoint
/api/claudeus/wp/plugins/activate

### Parameters
#### Request Body
- **site** (string) - Required - The target WordPress site (e.g., "production", "staging").
- **plugin** (string) - Required - The plugin path to activate (e.g., "jetpack/jetpack").

### Request Example
```json
{
  "tool": "claudeus_wp_plugins__activate",
  "arguments": {
    "site": "staging",
    "plugin": "jetpack/jetpack"
  }
}
```

### Response
#### Success Response (200)
- **plugin** (string) - The plugin path that was activated.
- **status** (string) - The new status of the plugin, which will be "active".
- **name** (string) - The display name of the plugin.
- **version** (string) - The version of the activated plugin.

#### Response Example
```json
{
  "plugin": "jetpack/jetpack",
  "status": "active",
  "name": "Jetpack",
  "version": "13.0"
}
```
```

--------------------------------

### GET /claudeus_wp_astra__get_mega_menu

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Get Astra Pro mega menu configuration for a specific menu item.

```APIDOC
## GET /claudeus_wp_astra__get_mega_menu

### Description
Get Astra Pro mega menu configuration for a specific menu item.

### Method
GET

### Endpoint
/claudeus_wp_astra__get_mega_menu

### Query Parameters
- **site** (string) - Required - The site environment (e.g., 'production').
- **menu_item_id** (integer) - Required - The ID of the menu item for which to retrieve mega menu settings.

### Response
#### Success Response (200)
- **menu_item_id** (integer) - The ID of the menu item.
- **enabled** (boolean) - Whether mega menu is enabled for this item.
- **columns** (integer) - The number of columns in the mega menu.
- **display_mode** (string) - The display mode of the mega menu (e.g., 'horizontal').
- **column_width** (string) - The width configuration for columns (e.g., 'custom').
- **custom_width** (string) - The custom width value if `column_width` is 'custom'.
- **hide_label** (boolean) - Whether to hide the menu item label.
- **disable_link** (boolean) - Whether to disable the link for the menu item.
- **css_classes** (array) - An array of CSS classes to apply to the mega menu.
- **icon** (string) - The CSS class for the icon to display.
- **icon_position** (string) - The position of the icon (e.g., 'left').

#### Response Example
```json
{
  "menu_item_id": 250,
  "enabled": true,
  "columns": 4,
  "display_mode": "horizontal",
  "column_width": "custom",
  "custom_width": "1000px",
  "hide_label": false,
  "disable_link": false,
  "css_classes": ["mega-menu-products"],
  "icon": "dashicons-cart",
  "icon_position": "left"
}
```
```

--------------------------------

### Get Global Styles

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves the current global styles configuration (theme.json) for the site.

```APIDOC
## GET /api/claudeus/wp/global_styles/get

### Description
Retrieves the current global styles configuration (theme.json) for the site.

### Method
GET

### Endpoint
/api/claudeus/wp/global_styles/get

### Parameters
#### Query Parameters
- **site** (string) - Required - The target WordPress site (e.g., "production", "staging").

### Request Example
```json
{
  "tool": "claudeus_wp_global_styles__get",
  "arguments": {
    "site": "production"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The identifier for the global styles configuration.
- **styles** (object) - Contains styling properties like color, typography, spacing, etc.
- **settings** (object) - Contains theme settings like color palettes, layout options, etc.

#### Response Example
```json
{
  "id": "custom",
  "styles": {
    "color": {
      "background": "#ffffff",
      "text": "#333333"
    },
    "typography": {
      "fontFamily": "Inter, sans-serif",
      "fontSize": "16px",
      "lineHeight": "1.6"
    },
    "elements": {
      "link": {
        "color": {"text": "#0066cc"}
      },
      "heading": {
        "typography": {"fontFamily": "Georgia, serif"}
      }
    }
  },
  "settings": {
    "color": {
      "palette": [
        {"slug": "primary", "color": "#0066cc", "name": "Primary"},
        {"slug": "secondary", "color": "#333333", "name": "Secondary"}
      ]
    },
    "layout": {
      "contentSize": "800px",
      "wideSize": "1200px"
    }
  }
}
```
```

--------------------------------

### Clone and Build Claudeus WordPress MCP (Local Dev)

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Clone the repository, install dependencies, and build the project for local development. This prepares the MCP server to be run directly.

```bash
# Clone repository
git clone https://github.com/deus-h/claudeus-wp-mcp
cd claudeus-wp-mcp

# Install dependencies
pnpm install

# Build project
pnpm build
```

--------------------------------

### Set WordPress Site Configuration Path via Environment Variable

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SECURITY.md

Example of setting the path to the `wp-sites.json` configuration file using an environment variable for enhanced security.

```bash
# Alternative: Use environment variables
export WP_SITES_PATH="/secure/path/to/wp-sites.json"
```

--------------------------------

### Launch Claudeus WP MCP Inspector UI

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Start the Inspector UI for visual testing and exploration of WordPress tools. This command opens a local web server.

```bash
pnpm inspector
```

--------------------------------

### Conventional Commits for PRs

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/CONTRIBUTING.md

Examples of conventional commit message formats for feature, fix, docs, and refactor types.

```bash
- `feat: add new tool for widget management`
- `fix: resolve pagination issue in users API`
- `docs: update security guide`
- `refactor: improve error handling in base client`
```

--------------------------------

### Run Claudeus WP MCP with npx

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Execute the tool directly using npx without global installation. This is a convenient way to run the latest version.

```bash
npx claudeus-wp-mcp
```

--------------------------------

### Analyze Post SEO with AI

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Analyze an existing blog post's SEO performance and get suggestions for improvement using the 'analyze-post-seo' prompt. Requires post ID and target keywords.

```json
{
  "prompt": "analyze-post-seo",
  "arguments": {
    "post_id": "123",
    "target_keywords": "WordPress tutorial, learn WordPress, WordPress guide"
  }
}
```

--------------------------------

### Search WordPress.org Block Directory

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Searches the official WordPress.org block directory for installable blocks. Useful for finding new features or functionalities.

```json
{
  "tool": "claudeus_wp_search__block_directory",
  "arguments": {
    "site": "production",
    "term": "accordion",
    "per_page": 10
  }
}
```

```json
{
  "data": [
    {
      "name": "developer/accordion-block",
      "title": "Accordion Block",
      "description": "Create expandable accordion sections",
      "rating": 5,
      "active_installs": 50000,
      "block_assets": ["accordion.js", "style.css"]
    }
  ]
}
```

--------------------------------

### Output Sanitization Example

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SECURITY.md

Illustrates data sanitization techniques for preventing XSS attacks. Ensures HTML entities are encoded, script tags are stripped, attributes are sanitized, and URLs are validated before output.

```typescript
// All data sanitized before output
- HTML entities encoded
- Script tags stripped
- Attributes sanitized
- URLs validated
```

--------------------------------

### Get WordPress Directory Sizes

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves the storage usage for key WordPress directories, including uploads, themes, plugins, and the database. Useful for monitoring disk space.

```json
{
  "tool": "claudeus_wp_health__get_directory_sizes",
  "arguments": {
    "site": "production"
  }
}
```

```json
{
  "wordpress_size": "45.2 MB",
  "uploads_size": "1.2 GB",
  "themes_size": "12.5 MB",
  "plugins_size": "89.3 MB",
  "database_size": "256 MB",
  "total_size": "1.6 GB",
  "raw_sizes": {
    "wordpress_size": 47396044,
    "uploads_size": 1288490188,
    "themes_size": 13107200,
    "plugins_size": 93650534,
    "database_size": 268435456
  }
}
```

--------------------------------

### GET /claudeus_wp_shop__get_sales

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Get WooCommerce sales statistics and revenue analytics.

```APIDOC
## GET /claudeus_wp_shop__get_sales

### Description
Get WooCommerce sales statistics and revenue analytics.

### Method
GET

### Endpoint
/claudeus_wp_shop__get_sales

### Query Parameters
- **site** (string) - Required - The site environment (e.g., 'production').
- **period** (string) - Optional - The period for sales statistics (e.g., 'day', 'week', 'month', 'year'). Defaults to 'month'.
- **date_min** (string) - Optional - The start date for the sales data (ISO 8601 format).
- **date_max** (string) - Optional - The end date for the sales data (ISO 8601 format).

### Response
#### Success Response (200)
- **total_sales** (string) - Total sales amount.
- **net_sales** (string) - Net sales amount.
- **total_orders** (integer) - Total number of orders.
- **total_items** (integer) - Total number of items sold.
- **total_tax** (string) - Total tax collected.
- **total_shipping** (string) - Total shipping revenue.
- **total_refunds** (integer) - Total number of refunds.
- **total_discount** (string) - Total discount given.
- **average_order_value** (string) - Average order value.

#### Response Example
```json
{
  "total_sales": "12,456.78",
  "net_sales": "11,234.56",
  "total_orders": 156,
  "total_items": 234,
  "total_tax": "1,222.22",
  "total_shipping": "456.00",
  "total_refunds": 3,
  "total_discount": "789.00",
  "average_order_value": "79.85"
}
```
```

--------------------------------

### Launch Inspector UI

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Run this command from the project root to build the project and launch the Inspector UI. The UI will be available at http://localhost:5173.

```bash
# From project root
pnpm inspector
```

--------------------------------

### GET /claudeus_wp_menus__get_locations

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Get all theme-registered menu locations available for menu assignment.

```APIDOC
## GET /claudeus_wp_menus__get_locations

### Description
Get all theme-registered menu locations available for menu assignment.

### Method
GET

### Endpoint
/claudeus_wp_menus__get_locations

### Parameters
#### Query Parameters
- **site** (string) - Required - The site to retrieve menu locations from.

### Response
#### Success Response (200)
- **data** (array) - An array of menu location objects.
  - **name** (string) - The name of the menu location.
  - **description** (string) - A description of the menu location.
  - **menu** (integer) - The ID of the menu currently assigned to this location (0 if none).

### Response Example
```json
{
  "data": [
    {
      "name": "primary",
      "description": "Primary Navigation",
      "menu": 100
    },
    {
      "name": "footer",
      "description": "Footer Navigation",
      "menu": 101
    },
    {
      "name": "mobile",
      "description": "Mobile Navigation",
      "menu": 0
    }
  ]
}
```
```

--------------------------------

### Multi-Client Configuration

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Set up connection details for different clients, each potentially having their own production and staging environments. Use unique passwords for each client and environment.

```json
{
  "client1_prod": {
    "URL": "https://client1-live.com",
    "USER": "admin",
    "PASS": "xxxx xxxx xxxx xxxx",
    "authType": "basic"
  },
  "client1_stage": {
    "URL": "https://client1-staging.com",
    "USER": "admin",
    "PASS": "yyyy yyyy yyyy yyyy",
    "authType": "basic"
  },
  "client2_prod": {
    "URL": "https://client2-live.com",
    "USER": "admin",
    "PASS": "zzzz zzzz zzzz zzzz",
    "authType": "basic"
  }
}
```

--------------------------------

### Pagination Configuration

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Demonstrates how to use pagination filters to retrieve data in smaller batches, improving performance and preventing timeouts.

```json
{
  "filters": {
    "per_page": 10,  // Smaller batches
    "page": 1
  }
}
```

--------------------------------

### Create wp-sites.json Configuration

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Set up the wp-sites.json file in the specified directory. This file holds your WordPress site connection details. Ensure it is secured with appropriate permissions.

```bash
# Create directory for config
mkdir -p ~/.claudeus-mcp

# Create wp-sites.json
cat > ~/.claudeus-mcp/wp-sites.json << 'EOF'
{
  "default_test": {
    "URL": "https://your-site.com",
    "USER": "admin",
    "PASS": "xxxx xxxx xxxx xxxx xxxx xxxx",
    "authType": "basic"
  }
}
EOF

# Secure the file
chmod 600 ~/.claudeus-mcp/wp-sites.json
```

--------------------------------

### Configure Claude Desktop for Local MCP Server

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Add this configuration to your Claude Desktop's `claude_desktop_config.json` for local development. Ensure you provide the absolute paths to the built project's entry point and the wp-sites.json file.

```json
{
  "mcpServers": {
    "claudeus-wordpress": {
      "command": "node",
      "args": [
        "/absolute/path/to/claudeus-wp-mcp/dist/index.js"
      ],
      "env": {
        "WP_SITES_PATH": "/absolute/path/to/claudeus-wp-mcp/wp-sites.json"
      }
    }
  }
}
```

--------------------------------

### claudeus_wp_search__block_directory

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Searches the WordPress.org block directory for installable blocks.

```APIDOC
## POST /claudeus_wp_search__block_directory

### Description
Search the WordPress.org block directory for installable blocks.

### Method
POST

### Endpoint
/claudeus_wp_search__block_directory

### Parameters
#### Request Body
- **site** (string) - Required - The site context for the search (e.g., "production").
- **term** (string) - Required - The search term for blocks.
- **per_page** (integer) - Optional - Number of results per page.

### Request Example
```json
{
  "tool": "claudeus_wp_search__block_directory",
  "arguments": {
    "site": "production",
    "term": "accordion",
    "per_page": 10
  }
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of block directory results.
  - **name** (string) - The name of the block.
  - **title** (string) - The title of the block.
  - **description** (string) - A description of the block.
  - **rating** (number) - The rating of the block.
  - **active_installs** (integer) - The number of active installations.
  - **block_assets** (array) - An array of block assets (e.g., JS, CSS files).

#### Response Example
```json
{
  "data": [
    {
      "name": "developer/accordion-block",
      "title": "Accordion Block",
      "description": "Create expandable accordion sections",
      "rating": 5,
      "active_installs": 50000,
      "block_assets": ["accordion.js", "style.css"]
    }
  ]
}
```
```

--------------------------------

### GET /claudeus_wp_menus__get_menus

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieve all navigation menus registered on the site.

```APIDOC
## GET /claudeus_wp_menus__get_menus

### Description
Retrieve all navigation menus registered on the site.

### Method
GET

### Endpoint
/claudeus_wp_menus__get_menus

### Parameters
#### Query Parameters
- **site** (string) - Required - The site to retrieve menus from.
- **filters** (object) - Optional - Filters to apply to the menu retrieval.
  - **per_page** (integer) - Optional - Number of menus to return per page.

### Response
#### Success Response (200)
- **data** (array) - An array of menu objects.
  - **id** (integer) - The unique identifier for the menu.
  - **name** (string) - The name of the menu.
  - **slug** (string) - The slug for the menu.
  - **description** (string) - A description of the menu.
  - **locations** (array) - An array of theme locations assigned to the menu.

### Response Example
```json
{
  "data": [
    {
      "id": 100,
      "name": "Main Navigation",
      "slug": "main-navigation",
      "description": "Primary site navigation",
      "locations": ["primary"]
    },
    {
      "id": 101,
      "name": "Footer Menu",
      "slug": "footer-menu",
      "description": "Links in the footer",
      "locations": ["footer"]
    }
  ]
}
```
```

--------------------------------

### Database Backup Command

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SECURITY.md

Demonstrates how to perform a database backup using the WordPress CLI. The backup file is named with the current date.

```bash
# Database backup
wp db export backup-$(date +%Y%m%d).sql
```

--------------------------------

### GET /claudeus_wp_taxonomy__get_categories

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves all categories with hierarchy information and post counts.

```APIDOC
## GET claudeus_wp_taxonomy__get_categories

### Description
Retrieve all categories with hierarchy information and post counts.

### Method
GET

### Endpoint
/claudeus_wp_taxonomy__get_categories

### Query Parameters
- **site** (string) - Required - The WordPress site to interact with (e.g., "production").
- **filters** (object) - Optional - Filtering options for the categories.
  - **per_page** (integer) - Optional - Number of items to return per page.
  - **hide_empty** (boolean) - Optional - Whether to hide empty categories.
  - **orderby** (string) - Optional - The field to order the results by (e.g., "name", "count").
  - **order** (string) - Optional - The order of the results (e.g., "asc", "desc").

### Response
#### Success Response (200)
- **data** (array) - An array of category objects.
  - **id** (integer) - The unique identifier for the category.
  - **name** (string) - The name of the category.
  - **slug** (string) - The slug for the category.
  - **description** (string) - The description of the category.
  - **parent** (integer) - The ID of the parent category (0 for top-level categories).
  - **count** (integer) - The number of posts in the category.

### Response Example
{
  "data": [
    {
      "id": 5,
      "name": "Technology",
      "slug": "technology",
      "description": "Tech news and tutorials",
      "parent": 0,
      "count": 45
    },
    {
      "id": 12,
      "name": "Web Development",
      "slug": "web-development",
      "description": "Web dev tutorials and tips",
      "parent": 5,
      "count": 28
    }
  ]
}
```

--------------------------------

### GET /claudeus_wp_shop__get_orders

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieve WooCommerce orders with filtering by status, customer, and date range.

```APIDOC
## GET /claudeus_wp_shop__get_orders

### Description
Retrieve WooCommerce orders with filtering by status, customer, and date range.

### Method
GET

### Endpoint
/claudeus_wp_shop__get_orders

### Query Parameters
- **site** (string) - Required - The site environment (e.g., 'production').
- **per_page** (integer) - Optional - Number of orders to retrieve per page.
- **status** (string) - Optional - Filter orders by their status (e.g., 'processing', 'completed').
- **date_created_min** (string) - Optional - Filter orders created on or after this date (ISO 8601 format).
- **date_created_max** (string) - Optional - Filter orders created on or before this date (ISO 8601 format).

### Response
#### Success Response (200)
- **data** (array) - An array of order objects.
  - **id** (integer) - The unique identifier for the order.
  - **status** (string) - The current status of the order.
  - **total** (string) - The total amount of the order.
  - **currency** (string) - The currency of the order total.
  - **date_created** (string) - The date and time the order was created (ISO 8601 format).
  - **billing** (object) - Billing address details.
    - **first_name** (string) - Billing first name.
    - **last_name** (string) - Billing last name.
    - **email** (string) - Billing email address.
  - **line_items** (array) - An array of items included in the order.
    - **product_id** (integer) - The ID of the product.
    - **name** (string) - The name of the product.
    - **quantity** (integer) - The quantity of the product ordered.
    - **total** (string) - The total price for this line item.

#### Response Example
```json
{
  "data": [
    {
      "id": 5001,
      "status": "processing",
      "total": "149.97",
      "currency": "USD",
      "date_created": "2024-01-15T10:30:00",
      "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john@example.com"
      },
      "line_items": [
        {
          "product_id": 1001,
          "name": "Premium WordPress Theme",
          "quantity": 1,
          "total": "49.99"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Configure Claude Desktop for MCP Server (NPM)

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/SETUP-GUIDE.md

Add this configuration to your Claude Desktop's `claude_desktop_config.json` file to enable the 'claudeus-wp-mcp' server. Use absolute paths for commands and environment variables.

```json
{
  "mcpServers": {
    "claudeus-wp-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "claudeus-wp-mcp"
      ],
      "env": {
        "WP_SITES_PATH": "/Users/YOUR_USERNAME/.claudeus-mcp/wp-sites.json"
      }
    }
  }
}
```

--------------------------------

### GET /claudeus_wp_templates__get_template_parts

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieve all template parts (headers, footers, sidebars) available in the theme.

```APIDOC
## GET /claudeus_wp_templates__get_template_parts

### Description
Retrieve all template parts (headers, footers, sidebars) available in the theme.

### Method
GET

### Endpoint
/claudeus_wp_templates__get_template_parts

### Parameters
#### Query Parameters
- **site** (string) - Required - The site to retrieve template parts from.
- **filters** (object) - Optional - Filters to apply to the template part retrieval.
  - **area** (string) - Optional - Filter template parts by area (e.g., 'header', 'footer').

### Response
#### Success Response (200)
- **data** (array) - An array of template part objects.
  - **id** (string) - The unique identifier for the template part.
  - **slug** (string) - The slug for the template part.
  - **theme** (string) - The theme the template part belongs to.
  - **title** (object) - The title of the template part.
    - **rendered** (string) - The rendered title.
  - **area** (string) - The area of the template part (e.g., 'header').

### Response Example
```json
{
  "data": [
    {
      "id": "twentytwentyfour//header",
      "slug": "header",
      "theme": "twentytwentyfour",
      "title": {"rendered": "Header"},
      "area": "header"
    },
    {
      "id": "twentytwentyfour//header-dark",
      "slug": "header-dark",
      "theme": "twentytwentyfour",
      "title": {"rendered": "Header (Dark)"},
      "area": "header"
    }
  ]
}
```
```

--------------------------------

### Run Comprehensive Test Suite

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Execute the full test suite for the project using pnpm. This includes unit and integration tests.

```bash
pnpm test
```

--------------------------------

### Get Users

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves a list of WordPress users. Supports filtering by roles and other criteria.

```APIDOC
## GET /wp/v2/users

### Description
Retrieve WordPress users with role and capability filtering.

### Method
GET

### Endpoint
/wp/v2/users

### Parameters
#### Query Parameters
- **roles** (array of strings) - Optional - Filter users by their roles (e.g., 'administrator', 'editor').
- **per_page** (integer) - Optional - Number of users to return per page. Default is 10.
- **orderby** (string) - Optional - Field to order users by. Possible values: 'id', 'include', 'name', 'registered_date', 'slug', 'email', 'url'. Default is 'id'.
- **order** (string) - Optional - Order direction. Possible values: 'asc', 'desc'. Default is 'asc'.

### Request Example
```json
{
  "filters": {
    "roles": ["administrator", "editor"],
    "per_page": 50,
    "orderby": "registered_date",
    "order": "desc"
  }
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of user objects.
  - **id** (integer) - The unique identifier for the user.
  - **username** (string) - The username of the user.
  - **name** (string) - The display name of the user.
  - **email** (string) - The email address of the user.
  - **roles** (array of strings) - The roles assigned to the user.
  - **registered_date** (string) - The date and time the user registered.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "username": "admin",
      "name": "Site Administrator",
      "email": "admin@company.com",
      "roles": ["administrator"],
      "registered_date": "2020-01-15T00:00:00"
    },
    {
      "id": 5,
      "username": "jane_editor",
      "name": "Jane Smith",
      "email": "jane@company.com",
      "roles": ["editor"],
      "registered_date": "2023-06-20T00:00:00"
    }
  ]
}
```
```

--------------------------------

### Get Tags

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves a list of tags. Supports searching and filtering by various criteria.

```APIDOC
## GET /wp/v2/tags

### Description
Retrieve all tags with optional search and filtering.

### Method
GET

### Endpoint
/wp/v2/tags

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search term for tag names.
- **per_page** (integer) - Optional - Number of tags to return per page. Default is 10.
- **orderby** (string) - Optional - Field to order tags by. Possible values: 'name', 'slug', 'count', 'include', 'term_id', 'id', 'local'. Default is 'name'.
- **order** (string) - Optional - Order direction. Possible values: 'asc', 'desc'. Default is 'asc'.

### Request Example
```json
{
  "filters": {
    "search": "javascript",
    "per_page": 50,
    "orderby": "count",
    "order": "desc"
  }
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of tag objects.
  - **id** (integer) - The unique identifier for the tag.
  - **name** (string) - The name of the tag.
  - **slug** (string) - The slug of the tag.
  - **count** (integer) - The number of posts associated with this tag.

#### Response Example
```json
{
  "data": [
    {
      "id": 30,
      "name": "JavaScript",
      "slug": "javascript",
      "count": 89
    },
    {
      "id": 45,
      "name": "JavaScript ES6",
      "slug": "javascript-es6",
      "count": 23
    }
  ]
}
```
```

--------------------------------

### GET /claudeus_wp_media__get_media

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves media library items with filters for type, date, and search.

```APIDOC
## GET claudeus_wp_media__get_media

### Description
Retrieve media library items with filters for type, date, and search.

### Method
GET

### Endpoint
/claudeus_wp_media__get_media

### Query Parameters
- **site** (string) - Required - The WordPress site to interact with (e.g., "production").
- **filters** (object) - Optional - Filtering options for the media items.
  - **per_page** (integer) - Optional - Number of items to return per page.
  - **media_type** (string) - Optional - The type of media to retrieve (e.g., "image", "video").
  - **orderby** (string) - Optional - The field to order the results by (e.g., "date", "title").
  - **order** (string) - Optional - The order of the results (e.g., "asc", "desc").
  - **search** (string) - Optional - A search term to filter media by title or filename.

### Response
#### Success Response (200)
- **data** (array) - An array of media objects.
  - **id** (integer) - The unique identifier for the media item.
  - **title** (object) - The title of the media item.
    - **rendered** (string) - The rendered title of the media item.
  - **source_url** (string) - The URL of the media item.
  - **alt_text** (string) - The alternative text for the media item.
  - **media_type** (string) - The type of the media item (e.g., "image").
  - **mime_type** (string) - The MIME type of the media item (e.g., "image/jpeg").
  - **media_details** (object) - Details about the media item.
    - **width** (integer) - The width of the media item.
    - **height** (integer) - The height of the media item.
    - **sizes** (object) - Available sizes for the media item.

### Response Example
{
  "data": [
    {
      "id": 500,
      "title": {"rendered": "hero-image"},
      "source_url": "https://your-site.com/wp-content/uploads/2024/01/hero-image.jpg",
      "alt_text": "Company headquarters building",
      "media_type": "image",
      "mime_type": "image/jpeg",
      "media_details": {
        "width": 1920,
        "height": 1080,
        "sizes": {
          "thumbnail": {"source_url": "...", "width": 150, "height": 150},
          "medium": {"source_url": "...", "width": 300, "height": 169},
          "large": {"source_url": "...", "width": 1024, "height": 576}
        }
      }
    }
  ]
}
```

--------------------------------

### Development Workflow Commands

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/CONTRIBUTING.md

Essential commands for building, linting, testing, and running the MCP Inspector during development.

```bash
# Build TypeScript
pnpm build

# Run linter
pnpm lint

# Fix linting issues
pnpm lint:fix

# Run tests
pnpm test

# Test with MCP Inspector
pnpm inspector
```

--------------------------------

### GET /claudeus_wp_content__get_blocks

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieves a list of reusable blocks (synced patterns) available on the site.

```APIDOC
## GET claudeus_wp_content__get_blocks

### Description
Retrieve reusable blocks (synced patterns) available on the site.

### Method
GET

### Endpoint
/claudeus_wp_content__get_blocks

### Query Parameters
- **site** (string) - Required - The WordPress site to interact with (e.g., "production").
- **filters** (object) - Optional - Filtering options for the blocks.
  - **per_page** (integer) - Optional - Number of items to return per page.

### Response
#### Success Response (200)
- **data** (array) - An array of block objects.
  - **id** (integer) - The unique identifier for the block.
  - **title** (object) - The title of the block.
    - **raw** (string) - The raw title of the block.
  - **content** (object) - The content of the block.
    - **raw** (string) - The raw HTML content of the block.

### Response Example
{
  "data": [
    {
      "id": 300,
      "title": {"raw": "CTA Button"},
      "content": {"raw": "<!-- wp:buttons -->\n<div class=\"wp-block-buttons\"><!-- wp:button -->\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link\">Get Started</a></div>\n<!-- /wp:button --></div>\n<!-- /wp:buttons -->"}
    },
    {
      "id": 301,
      "title": {"raw": "Newsletter Signup"},
      "content": {"raw": "<!-- wp:group -->\n<div class=\"wp-block-group\">...</div>\n<!-- /wp:group -->"}
    }
  ]
}
```

--------------------------------

### GET /wp/v2/pages

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieve WordPress pages with optional filters for hierarchy, status, and ordering.

```APIDOC
## GET /wp/v2/pages

### Description
Retrieve WordPress pages with optional filters for hierarchy, status, and ordering.

### Method
GET

### Endpoint
/wp/v2/pages

### Parameters
#### Query Parameters
- **site** (string) - Required - The WordPress site to interact with.
- **filters** (object) - Optional - Filtering options.
  - **per_page** (integer) - Optional - Number of pages to return per request. Defaults to 10.
  - **orderby** (string) - Optional - Field to order pages by (e.g., 'menu_order', 'date'). Defaults to 'date'.
  - **order** (string) - Optional - Order direction ('asc' or 'desc'). Defaults to 'desc'.
  - **parent** (integer) - Optional - ID of the parent page to retrieve child pages. Use 0 for top-level pages.

### Request Example
```json
{
  "tool": "claudeus_wp_content__get_pages",
  "arguments": {
    "site": "production",
    "filters": {
      "per_page": 50,
      "orderby": "menu_order",
      "order": "asc",
      "parent": 0
    }
  }
}
```

### Response
#### Success Response (200 OK)
- **data** (array) - An array of page objects.
  - **id** (integer) - The ID of the page.
  - **title** (object) - The title of the page.
    - **rendered** (string) - The rendered title.
  - **parent** (integer) - The ID of the parent page.
  - **menu_order** (integer) - The order of the page in the menu.

#### Response Example
```json
{
  "data": [
    {
      "id": 10,
      "title": {"rendered": "Home"},
      "parent": 0,
      "menu_order": 1
    },
    {
      "id": 15,
      "title": {"rendered": "About Us"},
      "parent": 0,
      "menu_order": 2
    },
    {
      "id": 20,
      "title": {"rendered": "Services"},
      "parent": 0,
      "menu_order": 3
    }
  ]
}
```
```

--------------------------------

### Run Test Suite with Coverage

Source: https://github.com/deus-h/claudeus-wp-mcp/blob/master/readme.md

Execute the test suite and generate a code coverage report using pnpm. This helps in assessing test completeness.

```bash
pnpm test:coverage
```

--------------------------------

### GET /claudeus_wp_templates__get_templates

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Retrieve all block templates available in the active theme (Full Site Editing).

```APIDOC
## GET /claudeus_wp_templates__get_templates

### Description
Retrieve all block templates available in the active theme (Full Site Editing).

### Method
GET

### Endpoint
/claudeus_wp_templates__get_templates

### Parameters
#### Query Parameters
- **site** (string) - Required - The site to retrieve templates from.
- **filters** (object) - Optional - Filters to apply to the template retrieval.
  - **post_type** (string) - Optional - Filter templates by post type.

### Response
#### Success Response (200)
- **data** (array) - An array of template objects.
  - **id** (string) - The unique identifier for the template.
  - **slug** (string) - The slug for the template.
  - **theme** (string) - The theme the template belongs to.
  - **title** (object) - The title of the template.
    - **rendered** (string) - The rendered title.
  - **description** (string) - A description of the template.
  - **status** (string) - The status of the template (e.g., 'publish').

### Response Example
```json
{
  "data": [
    {
      "id": "twentytwentyfour//home",
      "slug": "home",
      "theme": "twentytwentyfour",
      "title": {"rendered": "Home"},
      "description": "Homepage template",
      "status": "publish"
    },
    {
      "id": "twentytwentyfour//page",
      "slug": "page",
      "theme": "twentytwentyfour",
      "title": {"rendered": "Single Pages"},
      "description": "Default template for pages"
    }
  ]
}
```
```

--------------------------------

### Create Blog Post with AI

Source: https://context7.com/deus-h/claudeus-wp-mcp/llms.txt

Generate an SEO-optimized blog post using the 'create-blog-post' prompt. Specify the topic, keywords, and desired tone.

```json
{
  "prompt": "create-blog-post",
  "arguments": {
    "topic": "Best practices for WordPress security in 2024",
    "keywords": "WordPress security, secure WordPress, WordPress hardening, WordPress protection",
    "tone": "professional"
  }
}
```