modx_virtualpage_list_events

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

No annotations are provided, so the description carries the full behavioral burden. It implies a read-only listing operation and explains the event relationship, but it does not disclose pagination behavior, filtering semantics, permissions, ordering, or what data is returned. For a six-parameter list tool with no annotations, this is a notable gap.

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

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

The description is a single efficient sentence with no wasted wording. It is front-loaded with the verb and resource. However, its brevity contributes to under-specification elsewhere, though the sentence structure itself is clean.

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

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

For a list tool with six filter/pagination parameters, no schema descriptions, no annotations, and no output schema, the description is too thin. It explains what the resource is but not how to filter, paginate, or interpret results. An agent would need to inspect the schema and guess parameter behavior.

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

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

The input schema has six parameters with 0% description coverage, and the description mentions none of them. Parameters such as id, name, limit, start, active, and include_routes are left entirely undocumented. The description adds no meaning beyond the bare schema property names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

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 events,' and adds that these events bind route groups to MODX events. This distinguishes it from sibling tools such as modx_virtualpage_list_routes and modx_virtualpage_list_handlers. It does not explicitly mention the get_event sibling, but the purpose is still clear.

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

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

There is no guidance on when to use this tool versus alternatives like modx_virtualpage_get_event or modx_virtualpage_list_routes. The description only implies that it is for listing events. It does not state prerequisites, exclusions, or whether it is intended for browsing versus lookup.

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