GetStructureVersionDiff

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

Marked as [read-only], which is appropriate. No annotations provided, so description carries burden. It does not disclose auth needs, rate limits, or any side effects beyond read-only nature. Acceptable but minimal.

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 [read-only] tag. Every word earns its place. Front-loaded with key info.

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?

Simple tool with 2 params, no output schema. Description conveys essential info. Could mention output format (unified diff) but not critical given common understanding.

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?

Both parameters have clear descriptions in schema, and description adds context about being from GetStructureVersions entries. 100% schema coverage plus extra context. Description adds value beyond schema.

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 'Compute' and resource 'unified diff between two ABAP structure versions', with clear input sources ('content_uris taken from GetStructureVersions entries'). It distinguishes from sibling tools like GetStructureVersions.

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 when-to-use or when-not-to-use guidance. The description mentions input source (GetStructureVersions), but does not compare with sibling diff tools or provide alternatives. Adequate but lacks formal guidelines.

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