30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

Get Sitemap Settings

seo/get-sitemap-settings returns the settings that shape the XML sitemap: whether it is enabled, and which content types and taxonomies are indexed and therefore included.

The “therefore” is the important word.

At a glance

Abilityseo/get-sitemap-settings
ToolsetYoast SEO — toolset/yoast-seo
GroupYoast SEO › XML Sitemaps
RequiresYoast SEO, active on the site
Capabilitymanage_options
SafetyRead-only — changes nothing
RepeatableIdempotent — running it twice leaves the same result
Ships inAcrossAI Abilities Manager 0.0.34 and later

How it works

Yoast has no sitemap exclusion list. What appears in the sitemap is derived from what is indexed: a content type that is noindexed is absent from the sitemap, and one that is indexed is present.

That is a clean design and it confuses people constantly, because the obvious place to look for “why is this type not in the sitemap” is a sitemap setting that does not exist.

It also means you cannot have a type that is indexed but excluded from the sitemap, or noindexed but included. Those combinations are not expressible, and on reflection neither is coherent — a sitemap is a list of pages you want indexed.

So this read reports the indexing settings from the sitemap’s point of view, which is the way most people are thinking when they ask.

Changing inclusion means changing indexing, through seo/update-archive-settings.

Input

This ability takes no input.

What comes back

NameTypeWhat it is
enabledbooleanWhether the sitemap is enabled.
includedobjectWhich content types and taxonomies are indexed, and therefore in the sitemap.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

What is in our XML sitemap?

It resolves to one call:

{
  "ability": "seo/get-sitemap-settings",
  "parameters": {}
}

Worth knowing

  • There is no sitemap exclusion list. Inclusion follows indexing.
  • Indexed-but-excluded and noindexed-but-included are not expressible.
  • Change inclusion by changing indexing.
  • Read-only.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading