run_notebook

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

No annotations are provided, so the description carries the full burden. It discloses the licensing requirement and states that diagnostics (errors, warnings, timings) are returned. However, it does not mention that the tool can modify the notebook file when 'save' is true (a side effect), nor does it describe the execution environment or non-interactivity beyond 'headlessly'. Some behavioral context is given, but significant gaps remain.

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 that efficiently states the purpose, method, and return values. There is no redundancy or filler; every phrase earns its place.

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?

This is a complex execution tool with 5 parameters, no output schema, and no annotations. The description is sparse: it names the return values and the licence but omits when-to-use guidance, side-effect warnings, and parameter context (especially for the required 'notebook'). An agent would need additional inference to select and call it correctly, making it incomplete.

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 60% (save, inputsJson, outputJson have descriptions; notebook and timeoutMs do not). The tool description adds no parameter details, failing to compensate for the undocumented required parameter 'notebook' or 'timeoutMs'. It only references the licence, not how parameters should be used, so it adds no value beyond the schema.

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 states a specific verb ('Execute'), a concrete resource ('notebook'), a method ('headlessly through nTop Automate (ntopcl)'), and explicitly names the return artifacts ('errors, warnings and per-block timings'). This clearly distinguishes it from sibling tools like inspect_notebook or validate_graph, which are about inspection/validation rather than execution.

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?

There is no guidance on when to use this tool versus the sibling tools. It does not mention alternatives, exclusions, or prerequisites beyond the licence note. The description implies a use case (execute a notebook) but does not help an agent decide between this and related tools like validate_graph or inspect_notebook.

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