GetDataElementVersions

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

With no annotations, the description carries full burden. It declares read-only, lists return fields, and notes that transport fields are present 'when available'—a valuable behavioral detail. However, it does not disclose authorization needs, rate limits, or pagination behavior. Overall, adequately transparent for a simple read tool.

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 that front-loads the critical info: read-only, purpose, and return fields. It is concise with no unnecessary words, earning its place with every detail.

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 compensates by listing return fields and linking to the source-fetching sibling. It does not mention pagination or default ordering, but for a simple list tool this is acceptable. The description is mostly complete for an AI to understand the output and integration with other tools.

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 the single parameter fully with a description. The tool description does not add any additional meaning or constraints beyond what the schema provides. Baseline score of 3 is appropriate as schema coverage is 100% and no extra info is needed.

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 lists SAP version history of an ABAP data element, specifies it is read-only, and enumerates the returned fields. It distinguishes itself from sibling tools like GetDataElementVersionSource and GetDataElementVersionDiff by mentioning the content_uri for source fetching and implying version history listing.

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 explicitly marks the tool as read-only and explains what it returns. It indirectly guides usage by mentioning GetDataElementVersionSource for fetching source, but does not explicitly state when to prefer this over other version tools or when not to use it. Still provides enough context for an AI to decide.

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