Inspect SAP System

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds that the data is 'normalized' and mentions optional component metadata, which adds behavioral context. However, it does not describe error handling or return format, but the presence of an output schema reduces the burden.

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 of 13 words, front-loaded with the verb 'Read'. Every word is necessary and no redundancy exists.

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 the simple parameter set, comprehensive annotations, and the presence of an output schema, the description covers the key functionality. However, it could benefit from briefly mentioning that the tool is safe and idempotent, or how the normalization works.

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 compensate. The description hints that includeComponents controls optional software component metadata, but systemId is not explicitly explained (though its name is clear). The description adds marginal value beyond the schema for one of two parameters.

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 ('Read') and clearly identifies the resource ('SAP system') and the attributes retrieved (client, release, timezone, optional software components). It distinguishes from sibling tools like sap.system.list (which likely lists systems) by focusing on inspection of a single system's metadata.

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 implies usage for reading system metadata but provides no explicit guidance on when to use this tool versus alternatives such as sap.system.list or sap.repository.inspect. No when-not-to-use or exclusion criteria are given.

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