Skip to main content
Glama

HelpCenter.io for agents

Restore Article Version

helpcenter_restore_article_version
DestructiveIdempotent

Roll a live article back to a previously published version.

Takes a version id from helpcenter_list_article_versions. The restore is itself archived, so it can be rolled forward again — this is reversible, but it DOES change what readers see immediately.

Args:

  • article_id (number, required).

  • version_id (number, required): from helpcenter_list_article_versions.

Returns: { status: "success", article: {...} } with the restored live article.

Errors: 403 if the key is read-scoped; 404 if the article or version is unknown or belongs to another help center.

Input Schema

NameRequiredDescriptionDefault
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.
article_idYesId of the article to roll back.
version_idYesId of the archived version to restore, from helpcenter_list_article_versions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial context beyond the destructive/idempotent annotations: the restore is itself archived so it can be rolled forward again, the change is immediately visible to readers, and it documents the 403 read-scoped-key and 404 unknown/foreign-resource errors. That is exactly the operational detail an agent cannot get from the structured fields.

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 its safety profile, then structured Args/Returns/Errors sections. The Args list is somewhat redundant with a 100%-covered schema, but the Returns and Errors lines earn their space.

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, credential-bearing mutation with no output schema, the description covers effect, reversibility, return shape, and failure modes. Nothing an agent needs in order to call it safely is missing.

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 schema already documents article_id, version_id, and the credential parameter in detail. The description's Args section largely restates the schema and omits agent_key entirely, so it adds little meaning beyond provenance of version_id.

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 ("Roll a live article back to a previously published version") and distinguishes it from siblings like helpcenter_restore_template_version and helpcenter_update_article by naming the article as the target and version history as the source.

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?

Explicitly says the version id comes from helpcenter_list_article_versions, which routes the agent to the prerequisite tool, and the reader-facing effect clarifies the context of use. It stops short of naming when to use helpcenter_update_article instead of a rollback.

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