syntaxCheckCdsUrl

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the note about the DDL source URL being the main URL, which is more of a parameter usage detail than a behavioral trait. No additional side effects or behavioral nuances are disclosed beyond what annotations provide, so a baseline 3 is appropriate.

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?

Two sentences with zero waste. The core purpose is front-loaded, and the alternative is mentioned concisely at the end. Every word earns its place.

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?

The tool is simple with one parameter and no output schema. Annotations cover the safety profile. The description covers the key distinction from ABAP and directs to the right sibling. It does not describe the return value or error behavior, but for a syntax check that is typically implied. Overall sufficient for an agent to call it correctly.

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 schema has zero description coverage for the single parameter 'cdsUrl'. The description compensates by explaining that the DDL source URL goes in as the main URL, giving meaning and usage context that the schema lacks. This is helpful, though it does not specify the exact URL format or encoding requirements, so not a 5.

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 the tool performs a syntax check for a CDS object, with a specific verb and resource. Differentiates from the ABAP variant by noting the different URL addressing and explicitly pointing to syntaxCheckCode as the alternative.

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?

Explicitly instructs to use syntaxCheckCode for ordinary ABAP, providing a clear when-not scenario and an alternative tool. This leaves no ambiguity about when to select this tool over its siblings.

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