get_history_diff

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so safety is covered. The description adds meaningful behavioral context beyond that: the returned payload differs by mode (file content differences with path, file-tree differences without). It does not describe output shape or size limits, but with annotations carrying the safety profile this is solid.

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 short sentences, zero filler, with the core action front-loaded and the mode distinction immediately after. Every sentence adds information the agent needs.

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 read-only comparison tool with no output schema, the description covers the action, the two modes, and the input source. It leaves the shape and granularity of the returned diff implicit, which is a minor gap rather than a blocker.

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 carries the burden, and it does explain the most ambiguous parameter: path is optional and switching it changes what kind of diff is returned. 'Versions returned by list_history' also implies what from/to accept. projectId is left unstated, but its meaning is self-evident from the name and pattern.

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 and resource ('Compare two project-history versions') and further splits the behavior into two modes based on the optional path argument. It points at list_history as the source of inputs, which separates it from the file-reading siblings, though it never explicitly contrasts itself with read_file or download_file.

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?

'Use versions returned by list_history' gives a concrete prerequisite and the correct upstream tool. The with-path/without-path sentence tells the agent which mode to expect, but there is no explicit when-not guidance or statement about comparing versions across different projects.

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