ssh_exec

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

With no annotations, the description carries the transparency burden. It clearly states that the command executes via SSH, returns exit status/stdout/stderr, and is bounded by timeout_sec. However, it does not disclose that arbitrary commands can modify or destroy remote system state, nor does it mention authentication or connection prerequisites.

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 a single effective purpose sentence followed by a compact Args list with useful examples. It is front-loaded, contains no filler, and every line earns its place.

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 core execution contract is documented and an output schema exists. However, it is unclear whether ssh_exec opens its own SSH connection or requires one from ssh_connect, and there is no mention of remote-host prerequisites or safety caveats. These gaps leave agent decision-making incomplete.

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%, and the description compensates fully by explaining each parameter's meaning and giving concrete examples for board_id and command, plus the semantics and default of timeout_sec. This adds substantial value beyond the plain input schema.

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 opens with a specific action: 'Execute a shell command on the remote host via SSH' and explicitly names the return payload: 'exit status, stdout, and stderr'. This clearly distinguishes it from siblings like ssh_connect, ssh_tail, and ssh_status, which have different purposes.

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 intended use is implied by the purpose: run an arbitrary shell command and capture its output. However, the description gives no explicit when-to-use or when-not-to-use guidance, does not mention alternatives like ssh_connect or ssh_tail, and does not state whether an existing SSH connection is required.

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