list_logs

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

No annotations exist, so description carries full burden. It discloses SSH connection and listing of files with metadata, implying read-only. However, doesn't explicitly state no side effects or mention permissions, but sufficient for a listing tool.

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?

Description is front-loaded with main purpose, followed by oneliner usage guidance, then parameter list. No extraneous text, every sentence adds value.

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, but description mentions output includes size, last-modified time, and rough category. Lacks explicit format details, but adequate for understanding. Could mention error handling or timeouts, but not critical for listing.

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 has 0% description coverage, but description provides detailed explanations for all 5 parameters, adding meaning about hostname, SSH user, key path, deployment directory, and application subfolder.

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 enumerates files under a specific logs directory with metadata. It distinguishes from sibling analyze_logs by advising to call this first and pass paths, showing specific verb and resource.

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?

Explicitly says 'Call this first, then pass the relevant paths as log_files to analyze_logs - avoids blindly grepping every file'. Provides clear sequencing and rationale for use vs. alternative.

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