vm agent get vcpus

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

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds the context 'from inside the guest', implying agent usage, but does not disclose potential failure modes or limitations (e.g., agent not responding).

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?

Single sentence, no wasted words, conveys the core action and result clearly.

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, the description should elaborate on the returned data structure (e.g., fields like sockets, cores, threads, usage percentage). It omits details about data format and potential edge cases (e.g., guest agent not available).

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 has 0% description coverage, and the description provides no explanation of the 'node' and 'vmid' parameters. The tool name and description do not hint at their meaning, leaving the agent without semantic context beyond the parameter 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 clearly states it returns vCPU topology and usage from inside the guest, which is specific and distinguishes it from sibling tools like vm_agent_get_osinfo or vm_agent_exec.

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 on when to use this tool versus alternatives (e.g., vm_agent_get_fsinfo, vm_agent_get_hostname). The description does not mention prerequisites like the guest agent being installed or running.

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