Skip to main content

Yoast SEO Abilities API

This documentation explains what is the Abilities API and how Yoast SEO integrates with it.

What is the Abilities API?​

Abilities API was introduced in WordPress 6.9, as a new standardized way for plugins to expose what they can do. It allows plugins to do so by providing:

  • A registry where plugins declare their capabilities (also know as abilities) with structured input/output schemas.
  • A central REST discovery endpoint (/wp-json/wp-abilities/v1/abilities) where any client/plugin can list everything that's available.
  • A standardized execution endpoint (/run) to invoke any registered ability.
  • Permission checks baked into every ability, so access control is consistent.

Once an ability is registered, it is discoverable and executable from PHP, JavaScript, and the REST API. That way, AI agents (and other third-party systems) can use that ability for their purproses.

Yoast SEO Abilities API​

The abilities that Yoast SEO is currently registering:

Those abilities can also be discovered at /wp-json/wp-abilities/v1/abilities?category=yoast-seo along with their most relevant information.

Use cases for the Yoast SEO Abilities API​

AI agents​

Assuming that an AI agent is connected to a WordPress-enabled MCP site (details on how one can do that, on this helpful tutorial from the WP Core team ) with Yoast SEO active, it can then discover the above abilities and answer questions like:

  • "Take a look at the latest posts of my website and give me a report of the analysis of their SEO scores. Do you see a clear pattern in the subjects of the best performing ones?"
  • "Do you see the readability of my recent content going upwards or downwards?"
  • "I want to know if I have content on my site that uses non-inclusive language. If there's indeed not inclusive language in my content, do you see a correlation between the subjects covered?"

That way, Yoast SEO exposes the results of its analyses to authenticated AI agents, enabling users to use AI capabilities to easily navigate through useful SEO data of their website and create reports, map out plans and perform SEO-related actions accordingly.

Third-party code​

A more traditional way to consume the Yoast SEO Abilities API, any plugin that is interested in building features on top of Yoast SEO Analyses can now use the new WP REST API endpoints, to reliably get information about a website's recent posts, in a structured way.

Prerequisites​

  • WordPress version should over v6.9.
  • Indexables should be enabled and fully built.