Documentation
Getting Started
- Install the plugin. For the current beta, install from the distributed package in your WordPress admin plugin upload screen. After WordPress.org approval, you will also be able to install directly from the repository.
- Enable Standard Tools. Turn on the built-in, deterministic, read-only baseline. This immediately adds
get_site_info,list_post_types,get_navigation,list_posts,search_posts,get_post, andget_terms. On WooCommerce sites it also addswoo_search_products,woo_get_product, andwoo_get_product_categories. - Review the baseline catalog. Standard Tools appears in the same effective catalog that will later hold any discovered capabilities. Confirm the built-in read-only tools you want available before you scan anything.
- Validate before publishing. Review each capability for type, risk, confidence, and auth requirements. You can validate Standard Tools without running a scan. Use the Action Types Reference to interpret labels and flags.
- Choose a publication tier and publish. Select
public_minimal,public_standard, orprivate_fullbased on your exposure policy, then enable publishing and run diagnostics. Until publishing is enabled, public endpoints return 404 by design. See Publication Tiers for tier-by-tier guidance. - Run an optional discovery scan later. Use Quick Scan or Full Scan when you want forms, AJAX routes, plugin-specific flows, selectors, and richer browser runtime bindings that are unique to your site.
First Publish Runbook
- From Setup, enable Standard Tools and confirm the baseline capabilities appear in Review.
- If WooCommerce is active, confirm product search, product lookup, and product category tools were added automatically.
- In Review, confirm the built-in capabilities you want in scope and disable anything you do not plan to publish.
- In settings, choose your tier (usually
public_standardfor practical public utility, orpublic_minimalfor discovery-only exposure). - Open Publish and review Tier Preview counts. Confirm high-risk or auth-required capabilities are not in your chosen public tier.
- Run diagnostics while publishing is still off. Expected behavior: public endpoints return 404 by design.
- Enable publishing and run diagnostics again. Expected behavior: endpoint checks report OK, and your public map is available via the public URL in Publish.
- Run a Quick Scan or Full Scan later when you want deeper site-specific discovery, then validate the newly discovered items before republishing.