trw_before_edit_hint_batch

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

No annotations provided, so description carries full burden. It discloses return type (model_dump()), promises never raises, and mentions tier-gating. Does not mention mutations, but tool name suggests read-only operation. Minor gap: no mention of whether it relies on sidecar state or any prerequisites.

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?

Three sentences, each serving a distinct purpose: purpose, usage context, and constraints. No superfluous text, front-loaded with the core verb and resource.

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?

Output schema exists, so return format is covered. However, parameter semantics are missing, and the description assumes the agent knows about 'current SHA' and 'persisted trw-distill sidecar'. The description is adequate for an agent with context, but incomplete for a new one.

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 does not explain the two parameters (cache_dir, repo_root). The agent has no guidance on what values to provide, leaving the agent to guess or ignore the parameters. This significantly hinders correct invocation.

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 clearly states what the tool does: 'Return c735+c743 BeforeYouEditBatch for the current SHA.' It specifies the resource (batch hints) and distinguishes from the sibling tool trw_before_edit_hint by noting it's for multi-file edits and is paid-tier only.

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?

Explicit usage guidance: 'Use when an agent is planning a multi-file edit and needs batched before-edit hints.' Also provides alternative for free-tier users: 'see trw_before_edit_hint for the free-tier learnings counterpart.'

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