Submit notebook job

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

Annotations declare readOnlyHint=false, destructiveHint=false, openWorldHint=true, covering the basic safety profile. The description adds that execution is headless via nbconvert, which is useful behavioral context, but omits the critical fact that dryRun defaults to true so the tool builds/validates rather than submits unless confirm is also set.

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 front-loaded sentence with no filler and no redundant restatement of the tool name. It is efficient, though its brevity is achieved partly by omitting information the agent needs.

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 17-parameter submission tool with 35% schema coverage, no output schema, and no annotation detail on the submit gate, one sentence is far too thin. It does not explain the dry-run default, resource/partition semantics, or what the job returns.

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 only 35% across 17 parameters, so the schema does not carry the load. The description names no parameters (cpus, memGb, partition, gpuCount, walltime, modules, account, etc.) and adds no format or defaulting guidance to compensate for the coverage gap.

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+resource ('Execute a project .ipynb headlessly ... as a batch job') and names the mechanism (nbconvert), which distinguishes it from ris_submit_python_job and ris_submit_jupyter_job. It does not explicitly name or contrast those siblings, so it falls short of a 5.

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 guidance, no prerequisites, and no mention of the dryRun/confirm two-phase pattern that governs whether a job actually goes out. The agent must open the schema to learn that the default call does not submit.

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