GetDdlVersionDiff

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

Declares '[read-only]' but does not elaborate on behavioral traits beyond annotations (none provided). No disclosure of output format, permissions, or error conditions. With no output schema, description should provide more detail.

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 concise sentence with front-loaded behavioral hint. Every word earns its place; no redundancy.

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?

Tool is simple with only two string params and no output schema. Description covers purpose and parameter origin but lacks output format details and error handling. Incomplete for full contextual 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?

Adds value beyond schema by specifying that content_uris originate from GetDdlVersions entries. Schema coverage is 100%, so baseline 3; the extra context of opaque URIs and their source justifies a 4.

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 specifies verb ('Compute a unified diff'), resource ('CDS view (DDL source) versions'), and distinguishes from siblings like GetDdlVersions and GetDdlVersionSource. The '[read-only]' tag further clarifies its nature.

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?

Implies usage context by stating content_uris are taken from GetDdlVersions entries, but does not explicitly say when to use this tool versus alternatives (e.g., GetDdlVersionSource). No exclusions or prerequisites beyond the implied dependency.

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