Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

Change Component Settings

helpcenter_update_template_components
DestructiveIdempotent

Change the settings of components already in the draft: a heading, a variant, a column count, a CustomHtml block's markup.

It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template.

Settings are merged: name only the ones to change, and null resets one to its default. Read the component first (helpcenter_get_template, section 'component' with its id) and the values its type accepts (helpcenter_get_template_guide, topic 'components'). In a synced region (header and footer usually are) the change reaches every page, and one whose pages differ is refused until you choose with helpcenter_sync_template_region. Where an unsynced region holds the same id on several pages, name the page. This is the guide's update_component operation.

Args:

  • components (array, 1-50): {id, config, page?}.

  • etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since.

Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

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

Input Schema

NameRequiredDescriptionDefault
etagNoOptimistic lock: the draft etag from your last read, or the one your last edit returned. When given, the call is refused (stale_draft) if someone changed the draft since — so you never build on a state you have not seen. Omit to apply to the current draft.
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.
componentsYesThe components to change, each with the settings to merge. Applied in order, all-or-nothing: if one is refused, nothing from this call is saved and the error names it by position (operation 0 is the first entry).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Goes well past the annotations by disclosing that edits land only in the design draft and never reach visitors until publish, that settings are merged with null as a reset, that the call is refused with stale_draft when the etag is stale, and that synced regions apply changes to every page while diverging pages are refused. These are exactly the failure modes an agent needs before calling a destructiveHint=true mutation.

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?

Purpose and draft-only constraint are front-loaded, and the dense paragraphs each carry real information. The explicit "Args:" section at the end duplicates what the schema already states, which is the one avoidable repetition in an otherwise tight 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 still closes the loop by stating what returns (per-entry results with new ids, warnings worth relaying, draft status and new etag). Combined with the merge semantics, region behavior and required prior reads, an agent has everything needed to call this correctly on the first attempt.

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

Parameters4/5

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

Schema coverage is 100%, so the schema already defines id, config, page and etag; the description adds provenance rather than syntax — ids come from helpcenter_get_template, accepted config keys come from the guide's 'components' topic, and page is needed only when an unsynced region repeats an id. The trailing Args block largely restates the schema, limiting the added value.

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 and resource: "Change the settings of components already in the draft", and immediately enumerates what a setting can be (heading, variant, column count, CustomHtml markup). It is unambiguously distinct from add_template_components, remove_template_components and move_template_components, which share the same resource but different operations.

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 and sequencing rules: read the component first with helpcenter_get_template, check accepted values with helpcenter_get_template_guide, hand the customer the Template Editor link, and publish only when they ask. It also names concrete alternatives and preconditions (helpcenter_sync_template_region for diverging pages, helpcenter_publish_template for going live) and states an exclusion (v2 only, classic returns template_migration_required).

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