Skip to main content
Glama

HelpCenter.io for agents

Discard Design Changes

helpcenter_discard_template_changes
DestructiveIdempotent

Throw away every unpublished change in the draft and reset it to the live design. The live help center is not affected.

Irreversible for the draft: edits that were never published cannot be recovered — including ones a person made in the Template Editor. Only discard when the customer wants to start over.

Args:

  • etag (string, optional): refuse if the draft changed since you read it.

Returns: the reset draft's status.

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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is known. The description still adds real value by spelling out that the loss is irreversible, that unpublished Template Editor edits are unrecoverable, and that the live help center is unaffected — the last point is a non-obvious scoping guarantee an agent couldn't derive from 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?

The destructive outcome and draft-only scope are front-loaded, followed by irreversibility, a usage gate, and labeled Args/Returns sections. Every sentence earns its place; only the parenthetical about Template Editor edits is slightly padded, so it is efficient without being maximally tight.

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?

No output schema exists, and the description compensates by stating it returns the reset draft's status, alongside the credential requirement being fully handled in the schema. For a two-parameter destructive tool, this covers what an agent needs, with only the sibling distinction left implicit.

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 coverage is 100% and the etag description in the schema is already detailed about stale_draft refusal. The description's 'refuse if the draft changed since you read it' restates the schema's optimistic-lock semantics in condensed form without adding new syntax or edge-case behavior, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and scope: discards every unpublished change in the draft and restores the live design, while leaving the live help center untouched. That scopes it apart from publish/restore tools, but it never explicitly separates it from the close sibling helpcenter_discard_staged_changes, so an agent must infer the draft-template vs staged-content distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear when-to condition: 'Only discard when the customer wants to start over,' which functions as both a trigger and a caution against casual use. It stops short of naming alternatives (e.g., restore_template_version for rolling back a published template), so the guidance is directional rather than complete.

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