GetPackageVersionDiff

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

Labels tool as read-only, which is helpful. However, with no annotations, more details about output format, size limitations, or performance impact 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 efficiently conveys purpose, read-only flag, and data source. No redundancy or unnecessary details.

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 could specify the diff format (unified, list, etc.). It is adequate but leaves the output nature implied.

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 descriptions already explain each parameter well (old vs new). The description adds context that URIs are from GetPackageVersions entries, enhancing understanding beyond schema alone.

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?

Clearly states 'Compute a unified diff between two ABAP package versions', specifying verb, resource, and distinguishing from similar diff tools for other object types.

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?

Explains that content URIs come from GetPackageVersions, implying prerequisite step. Does not explicitly exclude wrong usage but provides sufficient context for correct invocation.

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