Skip to main content
Glama

Move or Reorder Components

helpcenter_move_template_components
DestructiveIdempotent

Reorder or move components within their page: to another position among their siblings, to another region, into a Hero or Container, or out to the region's top level.

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.

An omitted region or parent_id keeps the component where it is, so {id, index} alone reorders it among its siblings (inside a container too), and parent_id null lifts it out of its container. index counts positions after the component is lifted out. Moved into a synced region, a component reaches every page, so the move is refused while another page still holds its own copy; the error says how to proceed. To put a component on another page, add it there with helpcenter_add_template_components. This is the guide's move_component operation.

Args:

  • components (array, 1-50): {id, region?, parent_id?, index?, 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.

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": {
      "components": "<components>"
    },
    "name": "helpcenter_move_template_components"
  }
}

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.
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.
componentsYesThe components to move, each with where it goes. 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
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, and the description adds real context beyond them: draft-only mutation with a live preview, publish gating, the stale-region refusal when another page holds its own copy, and what the return contains (new ids, warnings, new etag). It does not spell out permission/authorization requirements, which is the main remaining gap.

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 the draft-only warning, then the argument mechanics in a distinct paragraph, so it scans well. It is slightly long and repeats the parent_id/omitted-field rule that the schema already states, which is the only waste.

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, batch, all-or-nothing template mutation with no output schema, the description covers the mutation model, the publishing gate, the v2 constraint, the etag lock, failure modes, and what the return contains. An agent has everything needed to call it safely and correctly.

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, and the description goes beyond it with one genuinely new rule: index counts positions after the component is lifted out of its container. Much of the rest (omitted region/parent_id keeps position, {id, index} reorders, parent_id null lifts to top level) largely restates the schema text, capping it below 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?

States a specific verb and resource with scope: reorder or move components within their page, into a Hero/Container, or out to the region's top level. It also names the sibling that does the different job (helpcenter_add_template_components for putting a component on another page), so an agent can distinguish it from add/update/remove without opening schemas.

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 when/when-not guidance: it edits the design draft, nothing reaches visitors until helpcenter_publish_template, publish only when the customer asks, and v2-only with the classic-center error template_migration_required. It also routes the other-page case to helpcenter_add_template_components and points to helpcenter_get_template for ids.

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