Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

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.

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>",
      "from_page": "<from_page>",
      "to_pages": "<to_pages>"
    },
    "name": "helpcenter_copy_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).
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.
to_pagesYesPages that receive a copy, replacing what their region holds now.
from_pageYesThe page to copy the region from.

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?

Beyond the destructive/idempotent annotations, it discloses that edits land only on the v2 design draft, that nothing reaches visitors until helpcenter_publish_template, that target pages' regions are replaced and pages remain independent afterward, and that a mismatched etag yields stale_draft. This is genuine behavioral context an agent could not infer from the annotations.

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?

Core semantics are front-loaded in the first two sentences, followed by a Returns summary. The Args block duplicates schema text almost verbatim, which is waste, though it is at least ordered after the high-value content rather than before it.

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 covers the draft/publish lifecycle, multiplicity/scope caveats, failure modes, and what the return value contains (new ids, warnings, draft status plus new etag). An agent has everything needed to call it and to relay results safely.

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 the schema already documents every parameter, including the etag optimistic lock and the region/page enums. The Args section largely restates those definitions, adding only the stale_draft refusal behavior, so the description does not meaningfully extend parameter semantics.

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 with scope: 'Copy one page's version of an unsynced region onto other pages, once, translations included.' It also explicitly contrasts itself with helpcenter_sync_template_region, so an agent can separate the one-time copy from the ongoing sync 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 instead to keep pages identical, give the customer the Template Editor link and publish only when they ask, and note v2-only with the classic-site failure mode (template_migration_required). It also names helpcenter_get_template as the source of ids, covering prerequisites and exclusions.

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