Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

Update HelpCenter Change Set

helpcenter_update_change_set
DestructiveIdempotent

Rename a change set or change its description. Works on a published set too — the name is how a release is found in history later.

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.

Requires a write-scoped API key. This changes only the name and description; the contents are changed with helpcenter_add_change_set_items and helpcenter_remove_change_set_item.

Args:

  • change_set_id (number, required).

  • name (string, optional): up to 120 characters.

  • description (string | null, optional): up to 2000 characters; null clears it.

Returns: { status: "success", change_set: {...} }.

Errors: 403 if the key is read-scoped; 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_update_change_set"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name, up to 120 characters.
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.
descriptionNoNew description, up to 2000 characters, or null to clear it.
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?

Annotations declare non-read-only, idempotent, open-world and destructive; the description goes far beyond them by stating the rename is safe on published sets, that the set owns no content and deleting/removing never destroys work, that a write-scoped key is required, the 403/404 failure modes, and the response shape. The one tension is that it says only name/description change while destructiveHint=true, but that is conservative annotation rather than a genuine contradiction.

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-loads the action in the first sentence, then moves to context, alternatives, flow, gate, auth and returns in a clean progression. Some material (change sets own no content, full publish pipeline) is broader than a rename operation and could be trimmed, but it earns its place as routing context.

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 4-parameter mutation with no output schema, the description supplies the return shape, the error codes, the plan gate, the auth scope, and where the tool sits relative to siblings. Nothing needed to invoke it correctly is missing.

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 description coverage is 100%, so name, description (null clears), change_set_id and the site_id routing rule are already documented in the schema. The description repeats the 120/2000 character limits and null-clears behavior but adds no new parameter meaning, so the baseline 3 applies.

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?

Opens with a specific verb+resource: "Rename a change set or change its description." It further scopes the tool by stating it works on published sets too, and explicitly contrasts its effect with helpcenter_add_change_set_items / helpcenter_remove_change_set_item, which handle contents.

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?

Names alternatives and the conditions that select them: use helpcenter_publish_staged_changes or helpcenter_update_article for a single article. It lays out the full ordering flow (stage -> create_change_set -> add items -> get -> publish -> poll status) and adds a plan-gate (402) and write-scope-key precondition, which is exactly the when-to-use context an agent needs.

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

All HelpCenter.io toolsInspect
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