get_top_logs

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

With no annotations, the description must carry behavioral context on its own. It does disclose the tail semantics ('maximum characters... taken from the end') and the work_item_index selection behavior, but it does not describe return format, failure behavior, or side effects. This is partial rather than full transparency.

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?

A single purpose sentence is followed by a compact Args block with no filler. Every line adds information; the two usage modes are front-loaded.

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?

For a 3-parameter read-style tool it covers invocation well, but with no annotations and no output schema it leaves out return content and error conditions. It also does not signal how it relates to sibling TOP/work-item tools, so the agent must infer context.

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 0%, so the description fully compensates by explaining node_path, work_item_index, and tail, including the 'omit for node's own errors/warnings' behavior. This adds real meaning beyond the bare property titles.

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 first sentence identifies a specific resource ('logs for a TOP node') and an alternative mode ('scheduler log of one work item'), distinguishing node-level errors/warnings from per-work-item logs. It does not explicitly name a sibling tool, so it stops short of full sibling differentiation.

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 arg note 'work_item_index: Work item index; omit for the node's own errors and warnings' gives concrete when-to-use guidance: omit for node logs, include for work item scheduler logs. It does not name alternative tools or state when not to use this tool.

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