HelpCenter.io

Create HelpCenter Change Set

helpcenter_create_change_set

Start a new, empty change set — a release to gather work into.

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. NOT idempotent: calling it twice makes two sets with the same name. List the open sets first (helpcenter_list_change_sets) — the release may already exist.

Args:

name (string, required): up to 120 characters, e.g. 'October billing launch'.
description (string, optional): up to 2000 characters, for the team.

Returns: { status: "success", change_set: {...} } with the new id, HTTP 201.

Errors: 402 if the plan does not include change sets; 403 if the key is read-scoped; 409 TOO_MANY_OPEN_CHANGE_SETS when the help center already has 25 open.

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": {
      "name": "<name>"
    },
    "name": "helpcenter_create_change_set"
  }
}

Input Schema

Name	Required	Description
`name`	Yes	What the release is, e.g. 'October billing launch'. Up to 120 characters.
`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.
`description`	No	Longer notes for the team, up to 2000 characters. Never shown to readers.

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 declare the mutation and non-idempotency profile, but the description adds substantial context beyond them: the set owns no content so removal/deletion never destroys work, plan gating returns 402, write-scoped key yields 403, a 25-open-set cap yields 409, and success returns HTTP 201. The non-idempotency warning is reinforced with a concrete consequence ('calling it twice makes two sets with the same name').

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 definition, then usage, workflow, gating, then Args/Returns/Errors — a clean and scannable shape. The Args block duplicates an already 100%-covered schema, which is the only appreciable waste in an otherwise dense definition.

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?

With no output schema, the description supplies the return shape and status code, and enumerates the failure modes (402, 403, 409) an agent must handle. For a 3-parameter creation tool in a multi-step publishing workflow, nothing essential 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 coverage is 100%, so both name and description are already documented in the schema, and the Args block largely restates them (120-char name, 2000-char description, 'October billing launch' example). The description adds no meaning for the third parameter, site_id, which only the schema explains. Baseline 3 is appropriate when the schema does the work.

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 ('Start a new, empty change set') and immediately defines what a change set is — a named release grouping staged edits, drafts, and category visibility changes. It distinguishes itself from the closest alternatives (helpcenter_publish_staged_changes, helpcenter_update_article) by name.

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?

Explicit when-to-use ('several articles have to go live at the same moment — a feature launch, a restructure, a coordinated translation') and when-not ('for one article ... is simpler'), plus a full ordered workflow through sibling tools from staging to polling publish status. It also gives a pre-call check (list open sets first) because the release may already exist.

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?