Skip to main content
Glama

HelpCenter.io for agents

Delete a Script

helpcenter_remove_template_script
DestructiveIdempotent

Delete one script or snippet from the draft. To stop it running but keep it, switch it off with helpcenter_update_template_script (enabled:false) 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 remove_script operation.

Args:

  • id (string): the script.

  • 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
idYesId of a script, as the draft reports it.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior3/5

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

Annotations already flag destructiveHint=true, idempotentHint=true and openWorldHint=true, and the description adds real context beyond them: edits hit the draft only, nothing reaches visitors until helpcenter_publish_template, and a stale etag is refused with stale_draft. It does not, however, say whether the delete is reversible (no undo path, unlike restore_template_version for templates) or whether removal affects references elsewhere in the template.

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 action and the alternative, then scope, prerequisites and return shape — a sensible order. The Args block largely duplicates the schema and could be trimmed, but it is not padded or rambling.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 steps in with a Returns line covering new ids, warnings and the new draft etag, plus the advisory to hand the customer the Template Editor link. Missing only the rollback story for an explicitly destructive operation, which is the one thing an agent might still need to ask about.

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 parameters are already documented; the description adds provenance for `id` (comes from helpcenter_get_template) and restates the stale_draft refusal for `etag`. The agent_key credential handling lives in the schema, so the description correctly does not repeat its warnings.

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 concrete verb and resource ("Delete one script or snippet from the draft") and immediately scopes it to the draft rather than the live site. It names the near-sibling helpcenter_update_template_script with (enabled:false) as the non-destructive alternative, so an agent can separate delete from disable 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?

Explicit when-to-use vs when-not: disable instead of deleting if the script should stay but not run, and publish only when the customer asks. It also names the prerequisite read path ("Ids come from helpcenter_get_template") and the v2-only restriction with the exact error a classic help center returns.

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