Skip to main content
Glama

Restore a Design Version

helpcenter_restore_template_version
DestructiveIdempotent

Load an earlier published design into the DRAFT, replacing the draft's current content — to undo a change, or bring back a previous look. It does NOT go live until you publish it (unlike the Template Editor's one-click revert), so the customer can review it first.

Unpublished draft edits are replaced.

Args:

  • version_id (number): from helpcenter_list_template_versions.

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

Returns: the draft status. Errors: 404 version_not_found.

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": {
      "version_id": "<version_id>"
    },
    "name": "helpcenter_restore_template_version"
  }
}

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.
version_idYesId of the published version to load into the draft, from helpcenter_list_template_versions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations by spelling out exactly what is destroyed ("Unpublished draft edits are replaced"), that the change is staged rather than live until published, and what comes back on failure (404 version_not_found) and on success (draft status). The destructiveHint=true annotation is confirmed and made concrete rather than merely restated.

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 action and the draft-vs-live distinction in two tight sentences, then uses a compact Args/Returns/Errors block. The args section largely duplicates schema text that is already at 100% coverage, which is minor waste but not enough to hurt readability.

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 usefully supplies the return value (draft status) and a named error case, and it discloses the destructive draft-overwrite clearly. The only omission is any mention of multi-site scoping (site_id), which the schema covers thoroughly, so an agent can still call it correctly.

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 description coverage is 100%, so version_id, etag, and site_id are already fully documented, including the stale_draft refusal semantics. The description restates version_id's source (helpcenter_list_template_versions) and summarizes etag as "refuse if the draft changed since you read it," which is a useful gloss but adds no information the schema does not already carry.

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 (load an earlier published design) plus the exact target state (into the DRAFT, replacing the draft's current content), and gives the two motivating scenarios (undo a change, bring back a previous look). This is clearly separable from siblings like helpcenter_publish_template and helpcenter_restore_article_version without opening any schema.

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 clear when-to-use triggers (undoing a change, restoring a prior look) and explicitly contrasts the behavior with the Template Editor's one-click revert, noting the change stays in draft for customer review until published. It stops short of naming helpcenter_publish_template as the required follow-up call, so the agent must infer the next step.

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