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. The description adds no additional behavioral context, such as what happens if the object is missing in one system or how results are returned. Given annotations cover safety, a score of 2 is appropriate for lack of added value.

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, which is concise, but it lacks essential details. Every sentence should earn its place; this one is too generic and does not provide useful information beyond the tool name.

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 rich annotations and an output schema (not provided), the description is severely incomplete. It does not explain the comparison result format, behavior for unmatched objects, or parameter roles. With 6 parameters and 0% schema coverage, more depth is required.

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 0% (no descriptions in schema). The description does not explain any of the 6 parameters (objectName, objectType, maxPatchLines, sourceSystemId, targetSystemId, ignoreWhitespace). It fails to compensate for the lack of 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 clearly states the action (compare) and the resource (active object across two configured SAP systems). It distinguishes from sibling tools like 'sap.transport.compare' and 'sap.repository.inspect' by specifying 'active object' and 'across two systems'. However, the term 'active' could be more precisely defined.

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 guidance on when to use this tool versus alternatives (e.g., 'sap.repository.inspect' for single system, 'sap.transport.compare' for transports). No prerequisites or context provided.

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