modx_virtualpage_resolve_route

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

With no annotations supplied, the description carries the full behavioral burden. 'Simulate' usefully implies a non-persisting dry run, but it does not state what happens when no route matches, whether the resolution cache is consulted, or whether it requires an authenticated context — all material for a resolution tool.

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?

A single front-loaded sentence, verb and resource first, output second. No filler and nothing buried.

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?

No output schema, no annotations, three undocumented parameters, and a return value sketched in only a clause. For a resolution/simulation tool whose whole value is explaining why a route matches, this leaves an agent guessing about inputs and no-match 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?

Schema coverage is 0% for three parameters, so the description must compensate and it does not: it never mentions uri, path, or method. The distinction between 'uri' and 'path' is genuinely ambiguous and is left entirely unresolved, as is whether 'method' means an HTTP verb and what the default is given zero required parameters.

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?

Names a specific verb-and-resource pair ('Simulate VirtualPage route matching') plus what it returns ('handler plus vp.* placeholders'). The word 'Simulate' distinguishes it from the mutating/CRUD siblings like modx_virtualpage_get_route and modx_virtualpage_create_route, though it never names those siblings explicitly.

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 explicit statement of when to call this versus modx_virtualpage_get_route (fetch a stored route) or modx_virtualpage_list_routes (enumerate). The debugging intent is only implied by the word 'Simulate', and there are no exclusions or prerequisites.

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