onelake_delete_shortcut

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

With no annotations provided, the description carries the behavioral burden. It does disclose the return shape ('Dictionary with success status') and the workspace fallback ('uses context if not provided'), but it does not cover side effects such as irreversibility, whether the underlying data remains untouched, or failure behavior when the shortcut does not exist.

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 purpose is front-loaded, followed by a compact Args list and a single example. Each line earns its place, with no filler or unnecessary repetition.

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 simple four-parameter delete operation, the description provides enough to invoke the tool correctly: all parameter meanings, optional workspace fallback, return value, and an example. It stops short of warning about side effects and edge cases, but the core calling context is complete.

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 0%, and the description fully compensates by explaining every relevant parameter: lakehouse name/ID, shortcut_path with examples, shortcut name, and optional workspace behavior. The example further clarifies how the parameters are used together.

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 opening sentence uses a specific verb and resource: 'Delete a OneLake shortcut from a lakehouse.' This clearly identifies the operation and distinguishes it from sibling tools like onelake_create_shortcut and onelake_list_shortcuts.

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 is given on when to use this tool versus alternatives. It does not mention exclusions or compare with onelake_rm, onelake_create_shortcut, or onelake_list_shortcuts. The only usage context is the one-line purpose and an example.

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