ReadDataElement

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

The description includes '[read-only]' hint indicating idempotent behavior, which is useful. However, with no annotations provided, the description carries the full burden. It does not detail permissions, side effects (none expected), rate limits, or return format. Additional context on what is guaranteed (e.g., no destructive actions) would improve transparency.

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?

Single sentence with clear structure: read-only tag, action, resource, and scope. No wasted words, front-loaded with essential information.

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 no output schema, the description lists the kind of metadata (package, responsible, description) but not explicit return fields. It is sufficient for a simple read operation, but could be more complete by specifying that output includes full definition details. However, the description is fairly complete given the tool's simplicity.

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 covers 100% of parameters with clear descriptions (data_element_name example, version enum with default). The description adds no extra parameter semantics beyond the schema, so baseline score of 3 is appropriate.

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?

Description clearly states the verb 'Read' and the resource 'ABAP data element definition and metadata', listing specific metadata categories (package, responsible, description). This distinguishes it from sibling Read* tools targeting different resources.

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 (e.g., ReadDomain, ReadTable). The read-only nature is implied, but there is no mention of prerequisites or exclusions. Usage is straightforward but could benefit from context on when to prefer this over other read tools.

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