Skip to main content
Glama

modx_versionx_get_version

Retrieve one VersionX version payload for a resource, chunk, snippet, template, plugin, or TV to inspect it before deciding whether to revert.

Instructions

Read one VersionX version payload before deciding whether to revert to it.

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>"
    },
    "name": "modx_versionx_get_version"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYes
content_idYes
version_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden. It conveys read-only inspection implicitly through 'Read', but says nothing about what the payload contains (raw content vs. diff), whether permissions or a VersionX-enabled element type are required, or how the result differs per type.

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?

A single front-loaded sentence with no redundant wording — the purpose and the motivating decision both land in eleven words. Its terseness is efficient rather than padded, though it leans toward under-specification given the parameter surface.

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

Completeness2/5

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

For a three-required-parameter lookup with an enum, no annotations, no output schema, and several hundred sibling tools, one sentence is not enough. An agent cannot tell what the returned payload looks like or how to interpret 'type' versus 'content_id' before committing to the call.

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 description coverage is 0% across three required parameters. The description says 'version payload' which loosely gestures at version_id, but it adds no meaning for content_id, for the six-value 'type' enum (resource/chunk/snippet/template/plugin/tv), or for how type and content_id combine to locate the record.

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?

The description names a specific verb ('Read') and resource ('one VersionX version payload'), which clearly separates it from the sibling modx_versionx_list_versions (many) and modx_versionx_revert_version (write). It stops short of naming those siblings explicitly, which keeps it out of 5 territory.

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?

'before deciding whether to revert to it' implies the workflow (inspect prior to modx_versionx_revert_version) but never states it as an instruction or names the revert tool. There is no explicit when-not-to-use guidance, e.g., that listing versions should precede this call to obtain version_id.

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