List HelpCenter Change Sets
helpcenter_list_change_setsList the help center's change sets — the releases being prepared, scheduled, and already published — most recently changed first.
A change set is a named release. It groups work that already exists — staged edits on published articles, never-published draft articles, and category visibility changes — and publishes all of it together, now or at a scheduled time. It owns no content: removing an item or deleting the set never deletes the work, which simply stays unreleased.
Use one when several articles have to go live at the same moment — a feature launch, a restructure, a coordinated translation. For one article, helpcenter_publish_staged_changes (or publishing a draft with helpcenter_update_article) is simpler. The flow: stage edits with helpcenter_stage_article_changes, or write drafts with helpcenter_create_article and published: false -> helpcenter_create_change_set -> helpcenter_add_change_set_items -> check readiness with helpcenter_get_change_set -> helpcenter_publish_change_set -> poll helpcenter_get_change_set_status until done.
Change sets are part of the Catalyst plan, behind the same gate as staged changes; on other plans the API answers 402.
Read-only. Check here before creating a set: a help center may have at most 25 open ones, and the release you are about to start may already exist.
Args:
status ('open' | 'publishing' | 'published' | 'partially_published' | 'failed' | 'cancelled', optional).
limit (number, optional): items per page, 1-100 (default 100). page (number, optional): default 1.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { total, count, page, per_page, total_pages, has_more, next, items } where each item is { id, name, description, status, is_scheduled, scheduled_for, published_at, release_note, items_count, processed_items, total_items, created_at, updated_at }.
Paging: every response carries next: { page, limit } — the exact arguments that fetch the first item it did not return — or null when nothing is left. Follow next, with the same filters, instead of computing page + 1 yourself. A response is capped at 25000 characters, in its text and in its structured data alike, and 5.0 MB in all: when a page does not fit, only its first items are returned (truncated: true, count says how many) and next points at the rest, usually with a smaller limit and a later page number. Requesting page + 1 with your original limit would skip them.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "helpcenter_list_change_sets"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (default 1). | |
| limit | No | Maximum items to return per page (1-100, default 100). | |
| status | No | Only sets in this state. 'open' is what can still be edited and published; 'partially_published' and 'failed' can be fixed and published again. | |
| site_id | No | Which help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |