Read VPS File

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. The description adds behavioral context: the instance parameter includes a warning about silent mismatched routing, and the reveal parameter notes that the call is audited. This goes beyond what annotations provide.

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 main description is two succinct sentences, front-loading the core purpose. Parameter descriptions are concise yet informative, with no wasted words. Every sentence adds essential information.

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 description and parameters cover the main aspects: what the tool does, file path, reveal behavior with auditing, instance selection with important warnings. No output schema exists, so return values aren't expected. It could mention file size limits or error handling, but overall it's sufficiently complete for a read operation.

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 coverage is 100%, so baseline is 3. The description adds value beyond schema: for 'instance', it explains the default and warns about silent wrong-host behavior; for 'reveal', it adds auditing nuance. The 'path' parameter gets no extra context, but overall the description enriches 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 'Read the contents of a file on the selected VPS' with a specific verb and resource. It distinguishes between prod and dev instances, differentiating it from sibling tools like vps_write_file or vps_exec.

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 provides guidance on when to use each instance: 'Targets Hetzner prod by default; pass instance='dev' for the OrbStack ubuntu machine.' It does not explicitly exclude alternatives, but the context makes it clear this is the appropriate tool for reading file contents.

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