PixelYourSite MCP — Tool Reference
Complete list of tools exposed by the PYS MCP server. Read tools are available on both Free and Pro. Write tools require PixelYourSite Pro and explicit user confirmation before saving. Tools marked with a requirement only respond when that plugin or feature is active.
Read tools
ping
Checks that the MCP server is reachable and responding. Use this to verify a new connection works.
get_usage_guidance
Returns operating instructions for the AI assistant — the equivalent of a system prompt. Called automatically by most clients on first connection.
get_tracking_audit
Runs a full health check across all tracking configuration areas. Returns a status per domain (ok, warning, not_active) and detail only for areas that need attention. Domains: pixels, capi, advanced_matching, content_id, woo_events, edd_events, custom_events, gtm, superpack, catalog_feed_alignment, edd_feed_alignment, woo_reports, edd_reports, mcp_activity.
get_platform_pixels
Returns pixel IDs, CAPI status, Super Pack extra pixels, and Google Ads conversion labels for every active platform.
get_credential_setup_instructions
Returns step-by-step instructions for obtaining a server-side API token for a given platform (Facebook, TikTok, GA4, Pinterest). Includes the direct URL to the token generation page in the platform’s interface.
get_advanced_matching_config
Returns all eight field-name lists (4 DOM, 4 URL parameter), per-platform matching switch states, locked default field names, automatic coverage context, and which dimensions have gaps. Covers Facebook, TikTok, Pinterest, Bing, Google Ads, GA4, GTM.
scan_page_for_form_fields
Fetches up to 3 own-domain URLs and returns form fields found in the static HTML — name, ID, type, and label per field. Used to identify field names for advanced matching. Does not execute JavaScript.
get_woo_events_config
Returns the full WooCommerce event configuration: funnel events, AddToCart trigger options, lifecycle events with thresholds, subscription and POAS settings, content ID per platform, per-platform event toggles, and value settings. Returns { available: false } when WooCommerce is not active.
get_edd_events_config
Returns the full EDD event configuration: funnel events, lifecycle events with thresholds, subscription and license tracking settings, content ID per platform, and per-platform event toggles. Returns { available: false } when EDD is not active.
get_automatic_events_config
Returns the on/off state and thresholds for all automatic events: forms, signups, logins, downloads, comments, AdSense, scroll, time on page, 404, search, internal links, outbound links, phone links, email links, video (YouTube, Vimeo, HTML5), rage clicks, video speed.
get_superpack_config
Returns SuperPack configuration and active status.
get_custom_events
Returns all custom events with ID, title, enabled state, trigger types, and active platforms.
get_custom_event
Returns the full configuration of one custom event by ID: triggers, conditions, fire frequency, and per-platform settings.
get_catalog_feed_alignment
Compares PYS WooCommerce content ID settings against the Product Catalog Feed plugin. Returns match status, feed values, and suggested PYS changes. Returns { available: false } when WooCommerce or the feed plugin is not active.Requires: Product Catalog Feed for WooCommerce 5.9+
get_edd_feed_alignment
Compares PYS EDD content ID settings against the EDD Products Feed Pro plugin. The EDD feed always uses the WordPress post ID — any other setting in PYS will cause a mismatch. Returns { available: false } when EDD or the feed plugin is not active. Requires: EDD Products Feed Pro 2.1+
get_attribution_summary
Returns revenue totals and a ranked breakdown (up to 20 rows) by one attribution dimension for WooCommerce or EDD over a date range. Dimensions: traffic_source, traffic_landing, utm_campaign, utm_source, utm_medium, utm_content, utm_term. Models: first_visit, last_visit. Date ranges: today, last_7_days, last_30_days, last_90_days, this_month, last_month, custom. Requires: Save data to orders enabled, historical sync complete.
get_attribution_drill
Returns products sold, daily revenue, or per-order revenue for one specific dimension value. Takes the exact value string from a get_attribution_summary result. Order breakdown returns order ID and revenue only — no customer details.Requires: Save data to orders enabled, historical sync complete.
Write tools (Pro only)
All write tools use a two-step confirm: call without confirm to get a preview of what will change, then call again with confirm: true to save. Every write requires an mcp_note — a one-sentence description of what is being changed and why.
set_platform_credential
Saves a pixel ID and/or server-side API token for one platform. Supported platforms: facebook, tiktok, google_analytics, google_ads, pinterest, bing, reddit, gtm. Pinterest also requires an Ad Account ID. Tokens are write-only and cannot be read back.
set_advanced_matching_fields
Adds or removes field names from the advanced matching lists (DOM and URL parameter). Append mode (default) adds names without touching existing ones. Remove mode deletes specific names surgically. Also writes per-platform matching on/off switches.
set_woo_event_config
Writes WooCommerce event configuration: funnel event toggles, AddToCart trigger options, lifecycle event toggles and thresholds, subscription and POAS settings, content ID source/prefix/suffix, variable_as_simple, WPML unified ID, content_id_logic (Facebook only), and per-platform event toggles.
set_edd_event_config
Writes EDD event configuration: funnel event toggles, lifecycle event toggles and thresholds, subscription and license tracking toggles, content ID source/prefix/suffix, and per-platform event toggles.
set_automatic_event_config
Writes automatic event on/off states and thresholds (scroll percentage, time on page in seconds, download file extensions).
set_superpack_config
Writes SuperPack configuration.
set_custom_event
Creates a new custom event with triggers, conditions, fire frequency, and per-platform settings. Supported triggers: page_visit, home_page, scroll_pos, post_type, number_page_visit, url_click, css_click, css_mouseover, add_to_cart, purchase, video_view, email_link, copy_element, video_speed, gads_phone_conversion, and form plugin triggers (CF7, WPForms, Ninja Forms, Gravity Forms, Formidable, Fluent Forms, and others).
manage_custom_event
Enables, disables, or deletes an existing custom event by ID.