opspilot_list_log_files

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

With no annotations provided, the description carries the full burden of behavioral disclosure, yet it only states that the tool lists files. It does not mention whether the operation is read-only, what output format to expect, whether recursion occurs, or any permissions or side effects.

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 just two short sentences with the core action front-loaded. Every word earns its place, and there is no redundancy or filler.

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?

Given the lack of annotations, output schema, and parameter descriptions, the tool is under-specified. The description covers the purpose but leaves out critical invocation details such as the role of host_alias, acceptable path formats, and what a successful response looks like.

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 no descriptions for the parameters, and the description does not explain the meaning of host_alias or path. The phrase 'Catalog log_paths are directories' hints that path should be a directory but does not directly map to the schema parameters.

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 uses a specific verb 'list' and identifies the resource as 'files under a catalog log root directory,' which distinguishes it from sibling tools like fetch_logs and read_file. However, the term 'catalog log root directory' is not fully defined, so precision is slightly limited.

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 instruction 'list before fetching' provides clear contextual usage, indicating this tool should be used as a precursor to fetching logs. It does not explicitly name alternative tools or state exclusions, but the workflow hint is useful.

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