diff_mod

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

Annotations already declare the safe read-only, idempotent, non-destructive profile, so the description's job is to add semantics. It does, disclosing the default comparison pair, the draft-vs-published behavior, and the modsStorage/draft location, which is useful beyond the annotations.

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?

Two tight sentences with the primary default behavior front-loaded and the draft variant following. No 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?

For a 6-parameter read-only tool with no output schema and zero schema coverage, the description covers the core comparison semantics but omits any meaning for 'kind' and 'context', leaving an agent guessing on two parameters.

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%, so the description must carry parameter meaning. It explains v1, v2 defaults and the draft flag, but leaves 'kind' (default lua) and 'context' completely unexplained, so it only partially compensates for the coverage gap.

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?

States a specific verb+resource: computes a unified diff between two cached versions of a mod, with default scope (previous vs latest) named. It implicitly differentiates from the sibling diff_game_versions by scoping to mods, though it never names that sibling explicitly.

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?

Gives clear context for the default mode (previous vs latest) and the alternate mode (draft=true compares published v1 against the developer-mode draft), including where the draft lives. It does not state when not to use it or point to diff_game_versions for non-mod diffs.

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