vrm_get_diagnostics

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

Since no annotations are provided, the description must disclose all behavioral traits. It only states it gets diagnostic data but does not explain data scope (e.g., current vs. historical), authentication requirements, rate limits, or any side effects. The description is insufficient for safe agent invocation.

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 sentence that efficiently states the purpose with no unnecessary words. It is front-loaded and easy to parse, though it could be slightly more precise about the type of diagnostic data.

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?

Given no output schema and the complexity of the data (diagnostic readings with pagination), the description fails to explain the return format or what constitutes a diagnostic record. This leaves the agent uncertain about how to interpret results.

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 100% with each parameter having a clear description in the input schema. The tool description adds no additional meaning beyond what the schema already provides, meeting the baseline of 3.

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 clearly states the tool retrieves diagnostic data and technical readings, using a specific verb and resource. It is distinct from many sibling tools that target specific subsystems (e.g., battery, alarms), but does not explicitly differentiate itself, relying on the name 'diagnostics' to imply breadth.

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?

No guidance is provided on when to use this tool versus alternatives like vrm_get_alarms, vrm_get_battery_summary, or other diagnostic tools. The description lacks context on appropriate scenarios, prerequisites, or exclusions.

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