Skip to main content
Glama

modx_virtualpage_create_event

Create a VirtualPage event in MODX to trigger custom handling for page-not-found or request events, with optional rank, active status, and description.

Instructions

Create a VirtualPage event, usually OnPageNotFound or OnHandleRequest.

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

Input Schema

NameRequiredDescriptionDefault
nameYes
rankNo
activeNo
descriptionNo

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 provided, so the description carries the full burden for a mutation tool. It does not disclose side effects, duplicate-name behavior, permission requirements, or what happens when the event is created. The examples add some context but not behavioral transparency.

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 parameter and behavioral detail.

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?

This is a mutation tool with no annotations, no output schema, and four undocumented parameters. The description says what is created and mentions common event names, but leaves too much unstated for reliable invocation. An agent would need to infer the meaning of rank, active, and description elsewhere.

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%, and the description explains only the event name conceptually through examples. It gives no guidance on rank, active, or description, so three of four parameters remain undocumented. The examples help with the required name field but do not compensate for the schema gap.

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 states a specific verb and resource: creating a VirtualPage event. It also gives common event names, which helps distinguish this from list/get/update/delete event siblings. It does not define what a VirtualPage event controls, but the create intent is clear.

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?

The description implies this tool is for creating a new event and gives typical event names, but it does not explain when to use it versus updating an existing event or creating a handler/route. There are no explicit exclusions or prerequisites.

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