reorder_visible_columns

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals that changes are staged until apply_annotations() is called, warns that unmentioned columns are removed when using column names, and describes the return value. The examples also demonstrate both index-based and name-based behavior.

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 description is well-structured and front-loaded, with a one-sentence purpose statement followed by Args, Returns, and Examples. Every sentence adds value, including the important warning about unmentioned columns, and there is no redundant filler.

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?

Given no annotations, three required parameters, and a complex new_order type, the description is comprehensive. It covers purpose, parameter semantics, return shape, staging behavior, and edge-case removal, giving an agent everything needed to invoke the tool correctly.

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?

The input schema has no parameter descriptions and a complex anyOf for new_order. The description compensates fully: it defines each parameter, details the two accepted forms of new_order with examples, and adds the critical constraint that all columns must be included when using column names.

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 opens with a clear verb-object: 'Reorder columns in the visible-columns list for a specific context.' It also frames itself as a convenience tool for reordering without reconstructing the list, which distinguishes it from alternatives like set_visible_columns.

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?

The description explicitly scopes the tool to reordering columns and says it is a convenience tool to avoid manually reconstructing the list, implying set_visible_columns as the alternative. It also provides important context about changes being staged until apply_annotations() is called, but it does not name alternatives explicitly or state 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.