pve_get_vnc_ticket

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

With no annotations, the description carries the full burden. It does disclose the useful behavioral trait that the ticket is time-limited and that it enables out-of-band console access, but it omits the ticket lifetime, the permission requirements, and the security implication that the returned URL grants console control. That leaves meaningful gaps for a credential-issuing 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?

The core purpose is front-loaded in a single dense sentence, and the Args block is compact. The Args block partially repeats schema property names, but given 0% schema description coverage it earns its place rather than being waste.

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?

An output schema exists, so return values need no explanation, and the tool is a simple two-parameter read-style operation. What is missing is prerequisite and permission context — whether the guest must be running and what access is needed to mint a console ticket.

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 description coverage is 0%, so the description must compensate, and it does: vmid is explained as a target VM or LXC Container ID (clarifying that both guest types are accepted) and node as an optional node name. It adds real meaning beyond the bare 'Vmid'/'Node' schema titles, though it does not say when the optional node argument is required.

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?

States a precise verb and resource: generating a time-limited NoVNC console ticket and URL, with the qualifier that it is for browser-based out-of-band management. That is enough to tell it apart from every listed sibling, none of which deals with console access, though the description never explicitly contrasts itself with pve_exec_guest_command or other guest-access paths.

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?

Usage is only implied by 'browser-based out-of-band management' — an agent can infer this is for interactive console access, but there is no explicit when-to-use, no when-not-to-use, and no named alternative. No prerequisites such as the guest needing to be running are mentioned.

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