Skip to main content
Glama

HelpCenter.io for agents

Copy a Region to Other Pages

helpcenter_copy_template_region
DestructiveIdempotent

Copy one page's version of an unsynced region onto other pages, once, translations included. Each target page's region is replaced, and the pages stay independent afterwards; to keep them identical, sync the region with helpcenter_sync_template_region instead.

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.

This is the guide's copy_region operation.

Args:

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

  • from_page: the page to copy from.

  • to_pages: the pages that receive the copy.

  • 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).
to_pagesYesPages that receive a copy, replacing what their region holds now.
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.
from_pageYesThe page to copy the region from.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the annotations, it discloses that the edit targets the design DRAFT and nothing reaches visitors until helpcenter_publish_template, that target regions are replaced, and that the pages become independent afterwards. It also explains the stale_draft refusal on etag and where ids come from. The only gap is that the destructiveHint=true annotation is merely echoed rather than expanded (e.g. whether prior region content is recoverable).

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 operation and the sibling contrast, then a behavior paragraph, then args and returns. Structure is clear, but the Args block duplicates the 100%-covered schema, which is some avoidable length.

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 tells the agent what comes back (per-target results with new ids, warnings to relay, draft status and new etag). Combined with the draft/publish workflow and v2-only constraint, an agent has everything needed to call and follow up 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 region enum values, to_pages semantics, and etag locking are already fully documented in the schema. The description's Args block largely restates those definitions and adds only a small hint (ids come from helpcenter_get_template). Baseline 3 is appropriate.

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, resource, and scope: copying one page's unsynced region onto other pages, once, translations included. It explicitly contrasts this with helpcenter_sync_template_region (permanent syncing) so an agent can pick between the two siblings without opening either schema.

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 routing rules: use sync_template_region if the pages should stay identical; publish only when the customer asks; v2 help centers only. It also states the review workflow (hand back the Template Editor link) and the alternative outcome for classic help centers (template_migration_required).

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