Slurm Read Log

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

With no annotations, the description carries the full behavioral burden and discloses only one trait: the default read is the log tail. It is silent on the size of the "bounded chunk", the interpretation of offset, error behavior for unregistered/missing logs, and any permission requirements.

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 well-formed sentence with the key scoping facts front-loaded and no filler. It is efficient, though the terseness is arguably part of why the gaps elsewhere go unaddressed.

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 tool with no annotations and no output schema, the description is too thin. An agent cannot determine the bound size, offset units, stream options, or failure modes from it.

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 description coverage is 0%, so the description must compensate for three undocumented parameters, but it only faintly gestures at offset semantics ("bounded chunk", "tail"). The stream parameter and its stdout default are never mentioned, nor is what job_id must reference.

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?

States a specific verb and resource ("Read ... a registered job log") with scope qualifiers ("bounded chunk", "tail"). It is clearly distinguishable from adjacent Slurm tools like slurm_watch_job or slurm_get_job, though it never names a sibling or explicitly contrasts with them.

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?

No when-to-use, when-not-to-use, or alternative is given. The description implies it is for inspecting job log output, but nothing tells the agent how to choose this over slurm_watch_job or slurm_get_job.

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