Read Structured ABAP Dictionary Object

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

The annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds behavioral value by revealing that the payload is two disjoint kinds ('properties' vs 'DDL source') and introduces an 'optimistic fingerprint' trait that is not visible in annotations. The exact meaning of 'optimistic' is left somewhat ambiguous, hence 4 rather than 5.

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, efficient sentence that leads with the action and resource, then clarifies the payload types. There is no redundant metadata or repetition of the already-clear input schema.

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 strong annotations, explicit kind semantics, and the presence of an output schema, the description provides enough information for an agent to choose and execute the tool successfully. The only missing niceties are a definition of 'optimistic fingerprint' and an explicit note that systemId identifies the SAP system, neither of which blocks correct invocation.

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 no descriptions and the description does not directly define the parameters. It contributes some semantic meaning by implying that 'kind' determines whether the user gets properties or DDL source, and the enum values are self-explanatory. However, 'systemId' and 'name' are not explained at all, leaving a meaningful gap beyond what the schema provides.

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 names a specific action ('read'), a specific resource (ABAP Dictionary objects), and enumerates exactly what is returned for each kind: Domain/Data Element properties or Table/Structure DDL source. It is specific enough to distinguish from generic source readers, though it does not explicitly name an alternative sibling.

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 gives clear context for when this tool applies: reading DDIC object definitions without modification. It does not mention sibling alternatives or specify conditions such as 'use sap.source.read for normal source code', so it stops short of providing explicit routing, but the scope is clear and there are no misleading exclusions.

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