Skip to main content
Glama

modx_versionx_revert_version

Revert a MODX resource, chunk, snippet, template, plugin, or TV to a specific VersionX version; confirm=true is required because it changes live CMS data.

Instructions

Revert a MODX object to a specific VersionX version. This changes live MODX data and requires confirm=true.

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": {
      "type": "<type>",
      "content_id": "<content_id>",
      "version_id": "<version_id>",
      "confirm": "<confirm>"
    },
    "name": "modx_versionx_revert_version"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYes
confirmYes
content_idYes
version_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the statements that live MODX data changes and confirmation is required provide essential side-effect and safety information. It remains unclear whether the current state is preserved as another version, whether caches are refreshed, and what behavior occurs on failure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences front-load the operation, then disclose the live-data side effect and confirmation gate. There is no filler or repetition.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The core action, mutation warning, and confirmation requirement support basic selection, while the schema enumerates supported object types. However, with no annotations, output schema, or property documentation, ID discovery and the aftermath of a revert remain underdocumented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema property descriptions are absent, and the description explicitly clarifies only confirm by requiring true; "specific VersionX version" gives limited context for version_id. It does not explain how type and content_id jointly identify the target or where content_id and version_id can be obtained.

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?

The description uses a specific verb, "Revert," and identifies both the resource, a MODX object, and the target, a specific VersionX version. This clearly distinguishes it from the read-only VersionX list/get siblings and general element-update tools.

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

Usage Guidelines3/5

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

It implies use when restoring an object to a known earlier version and supplies the invocation prerequisite confirm=true. It does not explain how to discover the required IDs through modx_versionx_list_versions or modx_versionx_get_version, nor provide exclusions or alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools