inspect_variable

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

With no annotations, description fully owns disclosure. It specifies how different data types are handled (dataframes->CSV, figures->images, else repr), which is good transparency.

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?

Single sentence that efficiently conveys the core purpose and behavior. Could be broken into clearer sections, but no waste.

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?

Lacks parameter details and no output schema. However, it covers return behavior well. Adequate but not fully complete given the tool's complexity.

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 has 0% description coverage; description does not explain what 'path' and 'variable' mean, nor the timeout. It adds no semantic value beyond the parameter names and default.

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?

Clearly states it inspects a live kernel variable, listing specific attributes (type, shape, schema/columns, length, Jupyter repr). Distinct from all sibling tools which are cell or notebook operations.

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?

Mentions 'without adding a cell' implying lightweight inspection, but does not explicitly state when to use this tool versus alternatives or when not to use it.

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