Skip to content

README.md

Latest commit

 

History

History
237 lines (195 loc) · 14.5 KB

README.md

File metadata and controls

237 lines (195 loc) · 14.5 KB

WordPress MCP Server - API Documentation

Version Tools Coverage TypeScript License

Overview

The WordPress MCP Server provides 59 tools across 10 categories for comprehensive WordPress management through the Model Context Protocol.

Last Updated: 9.8.2025 Version: 1.2.0 Coverage: 59/59 tools with examples

Quick Start

Basic Usage

# List all posts
wp_list_posts

# Get specific post
wp_get_post --id=123

# Create new post
wp_create_post --title="My Post" --content="Post content"

Multi-Site Usage

# Target specific site
wp_list_posts --site=site1

# Use with different authentication
wp_get_site_settings --site=production

Tool Categories

Category Tools Description
comment 7 comment management tools
cache 4 Performance caching and optimization tools
site 6 Site settings and configuration tools
taxonomy 10 taxonomy management tools
page 6 page management tools
post 6 post management tools
user 6 user management tools
media 5 File upload, management, and media library tools
auth 3 Authentication testing and management tools
performance 6 Performance monitoring and analytics tools

Available Tools

Tool Category Description
wp_approve_comment comment Approves a pending comment.
wp_cache_clear cache Clear cache for a WordPress site.
wp_cache_info cache Get detailed cache configuration and status information.
wp_cache_stats cache Get cache statistics for a WordPress site.
wp_cache_warm cache Pre-warm cache with essential WordPress data.
wp_create_application_password site Creates a new application password for a user.
wp_create_category taxonomy Creates a new category.
wp_create_comment comment Creates a new comment on a post.
wp_create_page page Creates a new page.
wp_create_post post Creates a new WordPress post with comprehensive validation and detailed success feedback including management links.

Usage Examples: • Simple post: wp_create_post --title="My New Post" --content="<p>Hello World!</p>" • Draft post: wp_create_post --title="Draft Post" --status="draft" • Categorized post: wp_create_post --title="Tech News" --categories=[1,5] --tags=[10,20] • Post with featured image: wp_create_post --title="My Post" --content="<p>Content</p>" --featured_media=42 • Remove featured image: wp_create_post --title="My Post" --featured_media=0 • Scheduled post: wp_create_post --title="Future Post" --status="future" --date="2024-12-25T10:00:00" • Complete post: wp_create_post --title="Complete Post" --content="<p>Content</p>" --excerpt="Summary" --status="publish" | | wp_create_tag | taxonomy | Creates a new tag. | | wp_create_user | user | Creates a new user. | | wp_delete_application_password | site | Revokes an existing application password. | | wp_delete_category | taxonomy | Deletes a category. | | wp_delete_comment | comment | Deletes a comment. | | wp_delete_media | media | Deletes a media item. | | wp_delete_page | page | Deletes a page. | | wp_delete_post | post | Deletes a WordPress post with option for permanent deletion or moving to trash. | | wp_delete_tag | taxonomy | Deletes a tag. | | wp_delete_user | user | Deletes a user. | | wp_get_application_passwords | site | Lists application passwords for a specific user. | | wp_get_auth_status | auth | Gets the current authentication status for a configured WordPress site. | | wp_get_category | taxonomy | Retrieves a single category by its ID. | | wp_get_comment | comment | Retrieves a single comment by its ID. | | wp_get_current_user | user | Retrieves the currently authenticated user with comprehensive profile information including roles, capabilities, and account details.

Usage Examples: • Get current user: wp_get_current_user • Check permissions: Use this to verify your current user's capabilities and roles • Account verification: Confirm you're authenticated with the correct account • Profile details: View registration date, email, and user metadata | | wp_get_media | media | Retrieves a single media item by its ID. | | wp_get_page | page | Retrieves a single page by its ID. | | wp_get_page_revisions | page | Retrieves revisions for a specific page. | | wp_get_post | post | Retrieves detailed information about a single post including metadata, content statistics, and management links. | | wp_get_post_revisions | post | Retrieves the revision history for a specific post showing author and modification dates. | | wp_get_site_settings | site | Retrieves the general settings for a WordPress site. | | wp_get_tag | taxonomy | Retrieves a single tag by its ID. | | wp_get_user | user | Retrieves a single user by their ID. | | wp_list_categories | taxonomy | Lists categories from a WordPress site. | | wp_list_comments | comment | Lists comments from a WordPress site, with filters. | | wp_list_media | media | Lists media items from a WordPress site, with filters. | | wp_list_pages | page | Lists pages from a WordPress site, with filters. | | wp_list_posts | post | Lists posts from a WordPress site with comprehensive filtering options. Supports search, status filtering, and category/tag filtering with enhanced metadata display.

Usage Examples: • Basic listing: wp_list_posts • Search posts: wp_list_posts --search="AI trends" • Filter by status: wp_list_posts --status="draft" • Category filtering: wp_list_posts --categories=[1,2,3] • Paginated results: wp_list_posts --per_page=20 --page=2 • Combined filters: wp_list_posts --search="WordPress" --status="publish" --per_page=10 | | wp_list_tags | taxonomy | Lists tags from a WordPress site. | | wp_list_users | user | Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.

Usage Examples: • List all users: wp_list_users • Search users: wp_list_users --search="john" • Filter by role: wp_list_users --roles=["editor","author"] • Find admins: wp_list_users --roles=["administrator"] • Combined search: wp_list_users --search="smith" --roles=["subscriber"] | | wp_performance_alerts | performance | Get performance alerts and anomaly detection results | | wp_performance_benchmark | performance | Compare current performance against industry benchmarks | | wp_performance_export | performance | Export comprehensive performance report | | wp_performance_history | performance | Get historical performance data and trends | | wp_performance_optimize | performance | Get optimization recommendations and insights | | wp_performance_stats | performance | Get real-time performance statistics and metrics | | wp_search_site | site | Performs a site-wide search for content across posts, pages, and media with comprehensive results and metadata.

Usage Examples: • Search everything: wp_search_site --term="WordPress" • Search posts only: wp_search_site --term="tutorial" --type="posts" • Search pages: wp_search_site --term="about" --type="pages" • Search media: wp_search_site --term="logo" --type="media" • Find specific content: wp_search_site --term="contact form" | | wp_spam_comment | comment | Marks a comment as spam. | | wp_switch_auth_method | auth | Switches the authentication method for a site for the current session. | | wp_test_auth | auth | Tests the authentication and connectivity for a configured WordPress site with detailed connection diagnostics.

Usage Examples: • Test connection: wp_test_auth • Multi-site test: wp_test_auth --site="my-site" • Verify setup: Use this after configuring new credentials • Troubleshoot: Run when experiencing connection issues • Health check: Regular verification of WordPress connectivity | | wp_update_category | taxonomy | Updates an existing category. | | wp_update_comment | comment | Updates an existing comment. | | wp_update_media | media | Updates the metadata of an existing media item. | | wp_update_page | page | Updates an existing page. | | wp_update_post | post | Updates an existing WordPress post with validation and detailed confirmation. | | wp_update_site_settings | site | Updates one or more general settings for a WordPress site. | | wp_update_tag | taxonomy | Updates an existing tag. | | wp_update_user | user | Updates an existing user. | | wp_upload_media | media | Uploads a file to the WordPress media library. |

Authentication

All tools support multiple authentication methods:

  • Application Passwords (recommended)
  • JWT Authentication
  • Basic Authentication (development only)
  • API Key Authentication

Error Handling

Standard error response format:

{
  "error": "Error type",
  "message": "Human-readable error message",
  "code": "ERROR_CODE",
  "details": {
    "endpoint": "/wp-json/wp/v2/posts",
    "method": "GET"
  }
}

Configuration

Multi-Site Configuration

{
  "sites": [
    {
      "id": "site1",
      "name": "My WordPress Site",
      "config": {
        "WORDPRESS_SITE_URL": "https://example.com",
        "WORDPRESS_USERNAME": "username",
        "WORDPRESS_APP_PASSWORD": "app_password"
      }
    }
  ]
}

Response Formats

All tools return responses in this format:

{
  "success": true,
  "data": {
    // Tool-specific response data
  },
  "metadata": {
    "timestamp": "2024-01-01T00:00:00.000Z",
    "site": "site1",
    "tool": "wp_list_posts"
  }
}

Performance Monitoring

The server includes comprehensive performance monitoring:

  • Real-time metrics collection
  • Historical performance analysis
  • Industry benchmark comparisons
  • Automated optimization recommendations

See Performance Monitoring Guide for details.

Additional Resources

Support