GetInterfaceVersionDiff

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

The description includes the '[read-only]' hint, signaling no side effects. However, it does not detail the output format (e.g., unified diff text) or specify behavioral constraints like required permissions or error handling. Given no annotations, additional information would improve transparency.

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 sentence that efficiently conveys purpose and parameter context. It is well-structured and front-loaded with the read-only hint, though it could include a brief note on output without losing conciseness.

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?

The description covers the main purpose and parameter sources but lacks details on return value format (unified diff), potential errors, or limitations. Given no output schema and low complexity, additional completeness would be beneficial but not critical.

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 coverage is 100%, and the description adds value by clarifying which parameter is the old/base (content_uri_from) and which is new/compare (content_uri_to), and that values come from GetInterfaceVersions. This context goes beyond the schema descriptions.

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 explicitly states the action ('Compute a unified diff'), the resource ('two ABAP interface versions'), and the source of parameters ('from GetInterfaceVersions entries'). It differentiates from sibling tools like GetClassVersionDiff by specifying the object type.

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?

The description indicates that content_uris should be taken from GetInterfaceVersions, providing clear context on prerequisites. It does not explicitly mention when not to use the tool or list alternatives, but the naming and sibling tools imply it is interface-specific.

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