Compare ABAP Versions

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

Annotations already convey read-only, idempotent, non-destructive behavior, so the bar for additional transparency is lower. The description states the tool compares revisions but adds no detail on output structure, pagination, or filtering behavior. With no contradictions, a mid-range score is appropriate.

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 concise sentence with no filler, making it easy to parse. However, given the tool has 10 parameters and potentially detailed output, the brevity borders on under-specification. It earns a high conciseness score but not a perfect one.

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?

Despite having an output schema, the tool's complexity (10 parameters, 4 required) is not reflected in the description. There is no mention of what the comparison returns (diff, summary, etc.) or how to interpret the parameters. The description is far too sparse to provide complete operational context.

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% for 10 parameters. The description only implies the role of version1, version2, and source object, leaving six optional parameters (e.g., limit, lineCount, startIndex, maxVersions, objectType, startLine) entirely unexplained. The schema names provide some hints, but the description does not compensate for the lack of parameter documentation.

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 the verb 'Compare' and the resource 'historical source revisions', which directly distinguishes it from sibling tools like sap.version.history.list (list versions) and sap.version.history.read (read a single version). The purpose is specific and immediately understandable.

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?

Usage context is implied: the user would invoke this when they need to compare two historical source revisions. However, there is no explicit guidance on when to use this over alternatives, such as sap.repository.compare, or when not to use it. The description does not mislead but lacks explicit directional context.

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