ssh_execute_sudo

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

Comprehensively discloses mutation, destructiveness, password handling (piping to sudo -S, masking), timeout default (30000 ms), OS adaptation, and mode restrictions. No annotations exist, so description fully carries the burden.

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 paragraph, no unnecessary words. Could be more structured (e.g., bullet points) but remains efficient and readable.

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?

No output schema or annotations, yet description is thorough: covers input, behavior, side effects, restrictions. Complete for a utility tool.

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 covers all 5 parameters with descriptions. Description adds value by clarifying cwd defaults, timeout default, and password masking behavior, going beyond 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 clearly states the tool runs commands with elevated privileges via sudo, returning exit code and output. It distinguishes itself from sibling tools like ssh_execute by specifying sudo usage.

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?

Describes when to use (elevated commands), readonly/restricted mode behavior, but does not explicitly contrast with alternatives like ssh_execute. Provides good context without explicit exclusions.

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