vm_exec_sync

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

No annotations are provided, so the description must disclose behavioral traits. It states that the command returns the result directly and supports complex commands, but does not detail behavior on timeout, error handling, resource impact, or what happens if SSH connection fails. This leaves significant gaps for an agent.

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 two sentences long, directly addressing the core function and a key constraint (SSH requirement). It is concise and avoids fluff. However, it is in French, which may be a concern for multilingual agents.

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 the lack of annotations, output schema, and the tool's complexity (executing shell commands), the description is incomplete. It does not mention return format (e.g., exit code, stdout/stderr), error cases, or performance implications. More detail is needed for safe and correct usage.

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% for all 4 parameters, so the baseline is 3. The description adds value by explaining that the command parameter supports pipes and redirections, and that SSH is required (though not a parameter). This slightly enriches the parameter context but does not drastically improve understanding.

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 executes a shell command in a VM and returns the result directly. It specifies support for complex commands (pipes, arguments) and that SSH is required. However, it does not explicitly differentiate from siblings like vm_exec, vm_exec_status, or ssh_execute, which may have similar functions.

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 mentions 'Nécessite SSH' as a prerequisite, but offers no guidance on when to use this tool instead of alternatives such as vm_exec (likely asynchronous) or ssh_execute (which may not require VM IDs). No explicit when-to-use or when-not-to-use information is provided.

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