rush_tui_diff

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions Rich CLI rendering and the return shape, but it does not disclose that this tool may run slow, trigger builds, open browsers, download resources, or write to caches/artifacts, as the numerous allow_* parameters imply. This is a significant transparency gap for a potentially side-effectful tool.

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 a single dense sentence with no filler, and it front-loads the primary action. It conveys the main purpose and output shape efficiently, though the brevity contributes to the lack of usage guidance and parameter semantics.

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 the tool's complexity—12 parameters, multiple behavior-affecting allow_* flags, and a rich sibling ecosystem—the description is too thin. It does not explain the meaning of 'options', the effect of each optional flag, or when this tool is preferred over other diff-related siblings, so an agent cannot reliably invoke it 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?

Schema description coverage is 0%, and the description only references <path>; it offers no explanation for 'options', 'base_ref', 'allow_slow', or any of the other ten parameters. Since the schema provides no descriptions, the tool description fails to compensate, leaving most parameters semantically opaque.

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 action ('Compute Git commit and quality findings deltas') and a resource ('at <path>'), which clearly identifies the tool's core purpose. It does not explicitly contrast against sibling diff-like tools such as rush_api_diff or rush_db_drift, but the wording is specific enough to avoid confusion.

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 alternatives, nor any statement of exclusions or prerequisites. The description does not mention whether this should be used for commit-level analysis, findings comparison, or both, leaving the agent to infer the appropriate context.

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