rank-math/get-settings reads one Rank Math settings panel: every field with its ID, type, allowed values, bounds, whether it is read-only, and its current value.
Call it before any of the update abilities.
At a glance
| Ability | rank-math/get-settings |
| Toolset | Rank Math — toolset/rank-math |
| Group | Rank Math › Settings |
| Requires | Rank Math SEO, active on the site |
| Capability | manage_options |
| Safety | Read-only — changes nothing |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Abilities Manager 0.0.34 and later |
How it works
Submitting a field that does not belong to the panel rejects the whole write, so rank-math/get-settings comes first: it lists the field IDs the panel accepts, with their types, allowed values and bounds.
That all-or-nothing behaviour is deliberate — a partial write to a settings panel leaves a configuration nobody asked for — but it means guessing a field name costs you the whole call.
Rank Math has several hundred settings across a dozen panels, with IDs that are historically inconsistent. Knowing you want to change the breadcrumb separator does not tell you whether the field is breadcrumbs_separator or something else entirely.
The field specification also carries the allowed values and bounds, which is what lets a caller construct a valid write rather than discovering the constraint by being refused.
Read-only fields are marked. Some Rank Math settings are derived or are controlled elsewhere, and attempting to write one is a refusal.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
panel | string | Yes | Which panel to read, for example general or titles. |
What comes back
| Name | Type | What it is |
|---|---|---|
fields | array | Every field in the panel: ID, type, allowed values, bounds, read-only flag and current value. |
panel | string | The panel read. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present 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 settings are in the Rank Math general panel?
It resolves to one call:
{
"ability": "rank-math/get-settings",
"parameters": {
"panel": "general"
}
}Worth knowing
- A field from the wrong panel rejects the entire write.
- Field IDs are not guessable. Read them here.
- Read-only fields are marked as such.
- Allowed values and bounds come with the specification.
Related abilities
- Update Rank Math General Settings — write the general panel
- Update Rank Math Title & Meta Settings — the template layer
- Update Rank Math Sitemap Settings — the sitemap panel
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category