Skip to main content
Glama

HelpCenter.io for agents

Remove Components

helpcenter_remove_template_components
DestructiveIdempotent

Remove components from the draft, with everything nested inside them.

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.

In a synced region the component goes from every page. Visitors keep seeing it until the draft is published; undoing it means adding it again (helpcenter_add_template_components) or discarding every unpublished change (helpcenter_discard_template_changes). This is the guide's remove_component operation.

Args:

  • components (array, 1-50): {id, page?}; page when an unsynced region holds the id on several pages.

  • 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 remove. 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.8/5.0
Behavior5/5

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

Goes well beyond the annotations: draft-vs-live semantics, the synced-region effect (removal applies to every page), visitor impact until publish, the v2-only restriction with the template_migration_required response, and the stale_draft refusal when the etag is out of date. It also flags all-or-nothing application, which annotations alone (destructiveHint/idempotentHint) would not convey.

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-loads the operation and the draft/publish constraint, then separates arguments and returns into scannable blocks. A few sentences (e.g. the etag note) duplicate schema text and could be trimmed without losing meaning.

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 mutation with no output schema, the description covers lifecycle (draft vs published), side effects, failure modes, recovery options, and even summarizes the return payload. An agent has everything needed to call it safely and to instruct the customer afterwards.

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 adds the provenance of ids (from helpcenter_get_template) and explains why `page` exists (an unsynced region holding the id on multiple pages). It largely restates the etag and array semantics already documented in the schema, keeping it short of a 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 ("Remove components from the draft") plus the key scope detail that nested children go too. It is clearly distinguishable from helpcenter_add_template_components, helpcenter_move_template_components, helpcenter_update_template_components and helpcenter_remove_template_css/script.

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/when-not guidance: edits only the draft, nothing reaches visitors until helpcenter_publish_template, and publish only when the customer asks. It also names the alternatives for reversing the action (helpcenter_add_template_components or helpcenter_discard_template_changes) and the prerequisite source of ids (helpcenter_get_template).

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