Skip to main content
Glama
Sign In
MODX MCP

MODX MCP

by rumata-estor
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Local

modx_virtualpage_get_route

Retrieve a virtual page route by ID, or by route plus an optional HTTP method, to inspect how requests resolve to that page.

Instructions

Read one VirtualPage route by id, or by route plus optional method.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "modx_virtualpage_get_route"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNo
routeNo
methodNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.4

TDQS

A3.5/5.0
Behavior3/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. 'Read' implies a safe, non-mutating operation, but it says nothing about behavior on a missing route (error vs empty), permission requirements, or caching effects of the VirtualPage subsystem.

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 tight sentence with the resource and the lookup alternatives front-loaded and no filler. Minor ambiguity in 'route plus optional method' is the only cost.

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?

For a simple single-record read with no output schema and no annotations, the definition covers the essential selection logic. The unresolved case of an all-optional parameter set (nothing required) is the main gap an agent would want closed.

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 0%, so the description must compensate, and it does partially by framing id vs route-plus-method as alternative lookup paths. It does not state that the two paths are mutually exclusive, what the method defaults to, or what happens when neither is supplied (required count is 0).

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?

Specific verb 'Read' plus resource 'one VirtualPage route' with the two lookup keys stated. It is clearly distinct from modx_virtualpage_list_routes, modx_virtualpage_create_route, modx_virtualpage_update_route and modx_virtualpage_delete_route by name alone, though no sibling is named explicitly.

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?

Usage is implied: fetch a single route when you already have an id or a route/method pair. There is no guidance on when to prefer modx_virtualpage_resolve_route instead, and no stated preconditions such as whether the route must exist.

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