Skip to main content
Glama

HelpCenter.io for agents

Share or Unshare a Region Across Pages

helpcenter_sync_template_region
DestructiveIdempotent

Make a region one shared copy on every page, or let each page keep its own.

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.

header and footer are synced by default: one region mirrored to all six pages under the same component ids. enabled:false unsyncs it, and each page keeps its own copy (same ids), so later edits name the page. enabled:true makes every page take source_page's version (default home), translations included, replacing the other pages' copies wherever they differ. An edit to a synced region whose pages differ is refused until you run this, either way. main cannot be synced. This is the guide's sync_region operation.

Args:

  • region: header, hero, sidebar, footer or utility.

  • enabled (boolean): share it (true) or let pages differ (false).

  • source_page (optional): when enabling, the page every page copies. Default home.

  • 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.
regionYesA region that can be shared across pages (every region but main).
enabledYestrue: one region shared by every page. false: let pages differ.
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.
source_pageNoWhen enabling (or re-syncing), the page whose version every page takes. Default home.

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?

Annotations declare destructiveHint=true and idempotentHint=true, and the description earns credit by explaining exactly what the destruction is: enabled:true 'replac[es] the other pages' copies wherever they differ'. It also discloses the draft-only scope ('Nothing reaches visitors until helpcenter_publish_template'), the v2-only constraint with the template_migration_required error, and the stale_draft refusal from etag.

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 the publish-safety constraint are front-loaded, and the Args/Returns blocks make it scannable. The Args block largely repeats enum values and etag wording already present in the schema, which is some avoidable length for a definition this dense.

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?

There is no output schema, so the description carries the return burden and does: 'what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.' Combined with the publish/etag/permission context, an agent has everything needed to call this correctly for a destructive, open-world mutation.

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 baseline is 3, but the description adds meaning the schema does not carry: 'translations included' for enabled:true, the default of home for source_page, and the consequence that after unsyncing 'later edits name the page'. It restates the region enum and etag semantics, which is redundant with the schema, keeping it below a 5.

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?

The opening sentence gives a concrete verb+resource pair with both modes spelled out: 'Make a region one shared copy on every page, or let each page keep its own.' It further disambiguates by naming the underlying operation ('the guide's `sync_region` operation') and by distinguishing the draft-editing tool from `helpcenter_publish_template` and `helpcenter_copy_template_region` in the sibling list.

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?

It states exactly when to run this ('An edit to a synced region whose pages differ is refused until you run this, either way'), when not to (main cannot be synced), which alternative publishes (helpcenter_publish_template), and the workflow constraint 'publish only when they ask'. That is explicit when/when-not/alternatives coverage.

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