Skip to main content
Glama
Sign In

HelpCenter.io for agents

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.

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.
agent_keyYesThe api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content.
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.6/5.0
Behavior5/5

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

Annotations only give the generic write/destructive/idempotent/open-world profile; the description adds substantive behavior: edits land in the draft with a live preview and never reach visitors until publish, settings are merged rather than replaced, null resets to default, stale etag causes a stale_draft refusal, and synced-region edits propagate to every page. This is real context beyond what the annotations say.

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 core action, then constraints, then Args and Returns — easy to scan. Slightly over-dense in the middle paragraph and the Args block duplicates schema content, which keeps it from a 5.

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?

No output schema exists, and the description compensates by summarizing the return (per-entry results with new ids, warnings, draft status and new etag). Together with the all-or-nothing note and the sync/etag edge cases, an agent has everything needed to call it 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 description coverage is 100%, so both etag and components are already documented in structured fields, and the description's Args block largely restates them. It adds modest value by naming where ids come from (helpcenter_get_template) and where accepted config values are documented (get_template_guide), so the baseline 3 is appropriate rather than a 2.

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 ("Change the settings of components already in the draft") and immediately enumerates the settings in scope: heading, variant, column count, CustomHtml markup. It is cleanly distinguishable from sibling add/remove/move component tools and from helpcenter_update_template_region or helpcenter_update_template_settings.

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 routing: read the component first with helpcenter_get_template, read accepted values with helpcenter_get_template_guide (topic 'components'), use helpcenter_sync_template_region when a synced region's pages differ, and never publish except on request via helpcenter_publish_template. It also states a when-not condition (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 for agents 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