List a website's pages
list_site_pagesUse when the user wants a whole website (or several of its pages) as code, or asks which pages a site has. Free on every plan (0 credits). Returns every page found (from the sitemap, else the homepage links), split into pages with their own layout (home, pricing, about...) and templates: groups of pages that share one layout (blog post x62, product x24) with example URLs - extracting one example gives that layout. suggested covers every layout once. Show the user the list and ask which pages they want before extracting anything: say how many pages and templates there are and what extract_page costs (creditsPerPage credits per page). Never extract every page of a big site unprompted. Then call extract_page once per chosen page. If the result has premium, the user's plan does not include whole-site extraction: tell them premium.reason and give them premium.upgradeUrl; single sections still work with extract_code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The website, e.g. linear.app | |
| response_format | No | How much to return. 'concise' keeps lists to 10 entries and strings short - right for a summary or a chat answer. 'detailed' returns everything the tool has (same as limit=200 + full_output=true). Omit for the default, which fits a typical chat context. The generated code is never trimmed in any mode. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| pages | No | Pages with their own layout | |
| usage | No | Credit usage for the authed key (spent, remaining, monthly limit). | |
| source | No | sitemap | links - where the page list came from | |
| premium | No | Present when the plan does not include whole-site extraction: reason (relay it) and upgradeUrl | |
| summary | No | The scan in one sentence - a good opening for your reply | |
| suggested | No | Unique pages + one example per template: every layout on the site once | |
| templates | No | Groups of pages sharing one layout, biggest first. A guess from the URLs - check an example before promising the user the layouts are identical | |
| truncated | No | ||
| totalPages | No | ||
| creditsPerPage | No | What extract_page charges per page |