Builder Toolswordpress_get_page_outline

wordpress_get_page_outline

Lightweight row-level summary of a builder page's structure. Cheaper than extracting the full builder JSON.

wordpress_get_page_outline

Return a row-level outline of a builder page. This is a lighter read than extract_builder_content: instead of the full nested tree, you get one entry per top-level row so you can answer "what is the structure of this page" without walking the whole layout client-side.

Works on every supported builder. Adapters with a dedicated outline implementation (WPBakery and Uncode today) return a richer per-row child-type histogram.

Parameters

3 parameters, none required.

NameTypeRequiredWhat it is
builderstringnoBuilder name. Optional — auto-detected from the active site builder when omitted.
page_idnumbernoPage or post ID
idnumbernoAlias for page_id (every sibling read tool calls it id, so both are accepted).

Example call

No parameter is required, so the smallest valid call is empty:

{
  "name": "wordpress_get_page_outline",
  "arguments": {}
}

Response

One entry per top-level row, each shaped like this:

{
  "success": true,
  "outline": [
    {
      "index": 0,
      "type": "et_pb_section",
      "kind": "section",
      "primary_heading": "Welcome",
      "child_count": 3,
      "child_types": ["et_pb_text", "et_pb_button", "et_pb_image"]
    }
  ]
}

What it changes

Nothing. It only reads, so there is nothing to approve and nothing to undo.

When it fails

The failures seen most often on real sites in the last 30 days, most common first:

  • respira_post_not_found: No post or page has that ID. List the pages or posts and take the ID from the result.
  • rest_no_route: The WordPress site has no such endpoint. Almost always an old plugin version, or a security plugin blocking the REST API. Update Respira for WordPress on the site and try again.
  • respira_invalid_site_token: The site rejected the token. It was revoked, or the site was reconnected since. Reconnect the site from the Respira dashboard.

How long it takes

A typical call takes about 2.7 seconds. 19 in 20 finish within 6.0 seconds. Measured on real sites over the last week, so it includes the site's own hosting.

Availability

Works on any WordPress site, whichever page builder it uses. Available since Respira 1.0.0.

When to use this vs extract_builder_content

  • Use get_page_outline first when you want the shape of a page: how many rows, what each one is, what it contains. It is the cheapest way to orient before an edit.
  • Use wordpress_extract_builder_content when you need the full builder-native JSON to modify and pass back into inject_builder_content.
  • For a targeted search by text or class, use find_element instead.

If extract_builder_content runs into the response-size cap on a large page, the truncation hint points you back here: get the outline first, then extract just the subtree you care about.

Notes

  • Read-only tool - doesn't modify content

Example Prompts

  • "What is the structure of the homepage?"
  • "Give me an outline of page 42 before we edit it"
  • "How many rows does the About page have and what is in each?"
Was this page helpful?