Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

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.

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": {
      "region": "<region>",
      "enabled": "<enabled>"
    },
    "name": "helpcenter_sync_template_region"
  }
}

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.
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.
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.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, and the description justifies that destructiveness concretely: enabled:true 'replac[es] the other pages' copies wherever they differ', and enabled:false makes later edits page-specific. It also adds non-annotation context — draft-only editing, nothing visible until publish, stale_draft on etag mismatch. Gaps are minor: it does not say whether replaced page copies are recoverable or how warnings are surfaced.

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 purpose and the draft/publish safety chain are front-loaded in the first two paragraphs, which is the right ordering. The trailing 'Args' block largely restates enums and defaults already present in a 100%-covered schema, so a chunk of the text does not earn its place, and site_id is absent from that list, making it uneven.

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 destructive draft mutation with no output schema, the description supplies what the schema and annotations cannot: draft-vs-live semantics, the publish hand-off, the error token for classic help centers, the ids source (helpcenter_get_template), and a prose summary of the return value (per-entry new ids, warnings, draft status with new etag).

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?

With schema coverage at 100% the baseline is 3, but the description adds real semantics beyond the schema: 'translations included' when enabling, the default of home for source_page, that region excludes main, and that unsynced pages keep the same component ids so later edits must name the page. It omits site_id entirely, relying wholly on the schema for that parameter.

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 concrete, paired verb+resource statement: 'Make a region one shared copy on every page, or let each page keep its own.' That framing immediately separates it from sibling mutations like helpcenter_copy_template_region ('copy') and helpcenter_update_template_region ('edit one page's region'), and it scopes the resource to a single named region of the v2 template.

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?

Explicitly tells the agent when to invoke it as a precondition ('An edit to a synced region whose pages differ is refused until you run this, either way'), names the downstream step and its gate ('publish only when they ask', via helpcenter_publish_template), and states exclusions: v2-only (classic returns template_migration_required) and main cannot be synced. Alternatives and prerequisites are both covered.

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