Skip to main content
Glama

HelpCenter.io for agents

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.

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.
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.
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.4/5.0
Behavior3/5

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

The annotations already declare destructiveHint=true, idempotentHint=true and openWorldHint=true, so the risk profile is pre-supplied. The description nonetheless adds real behavioral context beyond them: nothing reaches visitors until publish, edits land in a draft guarded by an etag (stale_draft), all-or-nothing application with per-position error reporting, and refusal when moving into a synced region whose copies conflict. It does not, however, explain why the operation is marked destructive or what exactly a rollback/discard path looks like.

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 capability, then workflow, then failure modes, then args and returns — a sound structure with no filler sentences. It is dense and repeats some schema text (index/parent_id semantics) and the add_template_components routing twice, which keeps it just short of a 5.

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 summarizes the return value (per-entry results with new ids, warnings to relay, draft status and new etag). It covers prerequisites (v2 only, ids from helpcenter_get_template), concurrency (etag), and the publish gate — everything an agent needs before calling a destructive draft 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; the description still earns credit for explaining the omitted-field semantics clearly (omitting region or parent_id keeps placement, so {id, index} alone reorders among siblings, parent_id null lifts to region top level) and that index counts positions after the lift. Much of this is mirrored in the schema's parameter descriptions, so it is additive but not wholly new.

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 (reorder/move) plus resource (template components) and enumerates the destination types: siblings, another region, into a Hero or Container, or out to the region's top level. It also routes the different intent (placing a component on another page) to helpcenter_add_template_components, so it is distinguishable from siblings without opening a 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 when-to-use context (editing the v2 design draft that the Template Editor previews) and when-not (classic help centers return template_migration_required; cross-page placement belongs to add_template_components). It also states the workflow expectation: hand the customer the Template Editor link and publish only when asked.

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