Get HelpCenter Change Set
helpcenter_get_change_setRead one change set: its items, its schedule, and whether it is ready to publish.
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. Call it before publishing. 'readiness' is the API's own check: BLOCKERS stop a publish (the article was deleted; the live article changed after its edits were staged), WARNINGS never do (an English update with no Portuguese counterpart may be deliberate — mention them to the user rather than deciding for them).
Each item is one of: 'staged_version' (one staged language of a published article), 'article_publish' (a draft article the set will publish), 'category_visibility' (a category's visibility change, payload { from, to }). Item ids are what helpcenter_remove_change_set_item takes.
Args:
change_set_id (number, required).
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { status: "success", change_set: { id, name, description, status, is_scheduled, scheduled_for, published_at, release_note, items_count, readiness: { counts, locales, articles, blockers, warnings, publishable }, items: [{ id, type, article_id, category_id, locale, variant, payload, applied, error }] } }.
Errors: 404 if the change set is not in this help center.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"change_set_id": "<change_set_id>"
},
"name": "helpcenter_get_change_set"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| change_set_id | Yes | Id of the change set. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |