MODX MCP

Overview Schema Source Related Servers Discussions Admin

modx_virtualpage_list_routes

Retrieve VirtualPage routes with their event and handler names to inspect routing configuration and troubleshoot event-handler mappings.

Instructions

List VirtualPage routes with their event and handler names.

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_list_routes"
  }
}

Input Schema

Name	Required	Description	Default
`id`	No
`event`	No
`limit`	No
`route`	No
`start`	No
`active`	No
`method`	No
`handler`	No
`event_name`	No
`handler_name`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.2.4Nov 9, 2026

TDQS

C2.4/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 behavioral burden. "List" implies a read operation, but the description does not state pagination behavior, filtering semantics, return shape, or whether any parameters are required.

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?

The description is a single front-loaded sentence with no wasted wording. It is concise, though its brevity contributes to the missing usage and parameter detail.

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

Completeness1/5

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

For a tool with 10 parameters, no annotations, no output schema, and no parameter descriptions, one sentence is not enough to support correct invocation. The definition omits filtering, pagination, and return-value context that an agent would need.

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

Parameters1/5

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

The schema has 10 parameters with 0% description coverage, and the description does not explain any of them. Parameters such as id, event, limit, start, active, method, handler, event_name, and handler_name remain undocumented in both the schema and the description.

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 uses a specific verb and resource: "List VirtualPage routes," and adds that results include event and handler names. It distinguishes listing from sibling get/create/update route tools, though it does not explicitly contrast with modx_virtualpage_get_route or modx_virtualpage_resolve_route.

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

Usage Guidelines2/5

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

It gives no guidance on when to use this tool versus alternatives such as modx_virtualpage_get_route, modx_virtualpage_resolve_route, or modx_virtualpage_list_events. The listing intent is implied, but no exclusions or selection criteria are provided.

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

Deploy Server