notebook_get_outline

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

No annotations exist, so the description carries full burden for behavioral disclosure. It only states the output but does not confirm whether the operation is read-only, mention any side effects, or describe performance or authorization needs. The name implies a read operation, but the description does not explicitly state safety.

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 sentence of 11 words that directly states the tool's purpose. Every word is informative, and the key output elements are front-loaded. No fluff or redundancy.

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?

The description lists the outline components (cell numbers, headings, line counts) but does not specify the output format (e.g., text, JSON, structured list). With no output schema, the agent lacks complete information about what to expect, though the tool is simple enough that the description is minimally adequate.

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 100% for the single path parameter, and the description adds no additional meaning about the parameter. Baseline is appropriate since the schema already documents the parameter adequately.

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?

Description clearly states the tool produces an outline with cell numbers, headings/functions, and line counts. This is a specific verb ('produces') and resource ('outline of a notebook'), and it distinguishes the tool from siblings like notebook_read or notebook_get_info by specifying the unique output type.

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 guidance on when to use this tool versus alternatives. The description does not mention prerequisites, context, or scenarios where notebook_get_outline is preferred over other notebook-related tools. The agent is left to infer usage from the name alone.

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