diff_profile_revision

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

The verb 'Show' indicates a non-mutating comparison, and the description identifies the two operands: a stored snapshot and the current document. With no annotations provided, the description carries the behavioral disclosure burden, but it leaves out details like error behavior or whether the revision must already exist.

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 one concise sentence with the action and comparison object front-loaded. Every word contributes to the meaning, with no filler, redundancy, or unnecessary detail.

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 one-parameter tool with an output schema, this is minimally sufficient: it names the two sides of the comparison and the resulting action. Still, it lacks usage guidance and explicit parameter semantics, so an agent must infer context from sibling tool names and the parameter name.

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 add meaning on its own. It partially does by implying that the required revision_id identifies the stored snapshot being compared to the current document. However, it never explicitly defines revision_id or explains how to acquire it.

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 uses a specific verb and object: 'Show what changed between a stored snapshot and the current document.' This clearly indicates a diff/comparison operation and is distinct from sibling tools that list or restore revisions, though it doesn't name those alternatives 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?

There is no explicit guidance about when to use this tool versus siblings like list_profile_revisions or restore_profile_revision. The intended use is only implied by the verb 'show', and no prerequisite steps, such as obtaining a revision_id from another tool, are mentioned.

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