HelpCenter.io

Delete HelpCenter Change Set

helpcenter_delete_change_set

DestructiveIdempotent

Delete a change set. Its staged edits, drafts and categories are NOT touched — they stay exactly as they are, unreleased — but the release itself is gone: its grouping, its release note, and any schedule, which is cancelled.

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.

DESTRUCTIVE to the release, and there is no undo through the API. Somebody may have spent time assembling it; do not delete a set you did not create without asking the user. To stop a scheduled release but keep it, use helpcenter_unschedule_change_set instead.

Requires a write-scoped API key.

Args:

change_set_id (number, required).

Returns: { status: "success" }.

Errors: 403 if the key is read-scoped; 404 if the change set is not in this help center; 409 CHANGE_SET_NOT_OPEN while it is publishing.

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_delete_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.

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 4, 2026

TDQS

A4.6/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already flag destructiveHint=true and idempotentHint=true, but the description adds material context beyond them: exactly what survives the delete, that there is no undo through the API, the 403/404/409 error conditions including CHANGE_SET_NOT_OPEN during publish, the write-scoped key requirement, and a caution against deleting sets assembled by others. Nothing here contradicts the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the consequence-bearing sentence (what is and is not destroyed) before the tutorial material, which is the right ordering. It is longer than strictly necessary — the multi-sentence definition of a change set and the full flow chain overlap with what helpcenter_create_change_set likely documents — but each paragraph carries real decision value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, gated mutation with no output schema, the description covers consequences, reversibility, plan gating, auth scope, return value, and every documented error. An agent has everything needed to decide whether to call it and to interpret a failure.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so both change_set_id and site_id are already documented in the schema, including the multi-site guidance. The description's "Args" line merely restates change_set_id's type and requiredness. Per the baseline rule, a 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Delete a change set") and immediately delimits scope: staged edits, drafts and categories are NOT touched, only the release grouping/note/schedule is removed. The follow-up paragraph defines what a change set is, so an agent can distinguish this from helpcenter_delete_article or helpcenter_discard_staged_changes without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use (coordinated multi-article launches), when a simpler alternative suffices (helpcenter_publish_staged_changes or helpcenter_update_article for a single article), a full lifecycle chain of sibling calls, and a named substitute for the adjacent intent (helpcenter_unschedule_change_set to stop a scheduled release without deleting it). It also states a prerequisite gate (Catalyst plan, 402 otherwise).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All HelpCenter.io tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?