Retrieve a list of Bhyve VMs across a Sylve cluster or from a specific node. Use the detailed option to fetch full VM specifications including vCPUs, RAM, and autostart status.
List Bhyve VMs across the cluster.
| Name | Required | Description | Default |
|---|---|---|---|
| node | No | Target cluster node hostname or UUID. Omit for cluster-wide. | |
| context | No | Named login context from ~/.config/sylve/config.yaml. | |
| detailed | No | Fetch full details (vCPUs, RAM, autostart). |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint and non-destructive, so the safety profile is covered. The description adds the cluster-wide scope, but says nothing about result shape, pagination, or whether omitting 'node' changes cost — modest added value beyond structured fields.
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 with no filler. It is efficient, though it borders on under-specification given the tool's alternatives.
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?
With three fully documented optional parameters and no output schema, the definition is minimally sufficient to invoke the tool. It lacks any hint of return content (what fields a listed VM carries) or how 'detailed' alters the payload's size, which an agent planning a workflow would want.
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 100%, and each parameter (node, context, detailed) is already documented, including the 'omit for cluster-wide' behavior. The description adds no parameter detail, so baseline 3 applies.
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?
Specific verb ('List') plus specific resource ('Bhyve VMs') and scope ('across the cluster'), so an agent knows exactly what it returns. It does not, however, distinguish itself from siblings like sylve_vm_show or sylve_jail_list, leaving the list-vs-detail decision to the agent.
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 explicit when-to-use or when-not-use guidance, and no mention of the obvious alternative sylve_vm_show for per-VM detail. The only usage signal is implied by the verb 'List'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.