Compare ABAP Across Systems

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

Annotations already provide readOnlyHint, openWorldHint, idempotentHint, and destructiveHint as false, indicating a safe, non-destructive operation. The description adds behavioral context beyond annotations by specifying 'same active' (only active versions) and 'bounded unified diff' (suggests output limits). This is valuable extra transparency, though it omits further details like exact output format.

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 14-word sentence, front-loaded with the core action. No redundant phrases; every word contributes to the meaning. Exceptional 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?

Given 6 parameters, no output schema, and a straightforward comparison task, the description provides the essential use case but lacks details about the return format, what 'bounded' means (max lines?), and whether parameters like objectType are optional. Annotations cover safety but not functional completeness. It leaves moderate gaps for a tool of this complexity.

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?

The input schema has 6 parameters with 0% description coverage. The description only indirectly mentions 'same active ABAP object' (implying objectName) and 'two configured SAP systems' (implying sourceConnectionId and targetConnectionId). It fails to explain objectType, maxPatchLines, ignoreWhitespace, or their roles. With no schema descriptions, the description should compensate but does not.

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 tool compares the same active ABAP object across two configured SAP systems using a bounded unified diff. It is specific about the verb (compare), resource (ABAP object), and scope (between two systems), and it distinguishes from sibling tools that deal with activation, debugging, or single-system operations.

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?

No explicit guidance on when to use this tool versus alternatives. The description implies it is for comparing objects across systems, but does not mention when not to use it, prerequisites (e.g., systems must be pre-configured), or how it differs from other comparison-adjacent siblings like get_abap_object_info. Usage context is implied, not explicit.

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