get_job_logs

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

No annotations are provided, so the description must fully disclose behaviors. It explains the basic effect of use_ssh but does not address important behavioral aspects like error handling, permissions, or behavior when logs are missing.

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 concise, starting with a clear purpose statement followed by a structured Args list. It is front-loaded and contains no superfluous 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?

While the description covers basic usage and parameter semantics, it lacks details on edge cases (e.g., missing logs, multiple output files) and does not reference the output schema. Given the tool's moderate complexity, completeness is adequate but not thorough.

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 input schema has 0% description coverage, and the description compensates by explaining each parameter's purpose (e.g., job_id is 'SLURM job ID', use_ssh: 'If true, fetch logs via SSH'). This adds meaningful context beyond the schema's titles and types.

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 'Get stdout/stderr logs for a SLURM job,' providing a specific verb and resource. It distinguishes itself from siblings like get_job_status and list_jobs by focusing on logs.

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 explicit guidance on when to use this tool versus alternatives. It mentions optional parameters (job_name, use_ssh) but does not compare to sibling tools such as get_job_status or list_jobs for log retrieval.

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