Skip to main content
Glama

Remove Item From HelpCenter Change Set

helpcenter_remove_change_set_item
DestructiveIdempotent

Take one item out of a change set. The work it pointed at — the staged edit, the draft, the category — is untouched and simply stops being part of this release.

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.

This is how to ship a release without one of its parts: a blocked item, a language that is not ready, a draft that should wait.

Requires a write-scoped API key. The set must be open.

Args:

  • change_set_id (number, required).

  • item_id (number, required): the ITEM id from helpcenter_get_change_set — not the article or category id.

Returns: { status: "success", change_set: {...} } with the remaining items.

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

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>",
      "item_id": "<item_id>"
    },
    "name": "helpcenter_remove_change_set_item"
  }
}

Input Schema

NameRequiredDescriptionDefault
item_idYesId of the ITEM (from helpcenter_get_change_set's items), not the article or category id.
site_idNoWhich 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_idYesId of the change set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations, it discloses preconditions (write-scoped key, set must be open), plan gating with a 402 response, and specific failure codes (403 read-scoped key, 404 item not in this set, 409 CHANGE_SET_NOT_OPEN). It also resolves the tension in destructiveHint=true by explaining that the staged edit, draft, or category itself survives. This is genuinely more than the annotations convey.

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?

The core action and its non-destructive consequence are front-loaded, followed by usage guidance, preconditions, and errors in a logical order. The middle paragraphs on what a change set is and how it is used are somewhat long for a removal tool, but they carry routing value rather than pure repetition.

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?

Even though there is no output schema, the description states the return shape ({ status: "success", change_set: {...} } with the remaining items) and enumerates the error cases. Combined with the precondition and permission statements, an agent has everything needed to invoke this correctly.

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 required parameters and the site_id selector are already documented in the schema. The description's note about item_id being the ITEM id rather than an article or category id adds emphasis (and reinforces the 404 semantics), but it restates the schema. site_id is not mentioned in the description at all. Baseline 3 applies 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?

"Take one item out of a change set" is a precise verb+resource statement, and the following paragraph clarifies that removal affects only the release membership, not the underlying work. This separates it cleanly from the add/delete siblings such as helpcenter_add_change_set_items and helpcenter_delete_change_set.

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?

Explicitly says when change sets are warranted (coordinated launches), when they are not (a single article should use helpcenter_publish_staged_changes or helpcenter_update_article), and gives a concrete reason to remove an item: shipping a release without a blocked or unready part. The end-to-end flow with sibling tool names is spelled out.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources