opspilot_fetch_logs

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

With no annotations, the description carries the transparency burden. It discloses the safe truncation behavior and the directory restriction, but does not mention return format, error handling, or required authentication. Some useful behavioral context is present, but much is left undeclared.

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, front-loads the core purpose, and includes a critical usage warning without any redundant filler. Every sentence provides actionable 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 tool has four parameters, no output schema, and no annotations. The description is too sparse to fully guide an agent on parameter semantics, expected output, or edge cases beyond the directory restriction. It is not complete enough for reliable invocation.

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?

The schema has 0% description coverage, and the description does not explain the individual parameters host_alias, path, service, or max_bytes. The phrase 'safe truncation' hints at max_bytes, but no parameter is explicitly mapped or clarified, leaving the agent to infer semantics from names alone.

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's function: fetching a concrete log file under a catalog log root with safe truncation. It explicitly warns against passing a directory, which distinguishes it from directory-level operations and aligns with the sibling tool opspilot_list_log_files.

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 clear usage guidance: do not pass a directory, and list files first. This implies the appropriate workflow of using a listing tool before fetching, though it does not explicitly name the alternative tool.

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