hostodo_get_vm

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It only says 'Get detailed metadata' without specifying what metadata includes, potential error states, authentication requirements, or side effects. For a read operation this is minimal but insufficient compared to a 5-point standard.

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?

Two concise sentences with no wasted words. The first sentence states the core purpose, and the second adds crucial parameter flexibility. Information is front-loaded and easy to parse.

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?

The description adequately covers the single parameter and core action, but for a tool with no output schema, it lacks any description of what 'detailed metadata' contains (e.g., IP, status, specs). The return value is left entirely implied, which may leave an agent unsure of the output structure.

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 single parameter vm_id is described as accepting 'id, hostname, or unique prefix', which adds significant meaning beyond the schema's bare string type. With 0% schema description coverage, the description compensates well by clarifying acceptable input formats.

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 action ('Get detailed metadata'), the resource ('one owned Hostodo VPS'), and scope (single VM). It distinguishes from sibling tools like hostodo_list_vms (list all VMs) and hostodo_check_vm_health (health check) by focusing on detailed metadata. The mention of flexible references (id, hostname, unique prefix) adds precision.

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?

The description provides guidance on what to pass as vm_id (id, hostname, unique prefix) but does not explicitly state when to use this tool over alternatives (e.g., list_vms for a list, check_vm_health for health status). No when-not-to-use or exclusion criteria are given.

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